plb::MultiScalarField3D< T > Class Template Reference

#include <multiDataField3D.h>

Inheritance diagram for plb::MultiScalarField3D< T >:

[legend]

Collaboration diagram for plb::MultiScalarField3D< T >:

[legend]

List of all members.

Public Types
typedef std::map< plint, ScalarField3D< T > * >	BlockMap
Public Member Functions
	MultiScalarField3D (MultiBlockManagement3D const &multiBlockManagement_, BlockCommunicator3D *blockCommunicator_, CombinedStatistics *combinedStatistics_, MultiScalarAccess3D< T > *multiScalarAccess_, T iniVal=T())
	MultiScalarField3D (plint nx, plint ny, plint nz, T iniVal=T())
	~MultiScalarField3D ()
	MultiScalarField3D (MultiScalarField3D< T > const &rhs)
	MultiScalarField3D (MultiBlock3D const &rhs)
	MultiScalarField3D (MultiBlock3D const &rhs, Box3D subDomain, bool crop=true)
MultiScalarField3D< T > &	operator= (MultiScalarField3D< T > const &rhs)
MultiScalarField3D< T > *	clone () const
MultiScalarField3D< T > *	clone (MultiBlockManagement3D const &newMultiBlockManagement) const
void	swap (MultiScalarField3D< T > &rhs)
virtual void	reset ()
virtual T &	get (plint iX, plint iY, plint iZ)
virtual T const &	get (plint iX, plint iY, plint iZ) const
virtual ScalarField3D< T > &	getComponent (plint blockId)
virtual ScalarField3D< T > const &	getComponent (plint blockId) const
virtual plint	sizeOfCell () const
virtual plint	getCellDim () const
virtual int	getStaticId () const
virtual void	copyReceive (MultiBlock3D const &fromBlock, Box3D const &fromDomain, Box3D const &toDomain, modif::ModifT whichData=modif::dataStructure)
std::string	getBlockName () const
	Get a string identifier for the type of block. E.g. "lattice3d".
std::vector< std::string >	getTypeInfo () const
Static Public Member Functions
static std::string	blockName ()
static std::string	basicType ()

template<typename T>
class plb::MultiScalarField3D< T >

---

Member Typedef Documentation

template<typename T>

typedef std::map<plint,ScalarField3D<T>*> plb::MultiScalarField3D< T >::BlockMap

---

Constructor & Destructor Documentation

template<typename T>

plb::MultiScalarField3D< T >::MultiScalarField3D	(	MultiBlockManagement3D const &	multiBlockManagement_,
		BlockCommunicator3D *	blockCommunicator_,
		CombinedStatistics *	combinedStatistics_,
		MultiScalarAccess3D< T > *	multiScalarAccess_,
		T	iniVal = T()
	)			[inline]

template<typename T>

plb::MultiScalarField3D< T >::MultiScalarField3D	(	plint	nx,
		plint	ny,
		plint	nz,
		T	iniVal = T()
	)			[inline]

template<typename T >

plb::MultiScalarField3D< T >::~MultiScalarField3D

(

)

[inline]

template<typename T>

plb::MultiScalarField3D< T >::MultiScalarField3D

(

MultiScalarField3D< T > const &

rhs

)

[inline]

template<typename T>

plb::MultiScalarField3D< T >::MultiScalarField3D

(

MultiBlock3D const &

rhs

)

[inline]

template<typename T>

plb::MultiScalarField3D< T >::MultiScalarField3D	(	MultiBlock3D const &	rhs,
		Box3D	subDomain,
		bool	crop = true
	)			[inline]

Extract sub-domain from rhs and construct a multi-scalar-field with the same data distribution and policy-classes; but the data itself and the data-processors are not copied. MultiScalarAccess takes default value.

---

Member Function Documentation

template<typename T >

std::string plb::MultiScalarField3D< T >::basicType

(

)

[inline, static]

Referenced by plb::MultiScalarField3D< T >::getTypeInfo().

template<typename T >

std::string plb::MultiScalarField3D< T >::blockName

(

)

[inline, static]

Referenced by plb::MultiScalarField3D< T >::getBlockName().

template<typename T >

MultiScalarField3D< T > * plb::MultiScalarField3D< T >::clone

(

MultiBlockManagement3D const &

newMultiBlockManagement

)

const [inline, virtual]

Implements plb::MultiBlock3D.

References plb::CombinedStatistics::clone(), plb::BlockCommunicator3D::clone(), plb::copy(), plb::MultiBlock3D::getBlockCommunicator(), plb::MultiBlock3D::getBoundingBox(), and plb::MultiBlock3D::getCombinedStatistics().

template<typename T >

MultiScalarField3D< T > * plb::MultiScalarField3D< T >::clone

(

)

const [inline, virtual]

Implements plb::MultiBlock3D.

template<typename T >

void plb::MultiScalarField3D< T >::copyReceive	(	MultiBlock3D const &	fromBlock,
		Box3D const &	fromDomain,
		Box3D const &	toDomain,
		modif::ModifT	whichData = modif::dataStructure
	)			[inline, virtual]

Implements plb::MultiBlock3D.

References plb::copy(), and PLB_ASSERT.

template<typename T >

T const & plb::MultiScalarField3D< T >::get	(	plint	iX,
		plint	iY,
		plint	iZ
	)			const [inline, virtual]

Implements plb::ScalarFieldBase3D< T >.

References plb::MultiBlock3D::getMultiBlockManagement(), plb::MultiBlock3D::getNx(), plb::MultiBlock3D::getNy(), plb::MultiBlock3D::getNz(), and PLB_PRECONDITION.

template<typename T >

T & plb::MultiScalarField3D< T >::get	(	plint	iX,
		plint	iY,
		plint	iZ
	)			[inline, virtual]

Implements plb::ScalarFieldBase3D< T >.

References plb::MultiBlock3D::getMultiBlockManagement(), plb::MultiBlock3D::getNx(), plb::MultiBlock3D::getNy(), plb::MultiBlock3D::getNz(), and PLB_PRECONDITION.

template<typename T >

std::string plb::MultiScalarField3D< T >::getBlockName

(

)

const [inline, virtual]

Get a string identifier for the type of block. E.g. "lattice3d".

Implements plb::MultiBlock3D.

References plb::MultiScalarField3D< T >::blockName().

template<typename T >

plint plb::MultiScalarField3D< T >::getCellDim

(

)

const [inline, virtual]

Implements plb::MultiBlock3D.

template<typename T >

ScalarField3D< T > const & plb::MultiScalarField3D< T >::getComponent

(

plint

blockId

)

const [inline, virtual]

Implements plb::MultiBlock3D.

References PLB_ASSERT.

template<typename T >

ScalarField3D< T > & plb::MultiScalarField3D< T >::getComponent

(

plint

blockId

)

[inline, virtual]

Implements plb::MultiBlock3D.

References PLB_ASSERT.

template<typename T >

int plb::MultiScalarField3D< T >::getStaticId

(

)

const [inline, virtual]

Implements plb::MultiBlock3D.

template<typename T >

std::vector< std::string > plb::MultiScalarField3D< T >::getTypeInfo

(

)

const [inline, virtual]

Get one or two string identifiers for the template parameters of the block. E.g. "double" and "d3q19"

Implements plb::MultiBlock3D.

References plb::MultiScalarField3D< T >::basicType().

template<typename T>

MultiScalarField3D< T > & plb::MultiScalarField3D< T >::operator=

(

MultiScalarField3D< T > const &

rhs

)

[inline]

References plb::MultiScalarField3D< T >::swap().

template<typename T >

void plb::MultiScalarField3D< T >::reset

(

)

[inline, virtual]

Implements plb::ScalarFieldBase3D< T >.

template<typename T >

plint plb::MultiScalarField3D< T >::sizeOfCell

(

)

const [inline, virtual]

Implements plb::MultiBlock3D.

template<typename T>

void plb::MultiScalarField3D< T >::swap

(

MultiScalarField3D< T > &

rhs

)

[inline]

Referenced by plb::MultiScalarField3D< T >::operator=().

---

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

• multiDataField3D.h
• multiDataField3D.hh