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

#include <source/patchdata/edge/EdgeVariable.h>

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

[legend]List of all members.

Public Member Functions
	EdgeVariable (const std::string &name, int depth=1, bool fine_boundary_represents_var=true)
	Create an edge-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	~EdgeVariable ()
	Virtual destructor for edge variable objects.
bool	fineBoundaryRepresentsVariable () const
	Return boolean indicating which edge 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 edge data on a patch interior exists on the patch boundary.

---

Detailed Description

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

Class EdgeVariable<DIM> is a templated variable class used to define edge-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 EdgeData<DIM> class for a more detailed description of the data layout.

See also:

pdat::EdgeData

pdat::EdgeDataFactory

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create an edge-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::EdgeVariable< DIM, TYPE >::~EdgeVariable

(

)

[virtual]

Virtual destructor for edge variable objects.

---

Member Function Documentation

template<int DIM, class TYPE>

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

(

)

const [inline, virtual]

Return boolean indicating which edge 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::EdgeVariable< DIM, TYPE >::dataLivesOnPatchBorder

(

)

const [inline, virtual]

Return true indicating that edge 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/edge/EdgeVariable.h
• source/patchdata/edge/EdgeVariable.C

---