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

ParticleCircumRadiusF NON-PARALLELIZED (no block/super differentiation) functor, which returns the circumRadius of a smoothIndicator. More...

#include <particleFunctors.h>

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

Public Member Functions

 ParticleCircumRadiusF (Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, typename DESCRIPTOR::fields_t > > &container)
 
bool operator() (T output[], const int input[])
 
- Public Member Functions inherited from olb::ContainerF< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t >, T >
 ContainerF (Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t > > &container, int targetDim)
 
Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t > > & getContainer ()
 
int getContainerSize () const
 
bool operator() (T output[], const int input[])
 
- 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)
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< T, S >
using targetType = T
 
using sourceType = S
 
- Public Attributes inherited from olb::ContainerF< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t >, T >
Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t > > & _container
 
- 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::ContainerF< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t >, T >
static constexpr bool isSuper
 
static constexpr unsigned d
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 

Detailed Description

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

ParticleCircumRadiusF NON-PARALLELIZED (no block/super differentiation) functor, which returns the circumRadius of a smoothIndicator.

Definition at line 38 of file particleFunctors.h.

Constructor & Destructor Documentation

◆ ParticleCircumRadiusF()

template<typename T , typename DESCRIPTOR >
olb::ParticleCircumRadiusF< T, DESCRIPTOR >::ParticleCircumRadiusF ( Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, typename DESCRIPTOR::fields_t > > & container)

Definition at line 31 of file particleFunctors.hh.

33 : ContainerF<T,DESCRIPTOR,DynamicFieldGroupsD<T,typename DESCRIPTOR::fields_t>,T>( container, 1 )
34{
35 this->getName() = "ParticleCircumRadiusF";
36}
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 DESCRIPTOR >
bool olb::ParticleCircumRadiusF< T, DESCRIPTOR >::operator() ( T output[],
const int input[] )

Definition at line 39 of file particleFunctors.hh.

40{
41 using namespace olb::descriptors;
42 using GROUP_EVAL = typename DESCRIPTOR::template derivedField<SURFACE>;
43 using FIELD_EVAL = typename GROUP_EVAL::template derivedField<SINDICATOR>;
44 auto sIndicatorPtr = this->getContainer().data().template get<GROUP_EVAL>()
45 .template getField<FIELD_EVAL>(input[0]);
46 T circumRadius = sIndicatorPtr->getCircumRadius();
47 output[0] = circumRadius;
48 return true; //TODO: add Error handling using true/false
49}
Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, DESCRIPTOR::fields_t > > & getContainer()
FIELD_ARRAY_TYPE & data()
Definition container.h:62
Descriptors for the 2D and 3D lattices.

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