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

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

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

[legend]List of all members.

Public Types
typedef EdgeOverlap< DIM >	Overlap
Public Member Functions
	OuteredgeGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts)
	Construct an outeredge geometry object given an AMR index space box and ghost cell width.
virtual	~OuteredgeGeometry ()
	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 edge-centered index space on the boundaries of the source box geometry and the destination box geometry.
const hier::Box< DIM > &	getBox () const
	Return the box for this outeredge box geometry object.
const hier::IntVector< DIM > &	getGhosts () const
	Return the ghost cell width for this outeredge box geometry object.
Static Public Member Functions
static hier::Box< DIM >	toOuteredgeBox (const hier::Box< DIM > &box, int axis, int face_normal, int side)

---

Detailed Description

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

Class OuteredgeGeometry<DIM> manages the mapping between the AMR index and the outeredge geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between outeredge box geometries and edge or outeredge box geometries for communication operations.

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

See also:

hier::BoxGeometry

pdat::EdgeGeometry

pdat::EdgeOverlap

---

Member Typedef Documentation

template<int DIM>

typedef EdgeOverlap<DIM> SAMRAI::pdat::OuteredgeGeometry< DIM >::Overlap

The BoxOverlap implemenation for this geometry.

---

Constructor & Destructor Documentation

template<int DIM>

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

Construct an outeredge geometry object given an AMR index space box and ghost cell width.

template<int DIM>

SAMRAI::pdat::OuteredgeGeometry< DIM >::~OuteredgeGeometry

(

)

[virtual]

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM>

hier::Box< DIM > SAMRAI::pdat::OuteredgeGeometry< DIM >::toOuteredgeBox	(	const hier::Box< DIM > &	box,
		int	axis,
		int	face_normal,
		int	side
	)			[static]

Convert a given box in the standard cell-centered AMR index space to an outeredge geometry box for the specified axis, face normal, and lower/upper side. See OuteredgeData header file for a detailed description of an outeredge box.

template<int DIM>

tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::OuteredgeGeometry< 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 edge-centered index space on the boundaries of the source box geometry and the destination box geometry.

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

template<int DIM>

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

(

)

const [inline]

Return the box for this outeredge box geometry object.

template<int DIM>

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

(

)

const [inline]

Return the ghost cell width for this outeredge box geometry object.

---

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

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

---