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

Class OutersideData<DIM> provides an implementation for data defined at cell sides (faces) on the boundaries of 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, an outerside data object represents data of some template TYPE and depth on the cell sides (faces) on the boundary of the box. Here, depth indicates the number of data values at each face index location. The OuteredgsideGeometry class provides the translation between the standard SAMRAI cell-centered AMR index space and outerside-centered data. More...

#include <source/patchdata/outerside/OutersideData.h>

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

[legend]List of all members.


Public Member Functions
	OutersideData (const hier::Box< DIM > &box, int depth, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >(NULL))
	Constructor for an outerside data object.
virtual	~OutersideData ()
	Virtual destructor for a outerside data object.
int	getDepth () const
	Return the depth (i.e., the number of data values for each spatial location) of the array.
TYPE *	getPointer (int side_normal, int side, int depth=0)
	Get a pointer to the beginning of a particular side normal, side, and depth component of the outerside centered array.
const TYPE *	getPointer (int side_normal, int side, int depth=0) const
	Get a const pointer to the beginning of a particular side normal, side, and depth component of the outerside centered array.
TYPE &	operator() (const SideIndex< DIM > &i, int side, int depth=0)
	Return a reference to data entry corresponding to a given side index, side location, and depth.
const TYPE &	operator() (const SideIndex< DIM > &i, int side, int depth=0) const
	Return a const reference to data entry corresponding to a given side index, side location, and depth.
ArrayData< DIM, TYPE > &	getArrayData (int side_normal, int side)
	Return a reference to the array data object for side normal and side location of the outerside centered array.
const ArrayData< DIM, TYPE > &	getArrayData (int side_normal, int side) const
	Return a const reference to the array data object for side normal and side location of the outerside centered array.
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	copyDepth (int dst_depth, const SideData< DIM, TYPE > &src, int src_depth)
	Fast copy (i.e., assumes side and outerside data objects are defined over the same box) from the given side source data object to this destination outerside data object at the specified depths.
void	copyDepth2 (int dst_depth, SideData< DIM, TYPE > &dst, int src_depth) const
	Fast copy (i.e., assumes side and outerside data objects are defined over the same box) to the given side destination data object from this source outerside 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
	Pack data in this patch data object lying in the specified box overlap region into the stream. The overlap must be an SideOverlap 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 an SideOverlap 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 outerside 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 outerside data values at the given array depth in the specified box.
void	printAxisSide (int side_normal, int side, const hier::Box< DIM > &box, std::ostream &os=tbox::plog, int prec=12) const
	Print all outerside centered data values for specified side_normal and side location residing in the specified box. If the depth of the data is greater than one, all depths are printed.
void	printAxisSide (int side_normal, int side, const hier::Box< DIM > &box, int depth, std::ostream &os=tbox::plog, int prec=12) const
	Print all outerside centered data values for specified side_normal, side location, and depth residing in the specified box.
virtual void	getSpecializedFromDatabase (tbox::Pointer< tbox::Database > database)
	Check that class version and restart file version are equal. If so, read data members from the database.
virtual void	putSpecializedToDatabase (tbox::Pointer< tbox::Database > database)
	Write out the class version number and other data members to the database.
Static Public Member Functions
static size_t	getSizeOfData (const hier::Box< DIM > &box, int depth)
	Calculate the amount of memory needed to represent outerside- centered data over a CELL-centered AMR index space box.

Detailed Description

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

Outerside data is stored in 2*DIM arrays, each of which contains data associated with side (face) indices normal to a coordinate axis direction and an upper or lower box side (face) in the face normal direction. The data layout in the outerside data arrays matches the corresponding array sections provided by the side data implementation. Also, in each of array, 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 outerside data object created over a CELL-centered AMR index space [l0:u0,l1:u1,l2:u2] allocates six data arrays dimensioned as follows:


   face normal 0:
     lower face      [ l0:l0     , l1:u1     , l2:u2     , d ]
     upper face      [ u0+1:u0+1 , l1:u1     , l2:u2     , d ]

   face normal 1:
     lower face      [ l0:u0     , l1:l1     , l2:u2     , d ]
     upper face      [ l0:u0     , u1+1:u1+1 , l2:u2     , d ]

   face normal 2:
     lower face      [ l0:u0     , l1:u1     , l2:l2     , d ]
     upper face      [ l0:u0     , l1:u1     , u2+1:u2+1 , d ]

 *

Here the face normal directions 0, 1, 2 can be thought of as the x, y, and z face normal directions, respectively, and d is the depth index (i.e., number of values at each face index location). Other spatial dimensions are represented similarly.

The data type TYPE must define a default constructor (that takes no arguments) and also the assignment operator.

IMPORTANT: The OuterfaceData<DIM> class provides the same storage as this outerside data class, except that the coordinate directions of the individual arrays are permuted; i.e., OuterfaceData is consistent with the FaceData implementation.

See also:

pdat::ArrayData

hier::PatchData

pdat::OutersideDataFactory

pdat::OutersideGeometry

pdat::SideIterator

pdat::SideIndex

Constructor & Destructor Documentation

template<int DIM, class TYPE>

SAMRAI::pdat::OutersideData< DIM, TYPE >::OutersideData	(	const hier::Box< DIM > &	box,
		int	depth,
		tbox::Pointer< tbox::Arena >	pool = `tbox::Pointer< tbox::Arena >(NULL)`
	)

Constructor for an outerside data object.

Note: Outerside data always has ghost cell width of zero.

Parameters:

	box	const Box reference describing the interior of the standard CELL-centered index box over which the outerside data object will be created.
	depth	gives the number of data values for each spatial location in the array.
	pool	memory arena. If not given, then the standard arena is used.

template<int DIM, class TYPE>

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

Virtual destructor for a outerside data object.

Member Function Documentation

template<int DIM, class TYPE>

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

Calculate the amount of memory needed to represent outerside- 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 outerside data object will be created. Note: the ghost cell width is assumed to be zero.
	depth	gives the number of data values for each spatial location in the array.

template<int DIM, class TYPE>

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

Return the depth (i.e., the number of data values for each spatial location) of the array.

template<int DIM, class TYPE>

TYPE * SAMRAI::pdat::OutersideData< DIM, TYPE >::getPointer	(	int	side_normal,
		int	side,
		int	depth = `0`
	)			`[inline]`

Get a pointer to the beginning of a particular side normal, side, and depth component of the outerside centered array.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array
	depth	integer depth component, must satisfy 0 <= depth < actual depth of data array

template<int DIM, class TYPE>

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

Get a const pointer to the beginning of a particular side normal, side, and depth component of the outerside centered array.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array
	depth	integer depth component, must satisfy 0 <= depth < actual depth of data array

template<int DIM, class TYPE>

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

Return a reference to data entry corresponding to a given side index, side location, and depth.

Parameters:

	i	const reference to SideIndex, MUST be an index on the outerside of the box.
	side	integer (lower/upper location of outerside data), must satisfy 0 <= side <= 1
	depth	integer depth component, must satisfy 0 <= depth < actual depth of data array

template<int DIM, class TYPE>

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

Return a const reference to data entry corresponding to a given side index, side location, and depth.

Parameters:

	i	const reference to SideIndex, MUST be an index on the outerside of the box.
	side	integer (lower/upper location of outerside data), must satisfy 0 <= side <= 1
	depth	integer depth component, must satisfy 0 <= depth < actual depth of data array

template<int DIM, class TYPE>

ArrayData< DIM, TYPE > & SAMRAI::pdat::OutersideData< DIM, TYPE >::getArrayData	(	int	side_normal,
		int	side
	)			`[inline]`

Return a reference to the array data object for side normal and side location of the outerside centered array.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array

template<int DIM, class TYPE>

const ArrayData< DIM, TYPE > & SAMRAI::pdat::OutersideData< DIM, TYPE >::getArrayData	(	int	side_normal,
		int	side
	)			const `[inline]`

Return a const reference to the array data object for side normal and side location of the outerside centered array.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< 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 SideData 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::OutersideData< 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 SideData 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::OutersideData< 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.

IMPORTANT: this routine is not yet implemented!

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

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< 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 SideData of the same DIM and TYPE and the overlap must be a SideOverlap of the same DIM. If not, then an unrecoverable error results.

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

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< DIM, TYPE >::copyDepth	(	int	dst_depth,
		const SideData< DIM, TYPE > &	src,
		int	src_depth
	)

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

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< DIM, TYPE >::copyDepth2	(	int	dst_depth,
		SideData< DIM, TYPE > &	dst,
		int	src_depth
	)			const

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

template<int DIM, class TYPE>

bool SAMRAI::pdat::OutersideData< 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::OutersideData< 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::OutersideData< DIM, TYPE >::packStream	(	tbox::AbstractStream &	stream,
		const hier::BoxOverlap< DIM > &	overlap
	)			const `[virtual]`

Pack data in this patch data object lying in the specified box overlap region into the stream. The overlap must be an SideOverlap of the same DIM.

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

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< 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 an SideOverlap of the same DIM.

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

template<int DIM, class TYPE>

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

Fill all values at depth d with the value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< DIM, TYPE >::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.

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< DIM, TYPE >::fillAll ( const TYPE & t )

Fill all depth components with value t.

template<int DIM, class TYPE>

void SAMRAI::pdat::OutersideData< DIM, TYPE >::fillAll	(	const TYPE &	t,
		const hier::Box< DIM > &	box
	)

Fill all depth components within the box with value t.

template<int DIM, class TYPE>

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

Print all outerside 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 side 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::OutersideData< DIM, TYPE >::print	(	const hier::Box< DIM > &	box,
		int	depth,
		std::ostream &	os = `tbox::plog`,
		int	prec = `12`
	)			const

Print all outerside 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 side 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::OutersideData< DIM, TYPE >::printAxisSide	(	int	side_normal,
		int	side,
		const hier::Box< DIM > &	box,
		std::ostream &	os = `tbox::plog`,
		int	prec = `12`
	)			const

Print all outerside centered data values for specified side_normal and side location residing in the specified box. If the depth of the data is greater than one, all depths are printed.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array
	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 side 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::OutersideData< DIM, TYPE >::printAxisSide	(	int	side_normal,
		int	side,
		const hier::Box< DIM > &	box,
		int	depth,
		std::ostream &	os = `tbox::plog`,
		int	prec = `12`
	)			const

Print all outerside centered data values for specified side_normal, side location, and depth residing in the specified box.

Parameters:

	side_normal	integer side normal direction for data, must satisfy 0 <= side_normal < DIM
	side	integer lower (0) or upper (1) side of outerside data array
	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 side 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::OutersideData< 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::OutersideData< 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/outerside/OutersideData.h
source/patchdata/outerside/OutersideData.C
source/patchdata/outerside/OutersideData.I

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

1.5.1

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

Public Member Functions

Static Public Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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