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

#include <NodeOverlap.h>

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

Public Member Functions
	NodeOverlap (const hier::BoxList< DIM > &boxes, const hier::IntVector< DIM > &src_offset)
virtual	~NodeOverlap ()
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

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

Detailed Description

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

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

See also

hier::BoxOverlap

pdat::NodeOverlap

Constructor & Destructor Documentation

NodeOverlap()

template<int DIM>

SAMRAI::pdat::NodeOverlap< DIM >::NodeOverlap	(	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.

~NodeOverlap()

template<int DIM>

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

virtual

The virtual destructor does nothing interesting except deallocate box data.

Member Function Documentation

isOverlapEmpty()

template<int DIM>

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

virtual

Return whether there is an empty intersection between the two node 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::NodeOverlap< DIM >::getDestinationBoxList ( ) const

virtual

Return the list of boxes (in node 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. 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::NodeOverlap< DIM >::getSourceOffset ( ) const

virtual

Return the offset between the destination and source index spaces. The destination index space is the source index spaced 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::NodeOverlap< DIM >::d_is_overlap_empty

private

d_offset

template<int DIM>

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

private

d_dst_boxes

template<int DIM>

hier::BoxList<DIM> SAMRAI::pdat::NodeOverlap< DIM >::d_dst_boxes

private

---

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

• /samrai/include/NodeOverlap.h