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

Class OutersideVariable<DIM> is a templated variable class used to define side-centered data quantities only on patch boundaries. It is a subclass of hier::Variable and is templated on the type of the underlying data (e.g., double, int, bool, etc.). More...

#include <source/patchdata/outerside/OutersideVariable.h>

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

[legend]List of all members.

Public Member Functions
	OutersideVariable (const std::string &name, int depth=1)
	Create an outerside variable object having properties specified by the name and depth (i.e., number of data values at each index location). The default depth is one.
virtual	~OutersideVariable ()
	Virtual destructor for outerside variable objects.
bool	fineBoundaryRepresentsVariable () const
	Return a boolean true value indicating that fine patch values take precedence on coarse-fine interfaces.
bool	dataLivesOnPatchBorder () const
	Return true indicating that outerside data exists on the patch boundary.

---

Detailed Description

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

Class OutersideVariable<DIM> is a templated variable class used to define side-centered data quantities only on patch boundaries. 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 data layout in the outerside data arrays matches the corresponding array sections provided by the side data implementation. See header file for the OutersideData<DIM> class for a more detailed description of the data layout.

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

See also:

pdat::SideData

pdat::OutersideData

pdat::OutersideDataFactory

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create an outerside variable object having properties specified by the name and depth (i.e., number of data values at each index location). The default depth is one.

Note that The ghost cell width for all outerside data is currently fixed at zero; this may be changed in the future if needed.

template<int DIM, class TYPE>

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

(

)

[virtual]

Virtual destructor for outerside variable objects.

---

Member Function Documentation

template<int DIM, class TYPE>

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

(

)

const [inline, virtual]

Return a boolean true value indicating that fine patch values take precedence on coarse-fine interfaces.

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

template<int DIM, class TYPE>

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

(

)

const [inline, virtual]

Return true indicating that outerside data exists on the patch boundary.

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

---

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

• source/patchdata/outerside/OutersideVariable.h
• source/patchdata/outerside/OutersideVariable.C

---