SAMRAI::xfer::LocallyActiveDataFillBox< DIM > Class Template Reference

#include <source/transfer/datamovers/locally_active/LocallyActiveDataFillBox.h>

List of all members.

Public Member Functions
	LocallyActiveDataFillBox (const hier::Box< DIM > &box, const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &var_data)
	Construct a locally-active fill box with the given box and list of refine items. Note that this object maintains pointers to the given box and refine items only. So, an object of this class becomes unusable if those items are destroyed before this object.
	LocallyActiveDataFillBox (const hier::Box< DIM > &box, const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &var_data)
	Construct a locally-active fill box with the given box and list of coarsen items. Note that this object maintains pointers to the given box and coarsen items only. So, an object of this class becomes unusable if those items are destroyed before this object.
	LocallyActiveDataFillBox (const LocallyActiveDataFillBox< DIM > &fill_box)
virtual	~LocallyActiveDataFillBox ()
const hier::Box< DIM > &	getBox () const
const tbox::List< const typename RefineClasses< DIM >::Data * > &	getActiveRefineVarData () const
const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &	getActiveCoarsenVarData () const
virtual void	printClassData (std::ostream &os) const
void	clearLocallyActiveFillBoxData ()
bool	checkData (const hier::Box< DIM > &box, const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &var_data, std::ostream &os) const
	Check given box and list of refine items for equality with those maintained by this class object. Any encountered inequality will be sent to the given output stream.
bool	checkData (const hier::Box< DIM > &box, const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &var_data, std::ostream &os) const
	Check given box and list of coarsen items for equality with those maintained by this class object. Any encountered inequality will be sent to the given output stream.

---

Detailed Description

template<int DIM>
class SAMRAI::xfer::LocallyActiveDataFillBox< DIM >

Class LocallyActiveDataFillBox is a utility class that is used primarily by the LocallyActiveDataFillBoxSet class for boxlist operations in communication schedules that operate on "locally-active" data; i.e., where each data item may live on a different set of patches. Specifically, this class contains a box and an associated list of either CoarseClass or RefineClass items, but not both. Each constructor accepts such a list. Once an object is constructed, it can only be used to support either refine operations or coarsen operations.

See also:

hier::Box

xfer::CoarsenClasses

xfer::RefineClasses

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::LocallyActiveDataFillBox	(	const hier::Box< DIM > &	box,
		const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &	var_data
	)

Construct a locally-active fill box with the given box and list of refine items. Note that this object maintains pointers to the given box and refine items only. So, an object of this class becomes unusable if those items are destroyed before this object.

Parameters:

	box	Input box.
	var_data	Input list of refine class data pointers.

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::LocallyActiveDataFillBox	(	const hier::Box< DIM > &	box,
		const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &	var_data
	)

Construct a locally-active fill box with the given box and list of coarsen items. Note that this object maintains pointers to the given box and coarsen items only. So, an object of this class becomes unusable if those items are destroyed before this object.

Parameters:

	box	Input box.
	var_data	Input list of coarsen class data pointers.

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::LocallyActiveDataFillBox

(

const LocallyActiveDataFillBox< DIM > &

fill_box

)

Copy constructor to create a new locally-active fill box and copy the information from the argument locally-active fill box.

Parameters:

fill_box

Constant reference to fill box to be copied.

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::~LocallyActiveDataFillBox

(

)

[virtual]

The destructor releases all box and locally-active data storage.

---

Member Function Documentation

template<int DIM>

const hier::Box< DIM > & SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::getBox

(

)

const

Return constant reference to box maintained by this object.

template<int DIM>

const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > & SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::getActiveRefineVarData

(

)

const

Return constant reference to list of refine items maintained by this object.

Note that if this object was created using coarsen item data, an unrecoverable assertion will result.

template<int DIM>

const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > & SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::getActiveCoarsenVarData

(

)

const

Return constant reference to list of coarsen items maintained by this object.

Note that if this object was created using refine item data, an unrecoverable assertion will result.

template<int DIM>

void SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::printClassData

(

std::ostream &

os

)

const [virtual]

Print all class member data for this locally-active fill box object to specified output stream.

template<int DIM>

void SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::clearLocallyActiveFillBoxData

(

)

Clear all class member data for this locally-active fill box object.

template<int DIM>

bool SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::checkData	(	const hier::Box< DIM > &	box,
		const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &	var_data,
		std::ostream &	os
	)			const

Check given box and list of refine items for equality with those maintained by this class object. Any encountered inequality will be sent to the given output stream.

Returns:

Boolean true if equal, false otherwise.

Parameters:

	box	Input box for comparison.
	var_data	Input list of refine items for comparison.
	os	Input ostream for reporting mismatches.

Note that if this object was created using coarsen item data, an unrecoverable assertion will result.

template<int DIM>

bool SAMRAI::xfer::LocallyActiveDataFillBox< DIM >::checkData	(	const hier::Box< DIM > &	box,
		const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &	var_data,
		std::ostream &	os
	)			const

Check given box and list of coarsen items for equality with those maintained by this class object. Any encountered inequality will be sent to the given output stream.

Returns:

Boolean true if equal, false otherwise.

Parameters:

	box	Input box for comparison.
	var_data	Input list of coarsen items for comparison.
	os	Input ostream for reporting mismatches.

Note that if this object was created using refine item data, an unrecoverable assertion will result.

---

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

• source/transfer/datamovers/locally_active/LocallyActiveDataFillBox.h
• source/transfer/datamovers/locally_active/LocallyActiveDataFillBox.C

---