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

#include <EdgeOverlap.h>

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

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

Private Attributes
bool	d_is_overlap_empty
hier::IntVector< DIM >	d_offset
hier::BoxList< DIM >	d_dst_boxes [DIM]

Detailed Description

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

Class EdgeOverlap<DIM> represents the intersection between two edge 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 edge centered geometry.

See also

hier::BoxOverlap

pdat::EdgeOverlap

Constructor & Destructor Documentation

EdgeOverlap()

template<int DIM>

SAMRAI::pdat::EdgeOverlap< DIM >::EdgeOverlap	(	const hier::BoxList< DIM >	boxes[DIM],
		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.

~EdgeOverlap()

template<int DIM>

virtual SAMRAI::pdat::EdgeOverlap< DIM >::~EdgeOverlap ( )

virtual

The virtual destructor does nothing interesting except deallocate box data.

Member Function Documentation

isOverlapEmpty()

template<int DIM>

virtual bool SAMRAI::pdat::EdgeOverlap< DIM >::isOverlapEmpty ( ) const

virtual

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

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

getDestinationBoxList()

template<int DIM>

virtual const hier::BoxList<DIM>& SAMRAI::pdat::EdgeOverlap< DIM >::getDestinationBoxList ( const int  axis ) const

virtual

Return the list of boxes (in edge 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. The axis argument represents which axis is desired: X=0, Y=1, and Z=2. This method over-rides the virtual function in the hier::BoxOverlap<DIM> base class.

getSourceOffset()

template<int DIM>

virtual const hier::IntVector<DIM>& SAMRAI::pdat::EdgeOverlap< DIM >::getSourceOffset ( ) const

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 >.

print()

template<int DIM>

virtual void SAMRAI::hier::BoxOverlap< DIM >::print ( std::ostream &  os ) const

virtualinherited

Output the box overlap.

Reimplemented in SAMRAI::pdat::CellOverlap< DIM >.

Member Data Documentation

d_is_overlap_empty

template<int DIM>

bool SAMRAI::pdat::EdgeOverlap< DIM >::d_is_overlap_empty

private

d_offset

template<int DIM>

hier::IntVector<DIM> SAMRAI::pdat::EdgeOverlap< DIM >::d_offset

private

d_dst_boxes

template<int DIM>

hier::BoxList<DIM> SAMRAI::pdat::EdgeOverlap< DIM >::d_dst_boxes[DIM]

private

---

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

• /samrai/include/EdgeOverlap.h