olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W > Class Template Reference

ContainerF is a NON-PARALLELIZED (no block/super differentiation) functor intended to extract data from Container objects as used e.g. More...

#include <groupedFieldF.h>

Inheritance diagram for olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >:

Collaboration diagram for olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >:

Public Member Functions
	ContainerF (Container< T, DESCRIPTOR, FIELD_ARRAY_TYPE > &container, int targetDim)
Container< T, DESCRIPTOR, FIELD_ARRAY_TYPE > &	getContainer ()
int	getContainerSize () const
bool	operator() (W 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
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)

Public Attributes
Container< T, DESCRIPTOR, FIELD_ARRAY_TYPE > &	_container
Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)

Static Public Attributes
static constexpr bool	isSuper = false
static constexpr unsigned	d = DESCRIPTOR::d

Additional Inherited Members
Public Types inherited from olb::GenericF< T, int >
using	targetType
using	sourceType
Protected Member Functions inherited from olb::GenericF< T, int >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename DESCRIPTOR, typename FIELD_ARRAY_TYPE, typename W = T>
class olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >

ContainerF is a NON-PARALLELIZED (no block/super differentiation) functor intended to extract data from Container objects as used e.g.

in the particle framework.

Definition at line 38 of file groupedFieldF.h.

Constructor & Destructor Documentation

ContainerF()

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W >

olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::ContainerF	(	Container< T, DESCRIPTOR, FIELD_ARRAY_TYPE > &	container,
		int	targetDim )

Definition at line 33 of file groupedFieldF.hh.

  : GenericF<W,int>( targetDim, 1), _container(container)
{
  this->getName() = "ContainerF";
}

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

Here is the call graph for this function:

Member Function Documentation

getContainer()

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W >

Container< T, DESCRIPTOR, FIELD_ARRAY_TYPE > & olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::getContainer

(

)

Returns

container

Definition at line 42 of file groupedFieldF.hh.

{
  return _container;
}

getContainerSize()

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W >

int olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::getContainerSize

(

)

const

Returns

size of container

Definition at line 48 of file groupedFieldF.hh.

{
  OLB_ASSERT(_container.size() < INT32_MAX,
             "cast from std::size_t to int unsafe");
  return _container.size();
}

operator()()

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W >

bool olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::operator()	(	W	output[],
		const int	input[] )

Definition at line 56 of file groupedFieldF.hh.

{
  return true; //TODO: add Error handling using true/false
}

Member Data Documentation

_container

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W = T>

Container<T,DESCRIPTOR,FIELD_ARRAY_TYPE>& olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::_container

Definition at line 42 of file groupedFieldF.h.

d

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W = T>

unsigned olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::d = DESCRIPTOR::d

staticconstexpr

Definition at line 46 of file groupedFieldF.h.

isSuper

template<typename T , typename DESCRIPTOR , typename FIELD_ARRAY_TYPE , typename W = T>

bool olb::ContainerF< T, DESCRIPTOR, FIELD_ARRAY_TYPE, W >::isSuper = false

staticconstexpr

Definition at line 45 of file groupedFieldF.h.

---

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

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