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

#include <interactionPotential.h>

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

Public Member Functions

 ShanChen94 (T rhoZero=200., T psiZero=4.)
 
bool operator() (T psi[], const S rho[]) 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)
 

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::ShanChen94< T, S >

Definition at line 238 of file interactionPotential.h.

Constructor & Destructor Documentation

◆ ShanChen94()

template<typename T , typename S >
olb::ShanChen94< T, S >::ShanChen94 ( T rhoZero = 200.,
T psiZero = 4. )

Definition at line 50 of file interactionPotential.hh.

50 : AnalyticalF<1,T,S>(1), _rhoZero(rhoZero), _psiZero(psiZero)
51{
52 this->getName() = "ShanChen94";
53}
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::ShanChen94< 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 56 of file interactionPotential.hh.

57{
58 psi[0]=_psiZero*util::exp(-_rhoZero/rho[0]);
59 return true;
60}
ADf< T, DIM > exp(const ADf< T, DIM > &a)
Definition aDiff.h:455

References olb::util::exp().

+ Here is the call graph for this function:

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