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

Manages the mapping between the AMR index space and the outernode-centered geometry index space. More...

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

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

[legend]List of all members.

Public Member Functions
	OuternodeGeometry (const hier::Box< DIM > &box, const hier::IntVector< DIM > &ghosts)
	Construct the outernode geometry object given the box and ghost cell width.
virtual	~OuternodeGeometry ()
	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
	Return a hier::BoxOverlap<DIM> object to describe the overlap in index space between the source outernode geometry object (or a node geometry object) and the destination object (this).
const hier::Box< DIM > &	getBox () const
	Return the box extents for this outernode box geometry object.
const hier::IntVector< DIM > &	getGhosts () const
	Return the ghost cell width for this outernode box geometry object.

---

Detailed Description

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

Manages the mapping between the AMR index space and the outernode-centered geometry index space.

This is a subclass of hier::BoxGeometry<DIM> and it computes intersections between two outernode-centered box geometries or between an outernode geometry and a side box geometry. Outernode data differs from node data in that, given a box, an outernode data object represents node-centered data living only on the boundary of the box. However, for the sides over which outernode data is defined, the outernode 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 outernode data object run as follows:

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

The reduction in some of the index ranges prevent nodes on edges and corners of the box from being repeated by different sides of the box. 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. Outernode data matches this conventions.

See also:

hier::BoxGeometry

pdat::NodeGeometry

pdat::NodeOverlap

---

Constructor & Destructor Documentation

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

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

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

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::OuternodeGeometry< 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]

Return a hier::BoxOverlap<DIM> object to describe the overlap in index space between the source outernode geometry object (or a node 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::OuternodeGeometry< DIM >::getBox (   )  const [inline]

Return the box extents for this outernode box geometry object.

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

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

---

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

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

---