olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD > Class Template Reference

GroupedFieldF is a NON-PARALLELIZED (no block/super differentiation) functor. More...

#include <groupedFieldF.h>

Inheritance diagram for olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD >:

Collaboration diagram for olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD >:

Public Member Functions
	GroupedFieldF (Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, typename DESCRIPTOR::fields_t > > &container)
bool	operator() (T output[], const int input[])
	has to be implemented for 'every' derived class
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, 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::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, int >
std::shared_ptr< GenericF< T, int > >	_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, int >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename DESCRIPTOR, typename GROUP, typename FIELD>
class olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD >

GroupedFieldF is a NON-PARALLELIZED (no block/super differentiation) functor.

Motivated by enabling easy access to quantities in the particle system, this funcor can be used for any grouped field frameworks. When a proper parrallelization methodology for the particle framework exists, this might have to be extended.

Definition at line 70 of file groupedFieldF.h.

Constructor & Destructor Documentation

GroupedFieldF()

template<typename T , typename DESCRIPTOR , typename GROUP , typename FIELD >

olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD >::GroupedFieldF

(

Container< T, DESCRIPTOR, DynamicFieldGroupsD< T, typename DESCRIPTOR::fields_t > > &

container

)

Definition at line 63 of file groupedFieldF.hh.

  : ContainerF<T,DESCRIPTOR,DynamicFieldGroupsD<T,typename DESCRIPTOR::fields_t>,T>( container,
      DESCRIPTOR::template size<typename meta::derived_type_in_nested<DESCRIPTOR,GROUP,FIELD>::type>() )
{
  this->getName() = std::string(typeid(FIELD).name());
}

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

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename DESCRIPTOR , typename GROUP , typename FIELD >

bool olb::GroupedFieldF< T, DESCRIPTOR, GROUP, FIELD >::operator() ( T output[], const int input[] )

virtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 72 of file groupedFieldF.hh.

{
  using namespace olb::descriptors;
  using GROUP_EVAL = typename DESCRIPTOR::template derivedField<GROUP>;
  using FIELD_EVAL = typename GROUP_EVAL::template derivedField<FIELD>;
  auto fieldValue = this->getContainer().data().template get<GROUP_EVAL>()
                  .template getFieldPointer<FIELD_EVAL>(input[0]);
 
  for (int iDim=0; iDim<this->getTargetDim(); ++iDim){
    output[iDim] = fieldValue[iDim];
  }
  return true; //TODO: add Error handling using true/false
}

---

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

• src/functors/groupedFieldF.h
• src/functors/groupedFieldF.hh