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

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

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

[legend]List of all members.

Public Types
typedef SideOverlap< DIM >	Overlap
Public Member Functions
	SideGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts, const hier::IntVector< DIM > &directions)
	Construct the side geometry object given an AMR index space box, ghost cell width and directions vector indicating which coordinate directions are allocated.
virtual	~SideGeometry ()
	The virtual destructor does nothing interesting.
virtual tbox::Pointer< hier::BoxOverlap< DIM > >	calculateOverlap (const hier::BoxGeometry< DIM > &dst_geometry, const hier::BoxGeometry< DIM > &src_geometry, const hier::Box< DIM > &src_mask, const bool overwrite_interior, const hier::IntVector< DIM > &src_offset, const bool retry) const
	Compute the overlap in side-centered index space between the source box geometry and the destination box geometry.
const hier::Box< DIM > &	getBox () const
	Return the box for this side centered box geometry object.
const hier::IntVector< DIM > &	getGhosts () const
	Return the ghost cell width for this side centered box geometry object.
const hier::IntVector< DIM > &	getDirectionVector () const
Static Public Member Functions
static hier::Box< DIM >	toSideBox (const hier::Box< DIM > &box, int side_normal)
	Convert an AMR index box space box into an side geometry box. An side geometry box extends the given AMR index box space box by one in upper dimension for the side normal coordinate direction.

---

Detailed Description

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

Class SideGeometry<DIM> manages the mapping between the AMR index space and the side-centered geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between side- centered box geometries for communication operations.

See header file for SideData<DIM> class for a more detailed description of the data layout.

See also:

hier::BoxGeometry

pdat::SideOverlap

---

Member Typedef Documentation

template<int DIM>

typedef SideOverlap<DIM> SAMRAI::pdat::SideGeometry< DIM >::Overlap

The BoxOverlap implemenation for this geometry.

---

Constructor & Destructor Documentation

template<int DIM>

SAMRAI::pdat::SideGeometry< DIM >::SideGeometry	(	const hier::Box< DIM > &	box,
		const hier::IntVector< DIM > &	ghosts,
		const hier::IntVector< DIM > &	directions
	)

Construct the side geometry object given an AMR index space box, ghost cell width and directions vector indicating which coordinate directions are allocated.

template<int DIM>

SAMRAI::pdat::SideGeometry< DIM >::~SideGeometry

(

)

[virtual]

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

hier::Box< DIM > SAMRAI::pdat::SideGeometry< DIM >::toSideBox	(	const hier::Box< DIM > &	box,
		int	side_normal
	)			[static]

Convert an AMR index box space box into an side geometry box. An side geometry box extends the given AMR index box space box by one in upper dimension for the side normal coordinate direction.

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::SideGeometry< DIM >::calculateOverlap	(	const hier::BoxGeometry< DIM > &	dst_geometry,
		const hier::BoxGeometry< DIM > &	src_geometry,
		const hier::Box< DIM > &	src_mask,
		const bool	overwrite_interior,
		const hier::IntVector< DIM > &	src_offset,
		const bool	retry
	)			const [virtual]

Compute the overlap in side-centered index space between the source box geometry and the destination box geometry.

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

template<int DIM>

const hier::Box< DIM > & SAMRAI::pdat::SideGeometry< DIM >::getBox

(

)

const [inline]

Return the box for this side centered box geometry object.

template<int DIM>

const hier::IntVector< DIM > & SAMRAI::pdat::SideGeometry< DIM >::getGhosts

(

)

const [inline]

Return the ghost cell width for this side centered box geometry object.

template<int DIM>

const hier::IntVector< DIM > & SAMRAI::pdat::SideGeometry< DIM >::getDirectionVector

(

)

const [inline]

Return constant reference to vector describing which coordinate directions managed by this side geometry object.

A vector entry of zero indicates that this object will not perform operations involving the corresponding coordinate direction. A non-zero value indicates otherwise.

---

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

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

---