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 <OuteredgeVariable.h>

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

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. More...
virtual	~OuteredgeVariable ()
	Virtual destructor for outeredge variable objects. More...
bool	fineBoundaryRepresentsVariable () const
	Return a boolean true value indicating that fine patch values take precedence on coarse-fine interfaces. More...
bool	dataLivesOnPatchBorder () const
	Return true indicating that outeredge data exists on the patch boundary. More...
int	getInstanceIdentifier () const
const std::string &	getName () const
void	setPatchDataFactory (tbox::Pointer< PatchDataFactory< DIM > > factory)
tbox::Pointer< PatchDataFactory< DIM > >	getPatchDataFactory () const

Static Public Member Functions
static int	getCurrentMaximumInstanceNumber ()

Private Member Functions
	OuteredgeVariable (const OuteredgeVariable< DIM, TYPE > &)
void	operator= (const OuteredgeVariable< DIM, TYPE > &)

Private Attributes
std::string	d_name
int	d_instance
tbox::Pointer< PatchDataFactory< DIM > >	d_factory

Static Private Attributes
static int	s_instance_counter

Detailed Description

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

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

OuteredgeVariable() [1/2]

template<int DIM, class TYPE >

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

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

~OuteredgeVariable()

template<int DIM, class TYPE >

virtual SAMRAI::pdat::OuteredgeVariable< DIM, TYPE >::~OuteredgeVariable ( )

virtual

OuteredgeVariable() [2/2]

template<int DIM, class TYPE >

SAMRAI::pdat::OuteredgeVariable< DIM, TYPE >::OuteredgeVariable ( const OuteredgeVariable< DIM, TYPE > &  )

private

Member Function Documentation

fineBoundaryRepresentsVariable()

template<int DIM, class TYPE >

bool SAMRAI::pdat::OuteredgeVariable< DIM, TYPE >::fineBoundaryRepresentsVariable ( ) const

inlinevirtual

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

dataLivesOnPatchBorder()

template<int DIM, class TYPE >

bool SAMRAI::pdat::OuteredgeVariable< DIM, TYPE >::dataLivesOnPatchBorder ( ) const

inlinevirtual

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

operator=()

template<int DIM, class TYPE >

void SAMRAI::pdat::OuteredgeVariable< DIM, TYPE >::operator= ( const OuteredgeVariable< DIM, TYPE > &  )

private

getCurrentMaximumInstanceNumber()

template<int DIM>

static int SAMRAI::hier::Variable< DIM >::getCurrentMaximumInstanceNumber ( )

staticinherited

Return the current maximum instance number over all variable objects. The instance identifier returned from each variable objhect is guaranteed to be between 0 and this number minus one. Note that this number changes as new variable instances are created.

getInstanceIdentifier()

template<int DIM>

int SAMRAI::hier::Variable< DIM >::getInstanceIdentifier ( ) const

inherited

Return the instance identifier for this particular variable object. The instance identifiers are unique integers numbered starting from zero.

getName()

template<int DIM>

const std::string& SAMRAI::hier::Variable< DIM >::getName ( ) const

inherited

Return the name assigned to this variable.

setPatchDataFactory()

template<int DIM>

void SAMRAI::hier::Variable< DIM >::setPatchDataFactory ( tbox::Pointer< PatchDataFactory< DIM > >  factory )

inherited

Set the patch data factory object. Normally, the factory is set in the constructor, but this member function enables the factory to be changed later in the lifetime of the variable.

getPatchDataFactory()

template<int DIM>

tbox::Pointer< PatchDataFactory<DIM> > SAMRAI::hier::Variable< DIM >::getPatchDataFactory ( ) const

inherited

Return a non-const pointer to a patch data factory that will be used to instantiate instances of this variable on the patches. The factory returned will have been set by the variable subclasses.

Member Data Documentation

d_name

template<int DIM>

std::string SAMRAI::hier::Variable< DIM >::d_name

privateinherited

d_instance

template<int DIM>

int SAMRAI::hier::Variable< DIM >::d_instance

privateinherited

d_factory

template<int DIM>

tbox::Pointer< PatchDataFactory<DIM> > SAMRAI::hier::Variable< DIM >::d_factory

privateinherited

s_instance_counter

template<int DIM>

int SAMRAI::hier::Variable< DIM >::s_instance_counter

staticprivateinherited

---

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

• /samrai/include/OuteredgeVariable.h