olb::CosinusComposite< T, S > Class Template Reference

CosinusComposite: Composition of two Cosinus to shift the low point within a period - difference denotes the share of the period in which the low point is located. Calculated with case discrimination (xperiod < d or d <= xperiod) More...

#include <analyticalF.h>

Inheritance diagram for olb::CosinusComposite< T, S >:

Collaboration diagram for olb::CosinusComposite< T, S >:

Public Member Functions
	CosinusComposite (T period=1, T amplitude=1, T difference=1)
bool	operator() (T output[], const S x[]) override
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::AnalyticalF< 1, T, S >
AnalyticalF< D, T, S > &	operator- (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator+ (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator* (AnalyticalF< D, T, S > &rhs)
AnalyticalF< D, T, S > &	operator/ (AnalyticalF< D, T, S > &rhs)
Public Member Functions inherited from olb::GenericF< T, S >
virtual	~GenericF ()=default
int	getSourceDim () const
	read only access to member variable _m
int	getTargetDim () const
	read only access to member variable _n
std::string &	getName ()
	read and write access to name
std::string const &	getName () const
	read only access to name
bool	operator() (T output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (T output[], S input0)
bool	operator() (T output[], S input0, S input1)
bool	operator() (T output[], S input0, S input1, S input2)
bool	operator() (T output[], S input0, S input1, S input2, S input3)

Protected Attributes
T	_period
T	_difference
T	_amplitude

Additional Inherited Members
Public Types inherited from olb::AnalyticalF< 1, T, S >
using	identity_functor_type
Public Types inherited from olb::GenericF< T, S >
using	targetType = T
using	sourceType = S
Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > >	_ptrCalcC
	memory management, frees resouces (calcClass)
Static Public Attributes inherited from olb::AnalyticalF< 1, T, S >
static constexpr unsigned	dim
Protected Member Functions inherited from olb::AnalyticalF< 1, T, S >
	AnalyticalF (int n)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename S>
class olb::CosinusComposite< T, S >

CosinusComposite: Composition of two Cosinus to shift the low point within a period - difference denotes the share of the period in which the low point is located. Calculated with case discrimination (xperiod < d or d <= xperiod)

Definition at line 480 of file analyticalF.h.

Constructor & Destructor Documentation

CosinusComposite()

template<typename T , typename S >

olb::CosinusComposite< T, S >::CosinusComposite	(	T	period = 1,
		T	amplitude = 1,
		T	difference = 1 )

Definition at line 480 of file analyticalF.hh.

  : AnalyticalF1D<T,S>(1),
    _period(period),
    _difference(difference),
    _amplitude(amplitude)
{
  this->getName() = "CosinusComposite";
}

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename S >

bool olb::CosinusComposite< T, S >::operator() ( T output[], const S input[] )

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, S >.

Definition at line 490 of file analyticalF.hh.

{
  if ( util::fmod_pos(x[0],_period) <= (_difference * _period)) {
    output[0] = _amplitude
     * util::cos(((util::fmod_pos(x[0], _period))
                   / (_difference * _period)) * M_PI);
  }
  else {
    output[0] = _amplitude
     * util::cos(((util::fmod_pos(x[0], _period) - (_difference * _period))
                   / (_period - (_difference * _period))) * M_PI + M_PI);
  }
  return true;
}

References olb::util::cos(), olb::util::fmod_pos(), and M_PI.

Here is the call graph for this function:

Member Data Documentation

_amplitude

template<typename T , typename S >

T olb::CosinusComposite< T, S >::_amplitude

protected

Definition at line 484 of file analyticalF.h.

_difference

template<typename T , typename S >

T olb::CosinusComposite< T, S >::_difference

protected

Definition at line 483 of file analyticalF.h.

_period

template<typename T , typename S >

T olb::CosinusComposite< T, S >::_period

protected

Definition at line 482 of file analyticalF.h.

---

The documentation for this class was generated from the following files:

• src/functors/analytical/analyticalF.h
• src/functors/analytical/analyticalF.hh