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

#include <source/patchdata/cell/CellVariable.h>

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

[legend]List of all members.

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

---

Detailed Description

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

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

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

 * 

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

See also:

pdat::CellData

pdat::CellDataFactory

hier::Variable

---

Constructor & Destructor Documentation

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

Create a cell variable object having properties specified by the name and depth (i.e., number of data values at each index location). A default depth of one is provided.

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

Virtual destructor for cell variable objects.

---

Member Function Documentation

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

Return true so that the cell data quantities will always be treated as though fine values represent them on coarse-fine interfaces. Note that this is really artificial since the cell data index space matches the cell-centered index space for AMR patches. Thus, cell data does not live on patch borders and so there is no ambiguity reagrding coarse-fine interface values. Implements SAMRAI::hier::Variable< DIM >.

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

Return false since the cell data index space matches the cell-centered index space for AMR patches. Thus, cell data does not live on patch borders. Implements SAMRAI::hier::Variable< DIM >.

---

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

• source/patchdata/cell/CellVariable.h
• source/patchdata/cell/CellVariable.C

---