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

#include <source/patchdata/side/SideVariable.h>

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

[legend]List of all members.

Public Member Functions
	SideVariable (const std::string &name, int depth=1, bool fine_boundary_represents_var=true, int direction=-1)
	Create an side-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	~SideVariable ()
	Virtual destructor for side variable objects.
const hier::IntVector< DIM > &	getDirectionVector () const
	Return constant reference to vector describing which coordinate directions have data associated with this side variable object.
bool	fineBoundaryRepresentsVariable () const
	Return boolean indicating which side 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 side data on a patch interior exists on the patch boundary.

---

Detailed Description

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

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

Note that it is possible to create a side data object for managing data at cell sides associated with a single coordinate direction only. See the constructor for more information.

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

See also:

pdat::SideData

pdat::SideDataFactory

pdat::SideGeometry

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create an side-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.

The default data allocation scheme is that side data will be allocated for all side normal coordinate directions. If this is desired, then the direction argument may be omitted. If an integer direction argument is specified, the only data for the given side normal direction will be maintained and managed for this variable.

template<int DIM, class TYPE>

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

(

)

[virtual]

Virtual destructor for side variable objects.

---

Member Function Documentation

template<int DIM, class TYPE>

const hier::IntVector< DIM > & SAMRAI::pdat::SideVariable< DIM, TYPE >::getDirectionVector

(

)

const

Return constant reference to vector describing which coordinate directions have data associated with this side variable object.

A vector entry of zero indicates that there is no data array allocated for the corresponding coordinate direction for side data created via this side variable object. A non-zero value indicates that a valid data array will be allocated for that coordinate direction.

template<int DIM, class TYPE>

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

(

)

const [inline, virtual]

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

(

)

const [inline, virtual]

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

---