olb::BlockDataF3D< T, BaseType > Class Template Reference

BlockDataF3D can store data of any BlockFunctor3D. More...

#include <blockBaseF3D.h>

Inheritance diagram for olb::BlockDataF3D< T, BaseType >:

Collaboration diagram for olb::BlockDataF3D< T, BaseType >:

Public Member Functions
	BlockDataF3D (BlockData< 3, T, BaseType > &blockData)
	Constructor.
	BlockDataF3D (BlockF3D< BaseType > &f)
	to store functor data, constuctor creates _blockData with functor data
BlockData< 3, T, BaseType > &	getBlockData ()
	returns _blockData
bool	operator() (BaseType output[], const int input[]) override
	access to _blockData via its get()
Public Member Functions inherited from olb::BlockF3D< BaseType >
	~BlockF3D () override
	virtual destructor for defined behaviour
virtual BlockStructureD< 3 > &	getBlockStructure () const
BlockF3D< BaseType > &	operator- (BlockF3D< BaseType > &rhs)
BlockF3D< BaseType > &	operator+ (BlockF3D< BaseType > &rhs)
BlockF3D< BaseType > &	operator* (BlockF3D< BaseType > &rhs)
BlockF3D< BaseType > &	operator/ (BlockF3D< BaseType > &rhs)
Public Member Functions inherited from olb::GenericF< BaseType, 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() (BaseType output[])
	wrapper that call the pure virtual operator() (T output[], const S input[]) from above
bool	operator() (BaseType output[], int input0)
bool	operator() (BaseType output[], int input0, int input1)
bool	operator() (BaseType output[], int input0, int input1, int input2)
bool	operator() (BaseType output[], int input0, int input1, int input2, int input3)

Protected Member Functions
	BlockDataF3D (int nx, int ny, int nz, int size=1)
Protected Member Functions inherited from olb::BlockF3D< BaseType >
	BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
Protected Member Functions inherited from olb::GenericF< BaseType, int >
	GenericF (int targetDim, int sourceDim)

Protected Attributes
std::unique_ptr< BlockData< 3, T, BaseType > >	_blockDataStorage
BlockData< 3, T, BaseType > &	_blockData
Protected Attributes inherited from olb::BlockF3D< BaseType >
BlockStructureD< 3 > &	_blockStructure

Additional Inherited Members
Public Types inherited from olb::GenericF< BaseType, int >
using	targetType
using	sourceType
Public Attributes inherited from olb::GenericF< BaseType, int >
std::shared_ptr< GenericF< BaseType, int > >	_ptrCalcC
	memory management, frees resouces (calcClass)

Detailed Description

template<typename T, typename BaseType>
class olb::BlockDataF3D< T, BaseType >

BlockDataF3D can store data of any BlockFunctor3D.

Definition at line 389 of file aliases.h.

Constructor & Destructor Documentation

BlockDataF3D() [1/3]

template<typename T , typename BaseType >

olb::BlockDataF3D< T, BaseType >::BlockDataF3D ( int nx, int ny, int nz, int size = 1 )

protected

Definition at line 56 of file blockBaseF3D.hh.

  : BlockF3D<T>(*(new BlockData<3,T,BaseType>({{nx, ny, nz}, 0}, size)), size),
    _blockDataStorage(static_cast<BlockData<3,T,BaseType>*>(&(this->getBlockStructure()))),
    _blockData(*_blockDataStorage)
{ }

BlockDataF3D() [2/3]

template<typename T , typename BaseType >

olb::BlockDataF3D< T, BaseType >::BlockDataF3D

(

BlockData< 3, T, BaseType > &

blockData

)

Constructor.

Definition at line 43 of file blockBaseF3D.hh.

  : BlockF3D<T>(blockData, blockData.getSize()),
    _blockData(blockData)
{ }

BlockDataF3D() [3/3]

template<typename T , typename BaseType >

olb::BlockDataF3D< T, BaseType >::BlockDataF3D

(

BlockF3D< BaseType > &

f

)

to store functor data, constuctor creates _blockData with functor data

Definition at line 49 of file blockBaseF3D.hh.

  : BlockF3D<T>(f.getBlockStructure(), f.getTargetDim()),
    _blockDataStorage(new BlockData<3,T,BaseType>(f)),
    _blockData(*_blockDataStorage)
{ }

Member Function Documentation

getBlockData()

template<typename T , typename BaseType >

BlockData< 3, T, BaseType > & olb::BlockDataF3D< T, BaseType >::getBlockData

(

)

returns _blockData

Definition at line 65 of file blockBaseF3D.hh.

{
  return _blockData;
}

operator()()

template<typename T , typename BaseType >

bool olb::BlockDataF3D< T, BaseType >::operator() ( BaseType output[], const int input[] )

overridevirtual

access to _blockData via its get()

Implements olb::GenericF< BaseType, int >.

Definition at line 71 of file blockBaseF3D.hh.

{
  for (int iDim = 0; iDim < this->getTargetDim(); ++iDim) {
    output[iDim] = _blockData.get(input, iDim);
  }
  return true;
}

Member Data Documentation

_blockData

template<typename T , typename BaseType >

BlockData<3,T,BaseType>& olb::BlockDataF3D< T, BaseType >::_blockData

protected

Definition at line 70 of file blockBaseF3D.h.

_blockDataStorage

template<typename T , typename BaseType >

std::unique_ptr<BlockData<3,T,BaseType> > olb::BlockDataF3D< T, BaseType >::_blockDataStorage

protected

Definition at line 69 of file blockBaseF3D.h.

---

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

• src/functors/analytical/indicator/smoothIndicatorF3D.h
• src/functors/lattice/blockBaseF3D.h
• src/utilities/aliases.h
• src/functors/lattice/blockBaseF3D.hh