SAMRAI::pdat::CellData

SAMRAI::pdat::CellData< DIM, TYPE > Class Template Reference

Class CellData<DIM> provides an implementation for data defined at cell centers on AMR patches. It is derived from the hier::PatchData interface common to all SAMRAI patch data types. Given a CELL-centered AMR index space box, a cell data object represents data of some template TYPE and depth at the centers of the cells in the box. Here, depth indicates the number of data values at each cell index location. The CellGeometry class provides the translation between the standard SAMRAI cell-centered AMR index space and cell-centered data. More...

#include <source/patchdata/cell/CellData.h>

Inheritance diagram for SAMRAI::pdat::CellData< DIM, TYPE >:

[legend]List of all members.


Public Types
typedef CellIterator< DIM >	Iterator
Public Member Functions
	CellData (const hier::Box< DIM > &box, int depth, const hier::IntVector< DIM > &ghosts, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >((0)))
	The constructor for an cell data object.
virtual	~CellData ()
	The virtual destructor for a cell data object.
int	getDepth () const
	Return the depth (e.g., the number of components in each spatial location) of the array.
TYPE *	getPointer (int depth=0)
	Get a pointer to the beginning of a depth component of the cell centered array.
const TYPE *	getPointer (int depth=0) const
	Get a const pointer to the beginning of a depth component of the cell centered array.
TYPE &	operator() (const CellIndex< DIM > &i, int depth=0)
	Return reference to cell data entry corresponding to a given cell index and depth.
const TYPE &	operator() (const CellIndex< DIM > &i, int depth=0) const
	Return a const reference to cell data entry corresponding to a given cell index and depth.
ArrayData< DIM, TYPE > &	getArrayData ()
	Return a reference to the array data object for the cell centered data object.
const ArrayData< DIM, TYPE > &	getArrayData () const
	Return a const reference to the array data object for the cell centered data object.
virtual void	copy (const hier::PatchData< DIM > &src)
	A fast copy from source to destination (i.e., this) patch data object.
virtual void	copy2 (hier::PatchData< DIM > &dst) const
	A fast copy from source (i.e., this) to destination patch data object.
virtual void	copy (const hier::PatchData< DIM > &src, const hier::BoxOverlap< DIM > &overlap)
	Copy data from source to destination (i.e., this) patch data object on the given overlap.
virtual void	copy2 (hier::PatchData< DIM > &dst, const hier::BoxOverlap< DIM > &overlap) const
	Copy data from source (i.e., this) to destination patch data object on the given overlap.
void	copyOnBox (const CellData< DIM, TYPE > &src, const hier::Box< DIM > &box)
	Copy data from source to destination (i.e., this) patch data object on the given CELL-centered AMR index box.
virtual void	copyDepth (int dst_depth, const CellData< DIM, TYPE > &src, int src_depth)
	Fast copy (i.e., source and this cell data objects are defined over the same box) to this destination cell data object from the given source cell data object at the specified depths.
virtual bool	canEstimateStreamSizeFromBox () const
	Return true if the patch data object can estimate the stream size required to fit its data using only index space information (i.e., a box).
virtual int	getDataStreamSize (const hier::BoxOverlap< DIM > &overlap) const
	Return the number of bytes needed to stream the data in this patch data object lying in the specified box overlap region.
virtual void	packStream (tbox::AbstractStream &stream, const hier::BoxOverlap< DIM > &overlap) const
	Unpack data from stream into this patch data object over the specified box overlap region. The overlap must be a CellOverlap of the same DIM.
virtual void	unpackStream (tbox::AbstractStream &stream, const hier::BoxOverlap< DIM > &overlap)
	Unpack data from stream into this patch data object over the specified box overlap region. The overlap must be a CellOverlap of the same DIM.
void	fill (const TYPE &t, int d=0)
	Fill all values at depth d with the value t.
void	fill (const TYPE &t, const hier::Box< DIM > &box, int d=0)
	Fill all values at depth d within the box with the value t.
void	fillAll (const TYPE &t)
	Fill all depth components with value t.
void	fillAll (const TYPE &t, const hier::Box< DIM > &box)
	Fill all depth components within the box with value t.
void	print (const hier::Box< DIM > &box, std::ostream &os=tbox::plog, int prec=12) const
	Print all cell data values residing in the specified box. If the depth of the array is greater than one, all depths are printed.
void	print (const hier::Box< DIM > &box, int depth, std::ostream &os=tbox::plog, int prec=12) const
	Print all cell data values at the given array depth in the specified box.
virtual void	getSpecializedFromDatabase (tbox::Pointer< tbox::Database > database)
virtual void	putSpecializedToDatabase (tbox::Pointer< tbox::Database > database)
Static Public Member Functions
static size_t	getSizeOfData (const hier::Box< DIM > &box, int depth, const hier::IntVector< DIM > &ghosts)
	Calculate the amount of memory needed to represent cell- centered data over a CELL-centered AMR index space box.

Detailed Description

template<int DIM, class TYPE>
class SAMRAI::pdat::CellData< DIM, TYPE >

A cell-centerd data array is stored in (i,...,k,d) order, where i,...,k are spatial indices and d indicates the depth at that location. Memory allocation is in column-major ordering (e.g., Fortran style) so that the leftmost index runs fastest in memory. For example, a three-dimensional cell data object defined over a box [l0:u0,l1:u1,l2:u2] holds a data array dimensioned as


     [ l0 : u0 ,
       l1 : u1 ,
       l2 : u2 , d ]

 *

Other spatial dimensions are represented similarly.

The data type TYPE must define a default constructor (i.e., taking no arguments) and also the copy assignment operator.

See also:

pdat::ArrayData

hier::PatchData

pdat::CellDataFactory

pdat::CellIndex

pdat::CellIterator

pdat::CellGeometry

Member Typedef Documentation

template<int DIM, class TYPE>

typedef CellIterator<DIM> SAMRAI::pdat::CellData< DIM, TYPE >::Iterator

The cell iterator iterates over the elements of a cell centered box geometry. This typedef is a convenience for using the CellIterator<DIM> class.

Constructor & Destructor Documentation

template<int DIM, class TYPE>

SAMRAI::pdat::CellData< DIM, TYPE >::CellData	(	const hier::Box< DIM > &	box,
		int	depth,
		const hier::IntVector< DIM > &	ghosts,
		tbox::Pointer< tbox::Arena >	pool = `tbox::Pointer< tbox::Arena >((0))`
	)

The constructor for an cell data object.

Parameters:

	box	const Box reference describing the interior of the standard CELL-centered index box over which the cell data object will be created.
	depth	gives the number of components for each spatial location in the array.
	ghosts	const IntVector reference indicating the width of the ghost cell region around the box over which the node data will be allocated.
	pool	memory arena. If not given, then the standard arena is used.

template<int DIM, class TYPE>

SAMRAI::pdat::CellData< DIM, TYPE >::~CellData ( ) [virtual]

The virtual destructor for a cell data object.

Member Function Documentation

template<int DIM, class TYPE>

size_t SAMRAI::pdat::CellData< DIM, TYPE >::getSizeOfData	(	const hier::Box< DIM > &	box,
		int	depth,
		const hier::IntVector< DIM > &	ghosts
	)			`[static]`

Calculate the amount of memory needed to represent cell- centered data over a CELL-centered AMR index space box.

This function assumes that the amount of memory needed for TYPE is sizeof(TYPE). If this is not the case, then a specialized function must be defined.

Parameters:

	box	const Box reference describing the interior of the standard CELL-centered index box over which the cell data object will be created.
	depth	gives the number of components for each spatial location in the array.
	ghosts	const IntVector reference indicating the width of the ghost cell region around the box over which the node data will be allocated.

template<int DIM, class TYPE>

int SAMRAI::pdat::CellData< DIM, TYPE >::getDepth ( ) const [inline]

Return the depth (e.g., the number of components in each spatial location) of the array.

template<int DIM, class TYPE>

TYPE * SAMRAI::pdat::CellData< DIM, TYPE >::getPointer ( int depth = 0 ) [inline]

Get a pointer to the beginning of a depth component of the cell centered array.

template<int DIM, class TYPE>

const TYPE * SAMRAI::pdat::CellData< DIM, TYPE >::getPointer ( int depth = 0 ) const [inline]

Get a const pointer to the beginning of a depth component of the cell centered array.

template<int DIM, class TYPE>

TYPE & SAMRAI::pdat::CellData< DIM, TYPE >::operator()	(	const CellIndex< DIM > &	i,
		int	depth = `0`
	)			`[inline]`

Return reference to cell data entry corresponding to a given cell index and depth.

template<int DIM, class TYPE>

const TYPE & SAMRAI::pdat::CellData< DIM, TYPE >::operator()	(	const CellIndex< DIM > &	i,
		int	depth = `0`
	)			const `[inline]`

Return a const reference to cell data entry corresponding to a given cell index and depth.

template<int DIM, class TYPE>

ArrayData< DIM, TYPE > & SAMRAI::pdat::CellData< DIM, TYPE >::getArrayData ( ) [inline]

Return a reference to the array data object for the cell centered data object.

template<int DIM, class TYPE>

const ArrayData< DIM, TYPE > & SAMRAI::pdat::CellData< DIM, TYPE >::getArrayData ( ) const [inline]

Return a const reference to the array data object for the cell centered data object.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copy ( const hier::PatchData< DIM > & src ) [virtual]

A fast copy from source to destination (i.e., this) patch data object.

Data is copied where there is overlap in the underlying index space. The copy is performed on the interior plus the ghost cell width (for both the source and destination). Currently, source data must be CellData of the same DIM and TYPE. If not, then an unrecoverable error results.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copy2 ( hier::PatchData< DIM > & dst ) const [virtual]

A fast copy from source (i.e., this) to destination patch data object.

Data is copied where there is overlap in the underlying index space. The copy is performed on the interior plus the ghost cell width (for both the source and destination). Currently, destination data must be CellData of the same DIM and TYPE. If not, then an unrecoverable error results.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copy	(	const hier::PatchData< DIM > &	src,
		const hier::BoxOverlap< DIM > &	overlap
	)			`[virtual]`

Copy data from source to destination (i.e., this) patch data object on the given overlap.

Currently, source data must be CellData of the same DIM and TYPE and the overlap must be a CellOverlap of the same DIM. If not, then an unrecoverable error results.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copy2	(	hier::PatchData< DIM > &	dst,
		const hier::BoxOverlap< DIM > &	overlap
	)			const `[virtual]`

Copy data from source (i.e., this) to destination patch data object on the given overlap.

Currently, destination data must be CellData of the same DIM and TYPE and the overlap must be a CellOverlap of the same DIM. If not, then an unrecoverable error results.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copyOnBox	(	const CellData< DIM, TYPE > &	src,
		const hier::Box< DIM > &	box
	)			`[inline]`

Copy data from source to destination (i.e., this) patch data object on the given CELL-centered AMR index box.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::copyDepth	(	int	dst_depth,
		const CellData< DIM, TYPE > &	src,
		int	src_depth
	)			`[virtual]`

Fast copy (i.e., source and this cell data objects are defined over the same box) to this destination cell data object from the given source cell data object at the specified depths.

template<int DIM, class TYPE>

bool SAMRAI::pdat::CellData< DIM, TYPE >::canEstimateStreamSizeFromBox ( ) const [virtual]

Return true if the patch data object can estimate the stream size required to fit its data using only index space information (i.e., a box).

This routine is defined for the standard types (bool, char, double, float, int, and dcomplex).

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

int SAMRAI::pdat::CellData< DIM, TYPE >::getDataStreamSize ( const hier::BoxOverlap< DIM > & overlap ) const [virtual]

Return the number of bytes needed to stream the data in this patch data object lying in the specified box overlap region.

This routine is defined for the standard types (bool, char, double, float, int, and dcomplex).

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::packStream	(	tbox::AbstractStream &	stream,
		const hier::BoxOverlap< DIM > &	overlap
	)			const `[virtual]`

Unpack data from stream into this patch data object over the specified box overlap region. The overlap must be a CellOverlap of the same DIM.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::unpackStream	(	tbox::AbstractStream &	stream,
		const hier::BoxOverlap< DIM > &	overlap
	)			`[virtual]`

Unpack data from stream into this patch data object over the specified box overlap region. The overlap must be a CellOverlap of the same DIM.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::fill	(	const TYPE &	t,
		int	d = `0`
	)			`[inline]`

Fill all values at depth d with the value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::fill	(	const TYPE &	t,
		const hier::Box< DIM > &	box,
		int	d = `0`
	)			`[inline]`

Fill all values at depth d within the box with the value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::fillAll ( const TYPE & t ) [inline]

Fill all depth components with value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::fillAll	(	const TYPE &	t,
		const hier::Box< DIM > &	box
	)			`[inline]`

Fill all depth components within the box with value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::print	(	const hier::Box< DIM > &	box,
		std::ostream &	os = `tbox::plog`,
		int	prec = `12`
	)			const

Print all cell data values residing in the specified box. If the depth of the array is greater than one, all depths are printed.

Parameters:

	box	const reference to box over whioch to print data. Note box is assumed to reside in standard cell-centered index space and will be converted to cell index space.
	os	reference to output stream.
	prec	integer precision for printing floating point numbers (i.e., TYPE = float, double, or dcomplex). The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this value is ignored.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::print	(	const hier::Box< DIM > &	box,
		int	depth,
		std::ostream &	os = `tbox::plog`,
		int	prec = `12`
	)			const

Print all cell data values at the given array depth in the specified box.

Parameters:

	box	const reference to box over whioch to print data. Note box is assumed to reside in standard cell-centered index space and will be converted to cell index space.
	depth	integer depth component, must satisfy 0 <= depth < actual depth of data array
	os	reference to output stream.
	prec	integer precision for printing floating point numbers (i.e., TYPE = float, double, or dcomplex). The default is 12 decimal places for double and complex floating point numbers, and the default is 6 decimal places floats. For other types, this value is ignored.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::getSpecializedFromDatabase ( tbox::Pointer< tbox::Database > database ) [virtual]

Check that class version and restart file version are equal. If so, read data members from the database.

Assertions: database must be a non-null pointer.

Implements SAMRAI::hier::PatchData< DIM >.

template<int DIM, class TYPE>

void SAMRAI::pdat::CellData< DIM, TYPE >::putSpecializedToDatabase ( tbox::Pointer< tbox::Database > database ) [virtual]

Write out the class version number and other data members to the database.

Assertions: database must be a non-null pointer.

Implements SAMRAI::hier::PatchData< DIM >.

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

source/patchdata/cell/CellData.h
source/patchdata/cell/CellData.C
source/patchdata/cell/CellData.I

Generated on Thu Jun 18 11:28:44 2009 for SAMRAI by

1.5.1

SAMRAI::pdat::CellData< DIM, TYPE > Class Template Reference

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

template<int DIM, class TYPE> class SAMRAI::pdat::CellData< DIM, TYPE >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<int DIM, class TYPE>
class SAMRAI::pdat::CellData< DIM, TYPE >