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

Block level functor for conversion of analytical to lattice functors. More...

#include <reductionF3D.h>

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

Public Member Functions

 BlockLatticeFfromAnalyticalF3D (AnalyticalF3D< T, T > &f, BlockLattice< T, DESCRIPTOR > &lattice, Cuboid3D< T > &cuboid)
 
bool operator() (T output[], const int input[]) override
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::BlockLatticeF3D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & getBlock ()
 Copy Constructor.
 
- Public Member Functions inherited from olb::BlockF3D< T >
 ~BlockF3D () override
 virtual destructor for defined behaviour
 
virtual BlockStructureD< 3 > & getBlockStructure () const
 
BlockF3D< T > & operator- (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator+ (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator* (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator/ (BlockF3D< 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)
 

Protected Attributes

AnalyticalF3D< T, T > & _f
 
Cuboid3D< T > & _cuboid
 
- Protected Attributes inherited from olb::BlockLatticeF3D< T, DESCRIPTOR >
BlockLattice< T, DESCRIPTOR > & _blockLattice
 
- Protected Attributes inherited from olb::BlockF3D< T >
BlockStructureD< 3 > & _blockStructure
 

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::BlockLatticeF3D< T, DESCRIPTOR >
 BlockLatticeF3D (BlockLattice< T, DESCRIPTOR > &blockLattice, int targetDim)
 
- Protected Member Functions inherited from olb::BlockF3D< T >
 BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 

Detailed Description

template<typename T, typename DESCRIPTOR>
class olb::BlockLatticeFfromAnalyticalF3D< T, DESCRIPTOR >

Block level functor for conversion of analytical to lattice functors.

Instances are contained in SuperLatticeFfromAnalyticalF3D::_blockF.

Definition at line 63 of file reductionF3D.h.

Constructor & Destructor Documentation

◆ BlockLatticeFfromAnalyticalF3D()

template<typename T , typename DESCRIPTOR >
olb::BlockLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::BlockLatticeFfromAnalyticalF3D ( AnalyticalF3D< T, T > & f,
BlockLattice< T, DESCRIPTOR > & lattice,
Cuboid3D< T > & cuboid )
Parameters
fAnalytical functor to be converted into a lattice functor
latticeBlock lattice structure required for BlockLatticeF3D construction
cuboidCuboid reference required for input parameter conversion

Definition at line 72 of file reductionF3D.hh.

76 : BlockLatticeF3D<T, DESCRIPTOR>(lattice, f.getTargetDim()),
77 _f(f),
78 _cuboid(cuboid)
79{
80 this->getName() = "blockFfromAnalyticalF(" + _f.getName() + ")";
81}
std::string & getName()
read and write access to name
Definition genericF.hh:51

References olb::BlockLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::_f, and olb::GenericF< T, int >::getName().

+ Here is the call graph for this function:

Member Function Documentation

◆ operator()()

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

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 84 of file reductionF3D.hh.

86{
87 T physR[3] = {};
88 _cuboid.getPhysR(physR,input);
89 return _f(output,physR);
90}

Member Data Documentation

◆ _cuboid

template<typename T , typename DESCRIPTOR >
Cuboid3D<T>& olb::BlockLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::_cuboid
protected

Definition at line 66 of file reductionF3D.h.

◆ _f

template<typename T , typename DESCRIPTOR >
AnalyticalF3D<T,T>& olb::BlockLatticeFfromAnalyticalF3D< T, DESCRIPTOR >::_f
protected

Definition at line 65 of file reductionF3D.h.


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