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

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

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

[legend]List of all members.

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

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

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

Recall that face data is defined so that the faces associated with a given coordinate direction are those whose normal vector lies in that direction. Also, face data indices are permuted so that the leading dimension of each array corresponds to the direction of the faces. Outerface data matches these conventions.

See also:

hier::BoxGeometry

pdat::FaceGeometry

pdat::FaceOverlap

---

Constructor & Destructor Documentation

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

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

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

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::OuterfaceGeometry< 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 outerface geometry object (or a face 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::OuterfaceGeometry< DIM >::getBox (   )  const [inline]

Return the box extents for this outerface box geometry object.

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

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

---

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

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

---