olb::AnalyticalSmoothedSquareWave< D, T, S > Class Template Reference

Smoothed square wave. epsilon = width of the mollified interval. More...

#include <analyticalF.h>

Inheritance diagram for olb::AnalyticalSmoothedSquareWave< D, T, S >:

Collaboration diagram for olb::AnalyticalSmoothedSquareWave< D, T, S >:

Public Member Functions
	AnalyticalSmoothedSquareWave (T period=1, T amplitude=1, T difference=0.5, T epsilon=1.e-3)
bool	operator() (T output[], const S x[]) override
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::AnalyticalSquareWave< D, T, S >
	AnalyticalSquareWave (T period=1, T amplitude=1, T difference=0.5)
bool	operator() (T output[], const S x[]) override
	has to be implemented for 'every' derived class
Public Member Functions inherited from olb::AnalyticalF< D, 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	_epsilon
Protected Attributes inherited from olb::AnalyticalSquareWave< D, T, S >
T	_period
T	_amplitude
T	_difference

Additional Inherited Members
Public Types inherited from olb::AnalyticalF< D, T, S >
using	identity_functor_type = AnalyticalIdentity<D,T,S>
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< D, T, S >
static constexpr unsigned	dim = D
Protected Member Functions inherited from olb::AnalyticalF< D, T, S >
	AnalyticalF (int n)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<unsigned D, typename T, typename S>
class olb::AnalyticalSmoothedSquareWave< D, T, S >

Smoothed square wave. epsilon = width of the mollified interval.

Definition at line 239 of file analyticalF.h.

Constructor & Destructor Documentation

AnalyticalSmoothedSquareWave()

template<unsigned D, typename T , typename S >

olb::AnalyticalSmoothedSquareWave< D, T, S >::AnalyticalSmoothedSquareWave	(	T	period = 1,
		T	amplitude = 1,
		T	difference = 0.5,
		T	epsilon = 1.e-3 )

Definition at line 334 of file analyticalF.hh.

  : AnalyticalSquareWave<D,T,S>(period, amplitude, difference),
    _epsilon(epsilon)
{
  OLB_ASSERT(epsilon < difference, "Smoothing region is to large for given phase difference");
}

References OLB_ASSERT.

Member Function Documentation

operator()()

template<unsigned D, typename T , typename S >

bool olb::AnalyticalSmoothedSquareWave< D, 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 343 of file analyticalF.hh.

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

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

Here is the call graph for this function:

Member Data Documentation

_epsilon

template<unsigned D, typename T , typename S >

T olb::AnalyticalSmoothedSquareWave< D, T, S >::_epsilon

protected

Definition at line 244 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