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

#include <ibamr/StokesSecondOrderWaveBcCoef.h>

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

Public Member Functions
	CellVariable (const std::string &name, int depth=1)
	Create a cell-centered variable object with the given name and depth (i.e., number of data values at each cell index location). A default depth of one is provided. More...
virtual	~CellVariable ()
	Virtual destructor for cell variable objects. More...
bool	fineBoundaryRepresentsVariable () const
	Return true indicating that cell data quantities will always be treated as though fine values take precedence on coarse-fine interfaces. Note that this is really artificial since the cell data index space matches the cell-centered index space for AMR patches. However, some value must be supplied for communication operations. More...
bool	dataLivesOnPatchBorder () const
	Return false indicating that cell data on a patch interior does not exist 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
	CellVariable (const CellVariable< DIM, TYPE > &)
void	operator= (const CellVariable< 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::CellVariable< DIM, TYPE >

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

See also

pdat::CellData

pdat::CellDataFactory

hier::Variable

Constructor & Destructor Documentation

CellVariable() [1/2]

template<int DIM, class TYPE >

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

~CellVariable()

template<int DIM, class TYPE >

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

virtual

CellVariable() [2/2]

template<int DIM, class TYPE >

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

private

Member Function Documentation

fineBoundaryRepresentsVariable()

template<int DIM, class TYPE >

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

inlinevirtual

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

dataLivesOnPatchBorder()

template<int DIM, class TYPE >

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

inlinevirtual

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

operator=()

template<int DIM, class TYPE >

void SAMRAI::pdat::CellVariable< DIM, TYPE >::operator= ( const CellVariable< 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/CellVariable.h