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

#include <source/patchdata/node/NodeVariable.h>

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

[legend]List of all members.

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

---

Detailed Description

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

Class NodeVariable<DIM> is a templated variable class used to define node-centered quantities on an AMR mesh. It is templated on the type of the underlying data (e.g., double, int, bool, etc.). Node variable data is associated with the corners of cells. For example, a three-dimensional node variable can be used to create node-centered data arrays over a box [l0:u0,l1:u1,l2:u2] that can be dimensioned as:

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

 * 

where d is the depth index (i.e., number of values at each cell index location). One- and two-dimensional node variables define storage similarly. For more information on indexing and manipulating node patch data objects, see the classes NodeData<DIM> and NodeGeometry<DIM>.

See also:

pdat::NodeData

pdat::NodeDataFactory

hier::Variable

---

Constructor & Destructor Documentation

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

Create a node variable object having properties specified by the name, depth (i.e., number of data values at each index location), and coarse-fine interface representation. Default arguments are provided for the last two. The default depth is one. The fine boundary representation boolean value indicates which values (either coarse or fine) take precedence during coarsen and refine operations. The default state is that fine data values take precedence on coarse-fine interfaces.

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

Virtual destructor for node variable objects.

---

Member Function Documentation

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

Return a boolean value indicating how data for the node variable will be treated on coarse-fine interfaces. True (default case set in constructor) indicates that fine patch values take precedence. False indicates that values on fine patches at a coarse-fine interface should be interpolated from coarser level values. Implements SAMRAI::hier::Variable< DIM >.

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

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

---

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

• source/patchdata/node/NodeVariable.h
• source/patchdata/node/NodeVariable.C

---