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

#include <source/patchdata/face/FaceVariable.h>

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

[legend]List of all members.

Public Member Functions
	FaceVariable (const std::string &name, int depth=1, bool fine_boundary_represents_var=true)
	Create an face-centered variable object with the given name and depth (i.e., number of data values at each edge index location). A default depth of one is provided. The fine boundary representation boolean argument indicates which values (either coarse or fine) take precedence at coarse-fine mesh boundaries during coarsen and refine operations. The default is that fine data values take precedence on coarse-fine interfaces.
virtual	~FaceVariable ()
	Virtual destructor for face variable objects.
bool	fineBoundaryRepresentsVariable () const
	Return boolean indicating which face data values (coarse or fine) take precedence at coarse-fine mesh interfaces. The value is set in the constructor.
bool	dataLivesOnPatchBorder () const
	Return true indicating that face data on a patch interior exists on the patch boundary.

---

Detailed Description

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

Class FaceVariable<DIM> is a templated variable class used to define face-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.).

Note that the indices in the face data arrays are permuted so that the leading index in each array corresponds to the associated face normal coordinate direction. See header file for FaceData<DIM> class for a more detailed description of the data layout.

IMPORTANT: The class SideVariable<DIM> and associated "side data" classes define the same storage as this face variable class, except that the individual array indices are not permuted in the side data type.

See also:

pdat::FaceData

pdat::FaceDataFactory

pdat::FaceGeometry

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create an face-centered variable object with the given name and depth (i.e., number of data values at each edge index location). A default depth of one is provided. The fine boundary representation boolean argument indicates which values (either coarse or fine) take precedence at coarse-fine mesh boundaries during coarsen and refine operations. The default is that fine data values take precedence on coarse-fine interfaces.

template<int DIM, class TYPE>

SAMRAI::pdat::FaceVariable< DIM, TYPE >::~FaceVariable

(

)

[virtual]

Virtual destructor for face variable objects.

---

Member Function Documentation

template<int DIM, class TYPE>

bool SAMRAI::pdat::FaceVariable< DIM, TYPE >::fineBoundaryRepresentsVariable

(

)

const [inline, virtual]

Return boolean indicating which face data values (coarse or fine) take precedence at coarse-fine mesh interfaces. The value is set in the constructor.

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

template<int DIM, class TYPE>

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

(

)

const [inline, virtual]

Return true indicating that face data on a patch interior exists on the patch boundary.

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

---

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

• source/patchdata/face/FaceVariable.h
• source/patchdata/face/FaceVariable.C

---