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

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

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

[legend]List of all members.

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

---

Detailed Description

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

Class CellGeometry<DIM> manages the mapping between the AMR index space and the cell-centered geometry index space. It is a subclass of hier::BoxGeometry<DIM> and it computes intersections between cell- centered box geometries. That is, cell geometry objects calculate the cell-centered data residing in the intersection of two boxes defining regions of index space on an AMR patch hierarchy. Since the AMR index space is also cell-centered, cell-centered data storage maps directly onto a cell geometry box with no modifications.

See also:

hier::BoxGeometry

pdat::CellOverlap

---

Constructor & Destructor Documentation

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

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

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

The virtual destructor does nothing interesting.

---

Member Function Documentation

template<int DIM> tbox::Pointer< hier::BoxOverlap< DIM > > SAMRAI::pdat::CellGeometry< 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::CellGeometry< DIM >::getBox (   )  const [inline]

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

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

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

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

Convert an AMR abstract box into a cell 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/CellGeometry.h
• source/patchdata/boxgeometry/CellGeometry.C
• source/patchdata/boxgeometry/CellGeometry.I

---