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

#include <fringe2D.h>

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

Public Member Functions

 Fringe2D (AnalyticalF2D< T, S > &wantedVelocity, T start, T end, int direction, T lambdaMax=.005, T rise=.4, T fall=.2)
 
bool operator() (T output[6], const S input[2])
 Returns coefficients (a1, a2, B11, B12, B21, B22) for a linear velocity force modell where F = a + B*lattticeVelocity a = -scaleLambda*wanted, B = (scaleLambda 0 0 scaleLambda), so that F = scaleLambda*(latticeVelocity - wantedVelocity)
 
- 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
 
virtual bool operator() (T output[], const S input[])=0
 has to be implemented for 'every' derived class
 
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)
 

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<typename T, typename S>
class olb::Fringe2D< T, S >

Definition at line 91 of file fringe2D.h.

Constructor & Destructor Documentation

◆ Fringe2D()

template<typename T , typename S >
olb::Fringe2D< T, S >::Fringe2D ( AnalyticalF2D< T, S > & wantedVelocity,
T start,
T end,
int direction,
T lambdaMax = .005,
T rise = .4,
T fall = .2 )

Definition at line 35 of file fringe2D.hh.

36 : AnalyticalF2D<T,S>(6), _wantedVelocity(wantedVelocity), _start(start),
37 _end(end), _direction(direction), _lambdaMax(lambdaMax), _rise(rise),
38 _fall(fall)
39{
40 this->getName() = "fringe";
41}
std::string & getName()
read and write access to name
Definition genericF.hh:51

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::Fringe2D< T, S >::operator() ( T output[6],
const S input[2] )

Returns coefficients (a1, a2, B11, B12, B21, B22) for a linear velocity force modell where F = a + B*lattticeVelocity a = -scaleLambda*wanted, B = (scaleLambda 0 0 scaleLambda), so that F = scaleLambda*(latticeVelocity - wantedVelocity)

Definition at line 44 of file fringe2D.hh.

45{
46 output[3] = T();
47 output[4] = T();
48 if ( _wantedVelocity(output, input) ) {
49 T scaleLambda = lambda(input[_direction]);
50 output[0] = -scaleLambda*output[0];
51 output[1] = -scaleLambda*output[1];
52 output[2] = scaleLambda;
53 output[5] = scaleLambda;
54 return true;
55 }
56 else {
57 output[0] = T();
58 output[1] = T();
59 output[2] = T();
60 output[5] = T();
61 return false;
62 }
63}

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