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

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

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

[legend]List of all members.

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

---

Detailed Description

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

Class NodeGeometry<DIM> manages the mapping between the AMR index space and the node-centered geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between node- centered box geometries. That is, node geometry objects calculate the node-centered data residing in the intersection of two boxes defining regions of index space on an AMR patch hierarchy. For example, given a three-dimensional box [l0:u0,l1:u1,l2:u2], the indices for a three-dimensional node data object run as follows:

      [l0:u0+1,l1:u1+1,l2:u2+1]

 * 

Note that the intersection between two node-centered boxes can be complicated since node geometries contain indices on the nodes of the boxes. Thus, there may be overlap between two boxes, even though the boxes do not intersect in the AMR index space.

See also:

hier::BoxGeometry

pdat::NodeOverlap

---

Constructor & Destructor Documentation

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

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

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

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::NodeGeometry< 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 box geometry and the destination box geometry. Refer to the box geometry class for a detailed description of calculateOverlap().

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

Return the box extents for this node centered box geometry object.

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

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

template<int DIM> hier::Box< DIM > SAMRAI::pdat::NodeGeometry< DIM >::toNodeBox (  const hier::Box< DIM > &  box  )  [inline, static]

Convert an AMR abstract box into a node geometry box. The lower index is the same, but the upper index is one greater in each dimension.

---

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

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

---