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

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

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

[legend]List of all members.

Public Member Functions
	OutersideGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts)
virtual	~OutersideGeometry ()
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
const hier::Box< DIM > &	getBox () const
const hier::IntVector< DIM > &	getGhosts () const

---

Detailed Description

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

Class OutersideGeometry<DIM> manages the mapping between the AMR index space and the outerside-centered geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between two outerside-centered box geometries or between an outerside geometry and a side box geometry. Outerside data differs from side data in that, given a box, an outerside data object represents side-centered data living only on the boundary of the box. However, for the sides over which outerside data is defined, the outerside geometry index space is the same as the side geometry index space. For example, given a three-dimensional box [l0:u0,l1:u1,l2:u2], the indices for a three-dimensional outerside data object run as follows:

• X sides (lower and upper) [l1:u1,l2:u2]
• Y sides (lower and upper) [l0:u0,l2:u2]
• Z sides (lower and upper) [l0:u0,l1:u1]

Recall that side data is defined so that the sides associated with a given coordinate direction are those whose normal vector lies in that direction. Outerside data matches this conventions.

See also:

hier::BoxGeometry

pdat::SideGeometry

pdat::SideOverlap

---

Constructor & Destructor Documentation

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

Construct the outerside geometry object given the box and ghost cell width.

template<int DIM> SAMRAI::pdat::OutersideGeometry< DIM >::~OutersideGeometry (   )  [virtual]

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::OutersideGeometry< 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 index space between the source outerside geometry object (or a side geometry object) and the destination object (this). Refer to the box geometry class for a detailed description of calculateOverlap().

template<int DIM> const hier::Box< DIM > & SAMRAI::pdat::OutersideGeometry< DIM >::getBox (   )  const [inline]

Return the box extents for this outerside box geometry object.

template<int DIM> const hier::IntVector< DIM > & SAMRAI::pdat::OutersideGeometry< DIM >::getGhosts (   )  const [inline]

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

---

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

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

---