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

#include <entityF.h>

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

Public Member Functions

LoadBalancer< T > & getLoadBalancer ()
 expose load balancer
 
int getNumOfEntityF () const
 return number of entity functors
 
EntityF< W, D, ENTITY > & getEntityF (int iCloc)
 get specific entity functor
 
bool operator() (W output[], const int input[])
 operator
 
- 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)
 

Static Public Attributes

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

Protected Member Functions

 SuperEntityF (LoadBalancer< T > &loadBalancer, int targetDim, int sourceDim)
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 

Protected Attributes

LoadBalancer< T > & _loadBalancer
 
std::vector< std::unique_ptr< EntityF< W, D, ENTITY > > > _entityF
 By convention: If entity level functors are used at all, they should number exactly LoadBalancer<T>::size per process.
 

Additional Inherited Members

- 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)
 

Detailed Description

template<typename T, unsigned D, typename ENTITY, typename W = T>
class olb::SuperEntityF< T, D, ENTITY, W >

Definition at line 54 of file entityF.h.

Constructor & Destructor Documentation

◆ SuperEntityF()

template<typename T , unsigned D, typename ENTITY , typename W = T>
olb::SuperEntityF< T, D, ENTITY, W >::SuperEntityF ( LoadBalancer< T > & loadBalancer,
int targetDim,
int sourceDim )
protected

Member Function Documentation

◆ getEntityF()

template<typename T , unsigned D, typename ENTITY , typename W = T>
EntityF< W, D, ENTITY > & olb::SuperEntityF< T, D, ENTITY, W >::getEntityF ( int iCloc)

get specific entity functor

◆ getLoadBalancer()

template<typename T , unsigned D, typename ENTITY , typename W = T>
LoadBalancer< T > & olb::SuperEntityF< T, D, ENTITY, W >::getLoadBalancer ( )

expose load balancer

◆ getNumOfEntityF()

template<typename T , unsigned D, typename ENTITY , typename W = T>
int olb::SuperEntityF< T, D, ENTITY, W >::getNumOfEntityF ( ) const

return number of entity functors

◆ operator()()

template<typename T , unsigned D, typename ENTITY , typename W = T>
bool olb::SuperEntityF< T, D, ENTITY, W >::operator() ( W output[],
const int input[] )

operator

Member Data Documentation

◆ _entityF

template<typename T , unsigned D, typename ENTITY , typename W = T>
std::vector<std::unique_ptr<EntityF<W,D,ENTITY> > > olb::SuperEntityF< T, D, ENTITY, W >::_entityF
protected

By convention: If entity level functors are used at all, they should number exactly LoadBalancer<T>::size per process.

Definition at line 62 of file entityF.h.

◆ _loadBalancer

template<typename T , unsigned D, typename ENTITY , typename W = T>
LoadBalancer<T>& olb::SuperEntityF< T, D, ENTITY, W >::_loadBalancer
protected

Definition at line 57 of file entityF.h.

◆ d

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

Definition at line 64 of file entityF.h.

◆ isSuper

template<typename T , unsigned D, typename ENTITY , typename W = T>
constexpr bool olb::SuperEntityF< T, D, ENTITY, W >::isSuper = true
staticconstexpr

Definition at line 65 of file entityF.h.


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