SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY > Class Template Reference

#include <source/patchdata/index/IndexVariable.h>

Inheritance diagram for SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >:

[legend]List of all members.

Public Member Functions
	IndexVariable (const std::string &name)
virtual	~IndexVariable ()
bool	fineBoundaryRepresentsVariable () const
bool	dataLivesOnPatchBorder () const

---

Detailed Description

template<int DIM, class TYPE, class BOX_GEOMETRY>
class SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >

Class IndexVariable<DIM,TYPE,BOX_GEOMETRY> is a templated variable class used to define quantities that exist on an irregular cell-centered index set. The template parameter TYPE defines the storage at each index location. For example, this class is used to represent embedded boundary features as a regular patch data type using the BoundaryCell class as the template type. The template parameter BOX_GEOMETRY allows IndexVariables to be instantiated with a provided centering and geometry in index space via a BoxGeometry (e.g. CellGeometry, NodeGeometry).

Please consult the README file in the index data source directory for instructions on using this class to provide other irregular index set types.

See also:

pdat::IndexData

pdat::IndexDataFactory

pdat::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE, class BOX_GEOMETRY>

SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >::IndexVariable

(

const std::string &

name

)

Create an index variable object with the specified name.

template<int DIM, class TYPE, class BOX_GEOMETRY>

SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >::~IndexVariable

(

)

[virtual]

Virtual destructor for index variable objects.

---

Member Function Documentation

template<int DIM, class TYPE, class BOX_GEOMETRY>

bool SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >::fineBoundaryRepresentsVariable

(

)

const [inline, virtual]

Return true so that the index data quantities will always be treated as cell- centered quantities as far as communication is concerned. 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, class BOX_GEOMETRY>

bool SAMRAI::pdat::IndexVariable< DIM, TYPE, BOX_GEOMETRY >::dataLivesOnPatchBorder

(

)

const [inline, virtual]

Return false since the index data index space matches the cell-centered index space for AMR patches. Thus, index 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/index/IndexVariable.h
• source/patchdata/index/IndexVariable.C

---