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 std::string &name, int depth=1)
	Create a cell-centered variable object with the given name and depth (i.e., number of data values at each cell index location). A default depth of one is provided.
virtual	~CellVariable ()
	Virtual destructor for cell variable objects.
bool	fineBoundaryRepresentsVariable () const
	Return true indicating that cell data quantities will always be treated as though fine values take precedence 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. However, some value must be supplied for communication operations.
bool	dataLivesOnPatchBorder () const
	Return false indicating that cell data on a patch interior does not exist on the patch boundary.

---

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 a subclass of hier::Variable and is templated on the type of the underlying data (e.g., double, int, bool, etc.).

See header file for CellData<DIM> class for a more detailed description of the data layout.

See also:

pdat::CellData

pdat::CellDataFactory

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create a cell-centered variable object with the given name and depth (i.e., number of data values at each cell 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 indicating that cell data quantities will always be treated as though fine values take precedence 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. However, some value must be supplied for communication operations.

Implements SAMRAI::hier::Variable< DIM >.

template<int DIM, class TYPE>

bool SAMRAI::pdat::CellVariable< DIM, TYPE >::dataLivesOnPatchBorder

(

)

const [inline, virtual]

Return false indicating that cell data on a patch interior does not exist on the patch boundary.

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

---