OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
olb::AnalyticalSquareWave< D, T, S > Class Template Reference

Square wave with given period length, amplitude, difference (= length of positive time / length of period) More...

#include <analyticalF.h>

+ Inheritance diagram for olb::AnalyticalSquareWave< D, T, S >:
+ Collaboration diagram for olb::AnalyticalSquareWave< D, T, S >:

Public Member Functions

 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

_period
 
_amplitude
 
_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::AnalyticalSquareWave< D, T, S >

Square wave with given period length, amplitude, difference (= length of positive time / length of period)

Definition at line 226 of file analyticalF.h.

Constructor & Destructor Documentation

◆ AnalyticalSquareWave()

template<unsigned D, typename T , typename S >
olb::AnalyticalSquareWave< D, T, S >::AnalyticalSquareWave ( T period = 1,
T amplitude = 1,
T difference = 0.5 )

Definition at line 314 of file analyticalF.hh.

316 : AnalyticalF<D,T,S>(1), _period(period),
317 _amplitude(amplitude), _difference(difference)
318{ }

Member Function Documentation

◆ operator()()

template<unsigned D, typename T , typename S >
bool olb::AnalyticalSquareWave< 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 321 of file analyticalF.hh.

322{
323 if ( util::fmod_pos(x[0],_period) <= (_difference * _period)) {
324 output[0] = _amplitude;
325 }
326 else {
327 output[0] = - _amplitude;
328 }
329 return true;
330}
auto fmod_pos(T a, S b)
Variant of fmod (floating point modulo) that always returns positive values.
Definition calc.h:39

References olb::util::fmod_pos().

+ Here is the call graph for this function:

Member Data Documentation

◆ _amplitude

template<unsigned D, typename T , typename S >
T olb::AnalyticalSquareWave< D, T, S >::_amplitude
protected

Definition at line 232 of file analyticalF.h.

◆ _difference

template<unsigned D, typename T , typename S >
T olb::AnalyticalSquareWave< D, T, S >::_difference
protected

Definition at line 233 of file analyticalF.h.

◆ _period

template<unsigned D, typename T , typename S >
T olb::AnalyticalSquareWave< D, T, S >::_period
protected

Definition at line 231 of file analyticalF.h.


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