OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD > Class Template Referencefinal

BlockLatticeExternalScalarField2D returns pointwise density rho on local lattices. More...

#include <latticeExternalScalarField2D.h>

+ Inheritance diagram for olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD >:
+ Collaboration diagram for olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD >:

Public Member Functions

 BlockLatticeExternalScalarField2D (BlockLattice< T, DESCRIPTOR > &blockLattice)
 
bool operator() (T output[], const int input[]) override
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & getBlock ()
 Copy Constructor.
 
- Public Member Functions inherited from olb::BlockF2D< T >
virtual BlockStructureD< 2 > & getBlockStructure ()
 virtual destructor for defined behaviour
 
void setBlockStructure (BlockStructureD< 2 > *blockStructure)
 
BlockF2D< T > & operator- (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator+ (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator* (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator/ (BlockF2D< T > &rhs)
 
- Public Member Functions inherited from olb::GenericF< T, int >
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[], int input0)
 
bool operator() (T output[], int input0, int input1)
 
bool operator() (T output[], int input0, int input1, int input2)
 
bool operator() (T output[], int input0, int input1, int input2, int input3)
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< T, int >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Protected Member Functions inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
 BlockLatticeF2D (BlockLattice< T, DESCRIPTOR > &blockLattice, int targetDim)
 
- Protected Member Functions inherited from olb::BlockF2D< T >
 BlockF2D (BlockStructureD< 2 > &blockStructure, int targetDim)
 
 BlockF2D (int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::BlockLatticeF2D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & _blockLattice
 
- Protected Attributes inherited from olb::BlockF2D< T >
BlockStructureD< 2 > * _blockStructure
 

Detailed Description

template<typename T, typename DESCRIPTOR, typename FIELD>
class olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD >

BlockLatticeExternalScalarField2D returns pointwise density rho on local lattices.

Definition at line 49 of file latticeExternalScalarField2D.h.

Constructor & Destructor Documentation

◆ BlockLatticeExternalScalarField2D()

template<typename T , typename DESCRIPTOR , typename FIELD >
olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD >::BlockLatticeExternalScalarField2D ( BlockLattice< T, DESCRIPTOR > & blockLattice)

Definition at line 58 of file latticeExternalScalarField2D.hh.

60 : BlockLatticeF2D<T,DESCRIPTOR>(blockLattice,1)
61{
62 this->getName() = "externalScalarField";
63}
std::string & getName()
read and write access to name
Definition genericF.hh:51

References olb::GenericF< T, int >::getName().

+ Here is the call graph for this function:

Member Function Documentation

◆ operator()()

template<typename T , typename DESCRIPTOR , typename FIELD >
bool olb::BlockLatticeExternalScalarField2D< T, DESCRIPTOR, FIELD >::operator() ( T output[],
const int input[] )
overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 67 of file latticeExternalScalarField2D.hh.

68{
69 output[0] = static_cast<T>(this->_blockLattice.get( input[0], input[1] ).template getField<FIELD>());
70 return true;
71}
BlockLattice< T, DESCRIPTOR > & _blockLattice

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