SAMRAI::pdat::OuterfaceVariable< DIM, TYPE > Class Template Reference

#include <source/patchdata/outerface/OuterfaceVariable.h>

Inheritance diagram for SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >:

[legend]List of all members.

Public Member Functions
	OuterfaceVariable (const string &name, int depth=1)
virtual	~OuterfaceVariable ()
bool	fineBoundaryRepresentsVariable () const
bool	dataLivesOnPatchBorder () const

---

Detailed Description

template<int DIM, class TYPE>
class SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >

Class OuterfaceVariable<DIM> is a templated variable class used to define face-centered quantities on an AMR mesh. It is templated on the type of the underlying data (e.g., double, int, bool, etc.). Outerface variable data is associated with the faces (or sides) of cells. However, it differs from the FaceVariable<DIM> class in that outerface quantities reside only on the faces residing on the boundary of a patch. Outerface data is stored in DIM arrays, each of which holds values for faces having the same outward normal vector. For example, a three-dimensional outerface variable can be used to create face-centered data arrays over a box [l0:u0,l1:u1,l2:u2] that can be dimensioned as:

     [ l1 : u1 ,
       l2 : u2 , d ]   ,

     [ l2 : u2 ,
       l0 : u0 , d ]   ,

     [ l0 : u0 ,
       l1 : u1 , d ]   ,

 * 

for the upper and lower x, y, and z (or 0, 1, 2) face directions, respectively, and where d is the depth index (i.e., number of values at each face index location). Note that the array orderings are permuted to match the conventions of the FaceVariable<DIM> class. One- and two- dimensional outerface variables define storage similarly. For more information on indexing and manipulating outerface patch data objects, see the classes OuterfaceData<DIM> and OuterfaceGeometry<DIM>.

IMPORTANT: The class OutersideVariable<DIM> and associated classes define the same storage as this outerface variable class, except that the indices are not permuted in the outerside data type. Also, outerface and outerside data classes are intended to interact with their face-centered and side-centered data counterparts, respectively. Mixing types, while allowed, is discouraged to prevent undesirable behavior.

See also:

pdat::FaceData

pdat::OuterfaceData

pdat::OuterfaceDataFactory

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE> SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >::OuterfaceVariable (  const string &  name, int  depth = 1 )

Create an outerface variable object having properties specified by the name and depth (i.e., number of data values at each index location). The default depth is one. The ghost cell width for all outerface data is currently fixed at zero; this may be changed in the future if needed.

template<int DIM, class TYPE> SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >::~OuterfaceVariable (   )  [virtual]

Virtual destructor for outerface variable objects.

---

Member Function Documentation

template<int DIM, class TYPE> bool SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >::fineBoundaryRepresentsVariable (   )  const [inline, virtual]

Return a boolean true value indicating that fine patch values take precedence on coarse-fine interfaces. Implements SAMRAI::hier::Variable< DIM >.

template<int DIM, class TYPE> bool SAMRAI::pdat::OuterfaceVariable< DIM, TYPE >::dataLivesOnPatchBorder (   )  const [inline, virtual]

Return true since the face data index space (and hence the outerface data index space) extends beyond the interior of patches. That is, outerface data lives on patch borders. Implements SAMRAI::hier::Variable< DIM >.

---

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

• source/patchdata/outerface/OuterfaceVariable.h
• source/patchdata/outerface/OuterfaceVariable.C

---