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

#include <NodeVariable.h>

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

Public Member Functions
	NodeVariable (const std::string &name, int depth=1, bool fine_boundary_represents_var=true)
	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. 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. More...
virtual	~NodeVariable ()
	Virtual destructor for node variable objects. More...
bool	fineBoundaryRepresentsVariable () const
	Return boolean indicating which node data values (coarse or fine) take precedence at coarse-fine mesh interfaces. The value is set in the constructor. More...
bool	dataLivesOnPatchBorder () const
	Return true indicating that node data on a patch interior 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
	NodeVariable (const NodeVariable< DIM, TYPE > &)
void	operator= (const NodeVariable< DIM, TYPE > &)

Private Attributes
bool	d_fine_boundary_represents_var
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::NodeVariable< DIM, TYPE >

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

See also

pdat::NodeData

pdat::NodeDataFactory

hier::Variable

Constructor & Destructor Documentation

NodeVariable() [1/2]

template<int DIM, class TYPE >

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

~NodeVariable()

template<int DIM, class TYPE >

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

virtual

NodeVariable() [2/2]

template<int DIM, class TYPE >

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

private

Member Function Documentation

fineBoundaryRepresentsVariable()

template<int DIM, class TYPE >

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

inlinevirtual

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

dataLivesOnPatchBorder()

template<int DIM, class TYPE >

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

inlinevirtual

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

operator=()

template<int DIM, class TYPE >

void SAMRAI::pdat::NodeVariable< DIM, TYPE >::operator= ( const NodeVariable< 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_fine_boundary_represents_var

template<int DIM, class TYPE >

bool SAMRAI::pdat::NodeVariable< DIM, TYPE >::d_fine_boundary_represents_var

private

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/NodeVariable.h