OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
olb::EntityF< T, D, ENTITY > Class Template Reference

#include <entityF.h>

+ Inheritance diagram for olb::EntityF< T, D, ENTITY >:
+ Collaboration diagram for olb::EntityF< T, D, ENTITY >:

Public Member Functions

 ~EntityF () override
 virtual destructor for defined behaviour
 
auto getExtent ()
 get extent
 
ENTITY & getEntityF ()
 expose entity reference
 
- 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
 
virtual bool operator() (T output[], const int 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[], 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)
 

Static Public Attributes

static constexpr int d = D
 
static constexpr bool isSuper = false
 

Protected Member Functions

 EntityF (int targetDim, int sourceDim, ENTITY &entity)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 

Protected Attributes

ENTITY & _entity
 

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)
 

Detailed Description

template<typename T, unsigned D, typename ENTITY>
class olb::EntityF< T, D, ENTITY >

Definition at line 35 of file entityF.h.

Constructor & Destructor Documentation

◆ EntityF()

template<typename T , unsigned D, typename ENTITY >
olb::EntityF< T, D, ENTITY >::EntityF ( int targetDim,
int sourceDim,
ENTITY & entity )
protected

◆ ~EntityF()

template<typename T , unsigned D, typename ENTITY >
olb::EntityF< T, D, ENTITY >::~EntityF ( )
inlineoverride

virtual destructor for defined behaviour

Definition at line 43 of file entityF.h.

43{};

Member Function Documentation

◆ getEntityF()

template<typename T , unsigned D, typename ENTITY >
ENTITY & olb::EntityF< T, D, ENTITY >::getEntityF ( )
inline

expose entity reference

Definition at line 47 of file entityF.h.

47{ return _entity; }
ENTITY & _entity
Definition entityF.h:38

References olb::EntityF< T, D, ENTITY >::_entity.

◆ getExtent()

template<typename T , unsigned D, typename ENTITY >
auto olb::EntityF< T, D, ENTITY >::getExtent ( )
inline

get extent

Definition at line 45 of file entityF.h.

45{ return _entity.getExtent();}

References olb::EntityF< T, D, ENTITY >::_entity.

Member Data Documentation

◆ _entity

template<typename T , unsigned D, typename ENTITY >
ENTITY& olb::EntityF< T, D, ENTITY >::_entity
protected

Definition at line 38 of file entityF.h.

◆ d

template<typename T , unsigned D, typename ENTITY >
constexpr int olb::EntityF< T, D, ENTITY >::d = D
staticconstexpr

Definition at line 40 of file entityF.h.

◆ isSuper

template<typename T , unsigned D, typename ENTITY >
constexpr bool olb::EntityF< T, D, ENTITY >::isSuper = false
staticconstexpr

Definition at line 41 of file entityF.h.


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