SAMRAI::pdat::CellOverlap< DIM > Class Template Reference

#include <source/patchdata/boxgeometry/CellOverlap.h>

Inheritance diagram for SAMRAI::pdat::CellOverlap< DIM >:


Public Member Functions
	CellOverlap (const hier::BoxList< DIM > &boxes, const hier::IntVector< DIM > &src_offset)
virtual	~CellOverlap ()
virtual bool	isOverlapEmpty () const
virtual const hier::BoxList< DIM > &	getDestinationBoxList () const
virtual const hier::IntVector< DIM > &	getSourceOffset () const
virtual void	print (std::ostream &os) const

Detailed Description

template<int DIM>
class SAMRAI::pdat::CellOverlap< DIM >

Class CellOverlap<DIM> represents the intersection between two cell centered geometry boxes. It is a subclass of hier::BoxOverlap<DIM> and records the portions of index space that needs to be copied between two objects with cell centered geometry. Note that CellOverlap does NOT compute the overlap of the arguments. It stores the arguments as given and assumes that they already represent an overlap previously computed.

See also:: hier::BoxOverlap
pdat::CellOverlap

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::CellOverlap< DIM >::CellOverlap	(	const hier::BoxList< DIM > &	boxes,
		const hier::IntVector< DIM > &	src_offset
	)

The constructor takes the list of boxes and the source offset between the source and destination index spaces. This information is used later in the generation of communication schedules.

template<int DIM>

SAMRAI::pdat::CellOverlap< DIM >::~CellOverlap ( ) [virtual]

The virtual destructor does nothing interesting except deallocate box data.

Member Function Documentation

template<int DIM>

bool SAMRAI::pdat::CellOverlap< DIM >::isOverlapEmpty ( ) const [virtual]

Return whether there is an empty intersection between the two cell centered boxes. This method over-rides the virtual function in the hier::BoxOverlap<DIM> base class.

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

template<int DIM>

const hier::BoxList< DIM > & SAMRAI::pdat::CellOverlap< DIM >::getDestinationBoxList ( ) const [inline, virtual]

Return the list of boxes (in cell centered index space) that constitute the intersection. The boxes are given in the destination coordinate space and must be shifted by -(getSourceOffset()) to lie in the source index space.

template<int DIM>

const hier::IntVector< DIM > & SAMRAI::pdat::CellOverlap< DIM >::getSourceOffset ( ) const [inline, virtual]

Return the offset between the destination and source index spaces. The destination index space is the source index space shifted by this amount.

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

template<int DIM>

void SAMRAI::pdat::CellOverlap< DIM >::print ( std::ostream & os ) const [virtual]