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

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

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

[legend]List of all members.

Public Member Functions
	SideOverlap (const hier::BoxList< DIM > boxes[DIM], const hier::IntVector< DIM > &src_offset)
virtual	~SideOverlap ()
virtual bool	isOverlapEmpty () const
virtual const hier::BoxList< DIM > &	getDestinationBoxList (const int axis) const
virtual const hier::IntVector< DIM > &	getSourceOffset () const

---

Detailed Description

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

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

See also:

hier::BoxOverlap

pdat::SideOverlap

---

Constructor & Destructor Documentation

template<int DIM>

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

template<int DIM>

SAMRAI::pdat::SideOverlap< DIM >::~SideOverlap

(

)

[virtual]

The virtual destructor does nothing interesting except deallocate box data.

---

Member Function Documentation

template<int DIM>

bool SAMRAI::pdat::SideOverlap< DIM >::isOverlapEmpty

(

)

const [virtual]

Return whether there is an empty intersection between the two side 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::SideOverlap< DIM >::getDestinationBoxList

(

const int

axis

)

const [inline, virtual]

Return the list of boxes (in side 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.

template<int DIM>

const hier::IntVector< DIM > & SAMRAI::pdat::SideOverlap< 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 >.

---

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

• source/patchdata/boxgeometry/SideOverlap.h
• source/patchdata/boxgeometry/SideOverlap.C
• source/patchdata/boxgeometry/SideOverlap.I

---