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

Class OuteredgeVariable<DIM> is a templated variable class used to define edge-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/outeredge/OuteredgeVariable.h>

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

[legend]List of all members.

Public Member Functions
	OuteredgeVariable (const std::string &name, int depth=1)
	Create an outeredge 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	~OuteredgeVariable ()
	Virtual destructor for outeredge 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 outeredge data exists on the patch boundary.

---

Detailed Description

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

Class OuteredgeVariable<DIM> is a templated variable class used to define edge-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 outeredge data arrays matches the corresponding array sections provided by the edge data implementation. See header file for the OuteredgeData<DIM> class for a more detailed description of the data layout.

See also:

pdat::EdgeData

pdat::OuteredgeData

pdat::OuteredgeDataFactory

hier::Variable

---

Constructor & Destructor Documentation

template<int DIM, class TYPE>

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

Create an outeredge 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 outeredge data is currently fixed at zero; this may be changed in the future if needed.

template<int DIM, class TYPE>

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

(

)

[virtual]

Virtual destructor for outeredge variable objects.

---

Member Function Documentation

template<int DIM, class TYPE>

bool SAMRAI::pdat::OuteredgeVariable< 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::OuteredgeVariable< DIM, TYPE >::dataLivesOnPatchBorder

(

)

const [inline, virtual]

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

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

---

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

• source/patchdata/outeredge/OuteredgeVariable.h
• source/patchdata/outeredge/OuteredgeVariable.C

---