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

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

Inheritance diagram for SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >:

[legend]List of all members.

Public Member Functions
	LocallyActiveDataFillBoxSet (const LocallyActiveDataFillBoxSet< DIM > &fill_box_set)
	Construct a new locally-active fill box set and copy the information from the argument locally-active fill box set.
	LocallyActiveDataFillBoxSet ()
	Default constructor creates a new fill box set with an empty box set and active patch data information initialized to an unusable state. The box and the active patch must be set by calling resetLocallyActiveFillBoxes() or addLocallyActiveFillBox() functions on the constructed object.
virtual	~LocallyActiveDataFillBoxSet ()
void	setTo (const LocallyActiveDataFillBoxSet< DIM > &fill_box_set)
int	getNumberOfBoxes () const
const tbox::List< xfer::LocallyActiveDataFillBox< DIM > > &	getLocallyActiveDataBoxes () const
const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &	getUnionActiveRefineVarData () const
const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &	getUnionActiveCoarsenVarData () const
void	resetLocallyActiveFillBoxes (const hier::Box< DIM > &box, const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &var_data)
void	resetLocallyActiveFillBoxes (const hier::Box< DIM > &box, const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &var_data)
void	addLocallyActiveFillBox (const hier::Box< DIM > &box, const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > &var_data)
void	addLocallyActiveFillBox (const hier::Box< DIM > &box, const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > &var_data)
void	intersectBoxes (const hier::Box< DIM > &box)
void	intersectBoxes (const hier::BoxList< DIM > &boxes)
virtual void	printClassData (std::ostream &os=tbox::plog) const

---

Detailed Description

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

Class LocallyActiveDataFillBoxSet is a utility class that provides "smart" 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. This class is derived from the FillBoxSet class and extends the functionality of that base class for locally-active patch data. Specifically, this box maintains a colleciton of LocallyActiveDataFillBox objects, each of which contains a box and an associated list of either CoarseClass or RefineClass items, but not both.

See also:

xfer::FillBoxSet

xfer::LocallyActiveDataFillBox

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::LocallyActiveDataFillBoxSet

(

const LocallyActiveDataFillBoxSet< DIM > &

fill_box_set

)

Construct a new locally-active fill box set and copy the information from the argument locally-active fill box set.

Parameters:

fill_box_set

Constant reference to fill box set to be copied.

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::LocallyActiveDataFillBoxSet

(

)

Default constructor creates a new fill box set with an empty box set and active patch data information initialized to an unusable state. The box and the active patch must be set by calling resetLocallyActiveFillBoxes() or addLocallyActiveFillBox() functions on the constructed object.

template<int DIM>

SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::~LocallyActiveDataFillBoxSet

(

)

[virtual]

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

---

Member Function Documentation

template<int DIM>

void SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::setTo

(

const LocallyActiveDataFillBoxSet< DIM > &

fill_box_set

)

Clears all existing box and locally-active data information for calling object and sets it to the state of the argument fill box set.

Note that this is essentially the same as an assignment opertor, but this implementation was chosen to avoid warnings with some compilers.

template<int DIM>

int SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::getNumberOfBoxes

(

)

const

Return number of boxes maintained by this locally-active fill box set.

Reimplemented from SAMRAI::xfer::FillBoxSet< DIM >.

template<int DIM>

const tbox::List< xfer::LocallyActiveDataFillBox< DIM > > & SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::getLocallyActiveDataBoxes

(

)

const

Return a const reference to the list of locally-active fill boxes owned by this object.

template<int DIM>

const tbox::List< const typename xfer::RefineClasses< DIM >::Data * > & SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::getUnionActiveRefineVarData

(

)

const

Return const reference to non-redundant list of refine items representing the union of all locally-active fill boxes owned by this object.

Note that if this object manages coarsen item data, an unrecoverable assertion will result.

template<int DIM>

const tbox::List< const typename xfer::CoarsenClasses< DIM >::Data * > & SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::getUnionActiveCoarsenVarData

(

)

const

Return const reference to non-redundant list of coarsen items representing the union of all locally-active fill boxes owned by this object.

Note that if this object manages refine item data, an unrecoverable assertion will result.

template<int DIM>

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

Set box and refine item information for this locally-active fill box set to given arguments.

Parameters:

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

Note that if this object currently manages coarsen item data, an unrecoverable assertion will result.

template<int DIM>

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

Set box and refine item information for this locally-active fill box set to given arguments.

Parameters:

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

Note that if this object currently manages coarsen item data, an unrecoverable assertion will result.

template<int DIM>

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

Add box and refine item information to this locally-active fill box set.

Parameters:

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

Note that if this object currently manages coarsen item data, an unrecoverable assertion will result.

template<int DIM>

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

Add box and coarsen item information to this locally-active fill box set.

Parameters:

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

Note that if this object currently manages refine item data, an unrecoverable assertion will result.

template<int DIM>

void SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::intersectBoxes

(

const hier::Box< DIM > &

box

)

Replace each box in the fill box set with its intersection with the argument box. Empty fill boxes will be removed.

Reimplemented from SAMRAI::xfer::FillBoxSet< DIM >.

template<int DIM>

void SAMRAI::xfer::LocallyActiveDataFillBoxSet< DIM >::intersectBoxes

(

const hier::BoxList< DIM > &

boxes

)

Replace each box in the fill box set with its intersection with the argument boxlist. Empty fill boxes will be removed.

Reimplemented from SAMRAI::xfer::FillBoxSet< DIM >.

template<int DIM>

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

(

std::ostream &

os = tbox::plog

)

const [virtual]

Print all class member data for this locally-active fill box set object to specified output stream (default is plog).

---

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

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

---