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

Class OuternodeVariable<DIM> is a templated variable class used to define node-centered quantities on patch boundaries. More...

#include <source/patchdata/outernode/OuternodeVariable.h>

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

[legend]List of all members.

Public Member Functions
	OuternodeVariable (const string &name, int depth=1)
	Create an outernode 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 outernode data is currently fixed at zero; this may be changed in the future if needed.
virtual	~OuternodeVariable ()
	Virtual destructor for outernode variable objects.
bool	fineBoundaryRepresentsVariable () const
	Return a boolean true value indicating that fine patch values take precedence on coarse-fine interfaces.
bool	dataLivesOnPatchBorder () const

---

Detailed Description

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

Class OuternodeVariable<DIM> is a templated variable class used to define node-centered quantities on patch boundaries.

It is templated on the type of the underlying data (e.g., double, int, bool, etc.). Outernode variable data is associated with the nodes of cells. However, it differs from the NodeVariable<DIM> class in that outernode quantities reside only on the sides residing on the boundary of a patch. Outernode data is stored in 2*DIM arrays, each of which holds values for sides having the same outward normal vector. Where an outernode falls on more than one side (patch edges and corners), the outernode belongs to the higher dimensional direction. For example, a three-dimensional outernode variable can be used to create node-centered data arrays over a box [l0:u0,l1:u1,l2:u2] that can be dimensioned as:

 *
 *    [ l1+1 : u1-1 ,
 *      l2+1 : u2-1 , d ]   ,
 *
 *    [ l0   : u0   ,
 *      l2+1 : u2-1 , 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 side index location). One- and two-dimensional outernode variables define storage similarly. For more information on indexing and manipulating outernode patch data objects, see the classes OuternodeData<DIM> and OuternodeGeometry<DIM>.

See also:

NodeData<DIM>

OuternodeData<DIM>

OuternodeDataFactory<DIM>

hier::Variable<DIM>

---

Constructor & Destructor Documentation

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

Create an outernode 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 outernode data is currently fixed at zero; this may be changed in the future if needed.

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

Virtual destructor for outernode variable objects.

---

Member Function Documentation

template<int DIM, class TYPE> bool SAMRAI::pdat::OuternodeVariable< 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::OuternodeVariable< DIM, TYPE >::dataLivesOnPatchBorder (   )  const [inline, virtual]

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

---

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

• source/patchdata/outernode/OuternodeVariable.h
• source/patchdata/outernode/OuternodeVariable.C

---