#include <BoxLayoutData.H>

Inheritance diagram for BoxLayoutData< T >:

[legend]

Public Member Functions
	BoxLayoutData ()

virtual	~BoxLayoutData ()

	BoxLayoutData (const BoxLayout &boxes, int comps, const DataFactory< T > &factory=DefaultDataFactory< T >())

virtual void	define (const BoxLayout &boxes, int comps, const DataFactory< T > &factory=DefaultDataFactory< T >())

virtual void	define (const BoxLayoutData< T > &da, const DataFactory< T > &factory=DefaultDataFactory< T >())

virtual void	define (const BoxLayoutData< T > &da, const Interval &comps, const DataFactory< T > &factory=DefaultDataFactory< T >())

virtual void	define (const BoxLayout &boxes)
	overridden and throws an error. More...

virtual bool	threadSafe () const

int	nComp () const

Interval	interval () const

void	generalCopyTo (const BoxLayout &a_destGrids, LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_interval, const ProblemDomain &a_domain, const DataFactory< T > &factory=DefaultDataFactory< T >()) const
	General data copying operation. More...

void	generalCopyTo (const BoxLayout &a_destGrids, LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_interval, const ProblemDomain &a_domain, const Copier &a_copier, const DataFactory< T > &factory=DefaultDataFactory< T >()) const

void	addTo (const Interval &a_srcComps, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const ProblemDomain &a_domain) const

void	addTo (const Interval &a_srcComps, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const ProblemDomain &a_domain, const Copier &a_copier) const

virtual void	apply (void(*a_Function)(const Box &box, int comps, T &t))

virtual bool	isDefined () const

virtual void	clear ()

Public Member Functions inherited from LayoutData< T >
	LayoutData ()

	LayoutData (const BoxLayout &a_dp)

virtual	~LayoutData ()

DataIterator	dataIterator () const

TimedDataIterator	timedDataIterator () const

const T &	operator[] (const DataIndex &a_index) const
	const accessor function More...

const T &	operator[] (const DataIterator &a_iterator) const
	const accessor function More...

T &	operator[] (const DataIndex &a_index)
	non-const accessor function More...

T &	operator[] (const DataIterator &a_iterator)
	non-const accessor function More...

Box	box (const DataIndex &a_index) const

Box	box (const DataIterator &a_iterator) const

const BoxLayout &	boxLayout () const

Static Public Attributes
static int	s_verbosity = 0

Protected Member Functions
void	setVector (const BoxLayoutData< T > &da, const Interval &srcComps, const Interval &destComps)

void	allocateGhostVector (const DataFactory< T > &factory, const IntVect &ghost=IntVect::Zero)

void	makeItSo (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=LDOperator< T >()) const

void	makeItSoBegin (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=LDOperator< T >()) const

void	makeItSoLocalCopy (const Interval &a_srcComps, const BoxLayoutData< T > &a_src, BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op=LDOperator< T >()) const

void	makeItSoEnd (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op=LDOperator< T >()) const

void	completePendingSends () const

void	allocateBuffers (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const BoxLayoutData< T > &a_dest, const Interval &a_destComps, const Copier &a_copier, const LDOperator< T > &a_op) const

void	writeSendDataFromMeIntoBuffers (const BoxLayoutData< T > &a_src, const Interval &a_srcComps, const LDOperator< T > &a_op) const

void	postSendsFromMe () const

void	postReceivesToMe () const

void	unpackReceivesToMe (BoxLayoutData< T > &a_dest, const Interval &a_destComps, const LDOperator< T > &a_op) const

void	unpackReceivesToMe_append (LayoutData< Vector< RefCountedPtr< T > > > &a_dest, const Interval &a_destComps, int ncomp, const DataFactory< T > &factory, const LDOperator< T > &a_op) const

Protected Attributes
int	m_comps

bool	m_threadSafe

bool	m_isdefined

Parallel messaging members
CopierBuffer *	m_buff

Protected Attributes inherited from LayoutData< T >
BoxLayout	m_boxLayout

Vector< T * >	m_vector

bool	m_callDelete

Friends
class	LevelData< T >

Detailed Description

template<class T>
class BoxLayoutData< T >

Data on a BoxLayout.

A collection of Box-oriented objects. The arrangement of Boxes is given by the underlying BoxLayout object. BoxLayoutData attempt to prevent users from manipulating the template class T to become out of sync with the boxes in the BoxLayout. Caveat emptor.

All access to the data in a BoxLayoutData is forced to be data-parallel, by use of the DataIterator.

class T must provide the following methods:

```
 T() 
```
```
 T(const Box& box, int comps) 
```
```
 define(const Box& box, int comps) 
```

 void copy(const Box& Rfrom, const Interval& Cd, const Box& Rto, const T& source, const Interval Cs)
   Cs and Cd must have same length, but can be displaced;
   Rfrom and Rto must be the same size, but can be translated.

 static int preAllocatable()
   returns 0 if the size(...) function is strictly a function of Box and
      Interval, and does not depend on the current state of the T object.
   return 1 if size(..) is symmetric, in that sender and receiver T object
      can size their message buffers, but a static object cannot.
   returns 2 if the object is truly dynamic.  the message size is subject to
      unique object data.

 int size(const Box& R, const Interval& comps)

 void linearOut(void* buf, const Box& R, const Interval& comps)
    writes the T object into the byte stream buf, already allocated.

 void linearIn(void* buf, const Box& R, const Interval& comps)
    reads in the T object from the byte stream buf.

In sequential codes, many of these functions will not be called, but in the general parallel case, they all will be.

Constructor & Destructor Documentation

◆ BoxLayoutData() [1/2]

template<class T >

BoxLayoutData< T >::BoxLayoutData ( )

inline

◆ ~BoxLayoutData()

template<class T >

BoxLayoutData< T >::~BoxLayoutData ( )

virtual

◆ BoxLayoutData() [2/2]

template<class T>

BoxLayoutData< T >::BoxLayoutData	(	const BoxLayout &	boxes,
		int	comps,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)

inline

Member Function Documentation

◆ define() [1/4]

template<class T>

void BoxLayoutData< T >::define	(	const BoxLayout &	boxes,
		int	comps,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)

inlinevirtual

Reimplemented in LevelData< T >, LevelData< EBGraph >, LevelData< NodeFArrayBox >, LevelData< CodimBox< FArrayBox > >, LevelData< BaseFab< IntVect > >, LevelData< FluxBox >, LevelData< BaseIVFAB< Real > >, LevelData< BaseFab< PetscInt > >, LevelData< BaseIFFAB< Real > >, LevelData< EBCellFAB >, LevelData< EdgeDataBox >, LevelData< BaseFab< bool > >, LevelData< FArrayBox >, LevelData< EBData >, LevelData< EBFluxFAB >, and LevelData< BaseFab< int > >.

Referenced by AliasDataFactory< T >::AliasDataFactory(), BoxLayoutData< BaseFab< int > >::generalCopyTo(), and read().

◆ define() [2/4]

template<class T>

void BoxLayoutData< T >::define	(	const BoxLayoutData< T > &	da,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)

inlinevirtual

Reimplemented in LevelData< T >, LevelData< EBGraph >, LevelData< NodeFArrayBox >, LevelData< CodimBox< FArrayBox > >, LevelData< BaseFab< IntVect > >, LevelData< FluxBox >, LevelData< BaseIVFAB< Real > >, LevelData< BaseFab< PetscInt > >, LevelData< BaseIFFAB< Real > >, LevelData< EBCellFAB >, LevelData< EdgeDataBox >, LevelData< BaseFab< bool > >, LevelData< FArrayBox >, LevelData< EBData >, LevelData< EBFluxFAB >, and LevelData< BaseFab< int > >.

◆ define() [3/4]

template<class T>

void BoxLayoutData< T >::define	(	const BoxLayoutData< T > &	da,
		const Interval &	comps,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)

inlinevirtual

Define this BoxLayoutData to be the subset of the data in da defined by the Interval comps.

Reimplemented in LevelData< T >, LevelData< EBGraph >, LevelData< NodeFArrayBox >, LevelData< CodimBox< FArrayBox > >, LevelData< BaseFab< IntVect > >, LevelData< FluxBox >, LevelData< BaseIVFAB< Real > >, LevelData< BaseFab< PetscInt > >, LevelData< BaseIFFAB< Real > >, LevelData< EBCellFAB >, LevelData< EdgeDataBox >, LevelData< BaseFab< bool > >, LevelData< FArrayBox >, LevelData< EBData >, LevelData< EBFluxFAB >, and LevelData< BaseFab< int > >.

◆ define() [4/4]

template<class T>

void BoxLayoutData< T >::define ( const BoxLayout & boxes )

inlinevirtual

overridden and throws an error.

Reimplemented from LayoutData< T >.

Reimplemented in LevelData< T >, LevelData< EBGraph >, LevelData< NodeFArrayBox >, LevelData< CodimBox< FArrayBox > >, LevelData< BaseFab< IntVect > >, LevelData< FluxBox >, LevelData< BaseIVFAB< Real > >, LevelData< BaseFab< PetscInt > >, LevelData< BaseIFFAB< Real > >, LevelData< EBCellFAB >, LevelData< EdgeDataBox >, LevelData< BaseFab< bool > >, LevelData< FArrayBox >, LevelData< EBData >, LevelData< EBFluxFAB >, and LevelData< BaseFab< int > >.

◆ threadSafe()

template<class T>

virtual bool BoxLayoutData< T >::threadSafe ( ) const

inlinevirtual

Referenced by BoxLayoutData< BaseFab< int > >::makeItSoLocalCopy(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ nComp()

template<class T>

int BoxLayoutData< T >::nComp ( ) const

inline

Referenced by LevelDataOps< FArrayBox >::assign(), LevelData< BaseFab< int > >::copyTo(), LevelDataOps< FArrayBox >::copyToZero(), LevelDataOps< FArrayBox >::create(), BoxLayoutData< BaseFab< int > >::define(), LevelData< BaseFab< int > >::degenerate(), LevelData< BaseFab< int > >::degenerateLocalOnly(), MultilevelLinearOp< T >::dotProduct(), VCAMRPoissonOp2::getFlux(), AMRPoissonOp::getFlux(), LevelDataOps< FArrayBox >::incr(), LevelData< BaseFab< int > >::localCopyTo(), MergeSolver< T >::solve(), and WriteMultiData< T >::writeData().

◆ interval()

template<class T>

Interval BoxLayoutData< T >::interval ( ) const

inline

Referenced by LevelData< BaseFab< int > >::copyTo(), AliasDataFactory< T >::define(), LevelData< BaseFab< int > >::exchange(), SimpleAdaptor::exchange(), LevelData< BaseFab< int > >::exchangeBegin(), LevelData< BaseFab< int > >::exchangeEnd(), LevelData< BaseFab< int > >::exchangeNoOverlap(), LevelData< BaseFab< int > >::LevelData(), LevelData< BaseFab< int > >::localCopyTo(), write(), and WriteMultiData< T >::writeData().

◆ generalCopyTo() [1/2]

template<class T>

void BoxLayoutData< T >::generalCopyTo	(	const BoxLayout &	a_destGrids,
		LayoutData< Vector< RefCountedPtr< T > > > &	a_dest,
		const Interval &	a_interval,
		const ProblemDomain &	a_domain,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)		const

General data copying operation.

Parameters

a_destGrids	BoxLayout for the destination data holder
a_dest	return argument. upon completion contains a Vector of T objects for each Box in a_destGrids that overlaps this->boxLayout()
a_interval	range of components to source
a_domain	ProblemDomain that this grid and a_destGrids reside on.
factory	optional data factory for template classes that have non-trivial construction

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo().

◆ generalCopyTo() [2/2]

template<class T>

void BoxLayoutData< T >::generalCopyTo	(	const BoxLayout &	a_destGrids,
		LayoutData< Vector< RefCountedPtr< T > > > &	a_dest,
		const Interval &	a_interval,
		const ProblemDomain &	a_domain,
		const Copier &	a_copier,
		const DataFactory< T > &	factory = `DefaultDataFactory<T>()`
	)		const

◆ addTo() [1/2]

template<class T>

void BoxLayoutData< T >::addTo	(	const Interval &	a_srcComps,
		BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const ProblemDomain &	a_domain
	)		const

Special version of generalCopyTo that performs increment-on-intersection of the destination instead of replacement

Referenced by BoxLayoutData< BaseFab< int > >::addTo().

◆ addTo() [2/2]

template<class T>

void BoxLayoutData< T >::addTo	(	const Interval &	a_srcComps,
		BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const ProblemDomain &	a_domain,
		const Copier &	a_copier
	)		const

Special version of generalCopyTo that performs increment-on-intersection of the destination instead of replacement. This version lets the user send in a pre-built Copier.

◆ apply()

template<class T>

void BoxLayoutData< T >::apply ( void(*)(const Box &box, int comps, T &t) a_Function )

inlinevirtual

◆ isDefined()

template<class T >

bool BoxLayoutData< T >::isDefined ( ) const

inlinevirtual

◆ clear()

template<class T >

void BoxLayoutData< T >::clear ( )

inlinevirtual

◆ setVector()

template<class T>

void BoxLayoutData< T >::setVector	(	const BoxLayoutData< T > &	da,
		const Interval &	srcComps,
		const Interval &	destComps
	)

inlineprotected

Referenced by LevelData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::define(), and LevelData< BaseFab< int > >::LevelData().

◆ allocateGhostVector()

template<class T>

void BoxLayoutData< T >::allocateGhostVector	(	const DataFactory< T > &	factory,
		const IntVect &	ghost = `IntVect::Zero`
	)

inlineprotected

Referenced by BoxLayoutData< BaseFab< int > >::BoxLayoutData(), LevelData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::define(), and LevelData< BaseFab< int > >::LevelData().

◆ makeItSo()

template<class T>

void BoxLayoutData< T >::makeItSo	(	const Interval &	a_srcComps,
		const BoxLayoutData< T > &	a_src,
		BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const Copier &	a_copier,
		const LDOperator< T > &	a_op = `LDOperator<T>()`
	)		const

protected

Referenced by BoxLayoutData< BaseFab< int > >::addTo(), LevelData< BaseFab< int > >::copyTo(), and LevelData< BaseFab< int > >::exchange().

◆ makeItSoBegin()

template<class T>

void BoxLayoutData< T >::makeItSoBegin	(	const Interval &	a_srcComps,
		const BoxLayoutData< T > &	a_src,
		BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const Copier &	a_copier,
		const LDOperator< T > &	a_op = `LDOperator<T>()`
	)		const

protected

Referenced by LevelData< BaseFab< int > >::exchangeBegin(), LevelData< BaseFab< int > >::exchangeNoOverlap(), and BoxLayoutData< BaseFab< int > >::makeItSo().

◆ makeItSoLocalCopy()

template<class T>

void BoxLayoutData< T >::makeItSoLocalCopy	(	const Interval &	a_srcComps,
		const BoxLayoutData< T > &	a_src,
		BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const Copier &	a_copier,
		const LDOperator< T > &	a_op = `LDOperator<T>()`
	)		const

protected

Referenced by LevelData< BaseFab< int > >::exchangeBegin(), LevelData< BaseFab< int > >::exchangeNoOverlap(), and BoxLayoutData< BaseFab< int > >::makeItSo().

◆ makeItSoEnd()

template<class T>

void BoxLayoutData< T >::makeItSoEnd	(	BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const LDOperator< T > &	a_op = `LDOperator<T>()`
	)		const

protected

Referenced by LevelData< BaseFab< int > >::exchangeEnd(), LevelData< BaseFab< int > >::exchangeNoOverlap(), and BoxLayoutData< BaseFab< int > >::makeItSo().

◆ completePendingSends()

template<class T >

void BoxLayoutData< T >::completePendingSends ( ) const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoEnd(), BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append(), and BoxLayoutData< BaseFab< int > >::~BoxLayoutData().

◆ allocateBuffers()

template<class T>

void BoxLayoutData< T >::allocateBuffers	(	const BoxLayoutData< T > &	a_src,
		const Interval &	a_srcComps,
		const BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const Copier &	a_copier,
		const LDOperator< T > &	a_op
	)		const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoBegin(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ writeSendDataFromMeIntoBuffers()

template<class T>

void BoxLayoutData< T >::writeSendDataFromMeIntoBuffers	(	const BoxLayoutData< T > &	a_src,
		const Interval &	a_srcComps,
		const LDOperator< T > &	a_op
	)		const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoBegin(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ postSendsFromMe()

template<class T >

void BoxLayoutData< T >::postSendsFromMe ( ) const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoBegin(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ postReceivesToMe()

template<class T >

void BoxLayoutData< T >::postReceivesToMe ( ) const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoBegin(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ unpackReceivesToMe()

template<class T>

void BoxLayoutData< T >::unpackReceivesToMe	(	BoxLayoutData< T > &	a_dest,
		const Interval &	a_destComps,
		const LDOperator< T > &	a_op
	)		const

protected

Referenced by BoxLayoutData< BaseFab< int > >::makeItSoEnd(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ unpackReceivesToMe_append()

template<class T>

void BoxLayoutData< T >::unpackReceivesToMe_append	(	LayoutData< Vector< RefCountedPtr< T > > > &	a_dest,
		const Interval &	a_destComps,
		int	ncomp,
		const DataFactory< T > &	factory,
		const LDOperator< T > &	a_op
	)		const

protected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

Friends And Related Function Documentation

◆ LevelData< T >

template<class T>

friend class LevelData< T >

friend

Member Data Documentation

◆ s_verbosity

template<class T>

int BoxLayoutData< T >::s_verbosity = 0

static

Referenced by BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ m_comps

template<class T>

int BoxLayoutData< T >::m_comps

protected

Referenced by BoxLayoutData< BaseFab< int > >::allocateGhostVector(), LevelData< BaseFab< int > >::apply(), BoxLayoutData< BaseFab< int > >::apply(), LevelData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::define(), and LevelData< BaseFab< int > >::LevelData().

◆ m_threadSafe

template<class T>

bool BoxLayoutData< T >::m_threadSafe

protected

Referenced by LevelData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::define(), LevelData< BaseFab< int > >::LevelData(), BoxLayoutData< BaseFab< int > >::makeItSoLocalCopy(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

◆ m_isdefined

template<class T>

bool BoxLayoutData< T >::m_isdefined

protected

Referenced by BoxLayoutData< BaseFab< int > >::BoxLayoutData(), BoxLayoutData< BaseFab< int > >::clear(), LevelData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::define(), BoxLayoutData< BaseFab< int > >::isDefined(), and LevelData< BaseFab< int > >::LevelData().

◆ m_buff

template<class T>

CopierBuffer* BoxLayoutData< T >::m_buff

mutableprotected

Referenced by BoxLayoutData< BaseFab< int > >::generalCopyTo(), BoxLayoutData< BaseFab< int > >::makeItSoBegin(), and BoxLayoutData< BaseFab< int > >::unpackReceivesToMe_append().

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class T> class BoxLayoutData< T >

Constructor & Destructor Documentation

◆ BoxLayoutData() [1/2]

◆ ~BoxLayoutData()

◆ BoxLayoutData() [2/2]

Member Function Documentation

◆ define() [1/4]

◆ define() [2/4]

◆ define() [3/4]

◆ define() [4/4]

◆ threadSafe()

◆ nComp()

◆ interval()

◆ generalCopyTo() [1/2]

◆ generalCopyTo() [2/2]

◆ addTo() [1/2]

◆ addTo() [2/2]

◆ apply()

◆ isDefined()

◆ clear()

◆ setVector()

◆ allocateGhostVector()

◆ makeItSo()

◆ makeItSoBegin()

◆ makeItSoLocalCopy()

◆ makeItSoEnd()

◆ completePendingSends()

◆ allocateBuffers()

◆ writeSendDataFromMeIntoBuffers()

◆ postSendsFromMe()

◆ postReceivesToMe()

◆ unpackReceivesToMe()

◆ unpackReceivesToMe_append()

Friends And Related Function Documentation

◆ LevelData< T >

Member Data Documentation

◆ s_verbosity

◆ m_comps

◆ m_threadSafe

◆ m_isdefined

◆ m_buff

template<class T>
class BoxLayoutData< T >