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

#include <fringe3D.h>

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

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

Public Member Functions
	Fringe3D (AnalyticalF3D< T, S > &wantedVelocity, T start, T end, int direction, T lambdaMax=.005, T rise=.4, T fall=.2)
bool	operator() (T output[12], const S input[3])
	Returns coefficients (a1, a2, a2, B11, B12, B13, B21, B22, B23, B31, B32, B33) for a linear velocity force modell where F = a + B*lattticeVelocity a = -scaleLambda*wanted, B = (scaleLambda 0 0 0 scaleLambda 0 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::Fringe3D< T, S >

Definition at line 90 of file fringe3D.h.

Constructor & Destructor Documentation

Fringe3D()

template<typename T , typename S >

olb::Fringe3D< T, S >::Fringe3D	(	AnalyticalF3D< T, S > &	wantedVelocity,
		T	start,
		T	end,
		int	direction,
		T	lambdaMax = .005,
		T	rise = .4,
		T	fall = .2 )

Definition at line 35 of file fringe3D.hh.

  : AnalyticalF3D<T,S>(12), _wantedVelocity(wantedVelocity), _start(start),
    _end(end), _direction(direction), _lambdaMax(lambdaMax), _rise(rise),
    _fall(fall)
{
  this->getName() = "fringe";
}

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::Fringe3D< T, S >::operator()	(	T	output[12],
		const S	input[3] )

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

Definition at line 44 of file fringe3D.hh.

{
 
  output[4] = T();
  output[5] = T();
  output[6] = T();
  output[8] = T();
  output[9] = T();
  output[10] = T();
  if ( _wantedVelocity(output, input) ) {
    T scaleLambda = lambda(input[_direction]);
    output[0] = -scaleLambda*output[0];
    output[1] = -scaleLambda*output[1];
    output[2] = -scaleLambda*output[2];
    output[3] = scaleLambda;
    output[7] = scaleLambda;
    output[11] = scaleLambda;
    return true;
  }
  else {
    output[0] = T();
    output[1] = T();
    output[2] = T();
    output[3] = T();
    output[7] = T();
    output[11] = T();
    return false;
  }
}

---

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

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