IBTK::LSetVariable< T > Class Template Reference

Class LSetVariable provides a SAMRAI::hier::Variable class corresponding to patch data of type LSetData.

#include <ibtk/LSetVariable.h>

Inheritance diagram for IBTK::LSetVariable< T >:

Public Member Functions
	LSetVariable (std::string name)
virtual	~LSetVariable ()=default
bool	dataLivesOnPatchBorder () const override
bool	fineBoundaryRepresentsVariable () const override
int	getInstanceIdentifier () const
const std::string &	getName () const
virtual bool	fineBoundaryRepresentsVariable () const=0
virtual bool	dataLivesOnPatchBorder () const=0
void	setPatchDataFactory (tbox::Pointer< PatchDataFactory< DIM > > factory)
tbox::Pointer< PatchDataFactory< DIM > >	getPatchDataFactory () const

Static Public Member Functions
static int	getCurrentMaximumInstanceNumber ()

Private Member Functions
	LSetVariable ()=delete
	Default constructor. More...
	LSetVariable (const LSetVariable< T > &from)=delete
	Copy constructor. More...
LSetVariable< T > &	operator= (const LSetVariable< T > &that)=delete
	Assignment operator. More...

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

Static Private Attributes
static int	s_instance_counter

Constructor & Destructor Documentation

LSetVariable() [1/3]

template<class T >

IBTK::LSetVariable< T >::LSetVariable

(

std::string

name

)

Create an LSetVariable object with the specified name.

~LSetVariable()

template<class T >

virtual IBTK::LSetVariable< T >::~LSetVariable ( )

virtualdefault

Virtual destructor for LSetVariable objects.

LSetVariable() [2/3]

template<class T >

IBTK::LSetVariable< T >::LSetVariable ( )

privatedelete

Note

This constructor is not implemented and should not be used.

LSetVariable() [3/3]

template<class T >

IBTK::LSetVariable< T >::LSetVariable ( const LSetVariable< T > &  from )

privatedelete

Note

This constructor is not implemented and should not be used.

Parameters

from	The value to copy to this object.

Member Function Documentation

dataLivesOnPatchBorder() [1/2]

template<class T >

bool IBTK::LSetVariable< T >::dataLivesOnPatchBorder ( ) const

override

Return false since the LSet data index space matches the cell-centered index space for AMR patches. Thus, LSet data does not live on patch borders.

fineBoundaryRepresentsVariable() [1/2]

template<class T >

bool IBTK::LSetVariable< T >::fineBoundaryRepresentsVariable ( ) const

override

Return true so that the LSet data quantities will always be treated as though fine values represent them on coarse-fine interfaces. Note that this is really artificial since the LSet data index space matches the cell-centered index space for AMR patches. Thus, LSet data does not live on patch borders and so there is no ambiguity regarding coarse-fine interface values.

operator=()

template<class T >

LSetVariable<T>& IBTK::LSetVariable< T >::operator= ( const LSetVariable< T > &  that )

privatedelete

Note

This operator is not implemented and should not be used.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

getCurrentMaximumInstanceNumber()

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()

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()

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

inherited

Return the name assigned to this variable.

fineBoundaryRepresentsVariable() [2/2]

virtual bool SAMRAI::hier::Variable< DIM >::fineBoundaryRepresentsVariable ( ) const

pure virtualinherited

Return true if the fine data values represent the variable quantity on coarse-fine interfaces if variable data lives on patch borders; false otherwise. The boolean return value is supplied by the concrete variable subclass.

dataLivesOnPatchBorder() [2/2]

virtual bool SAMRAI::hier::Variable< DIM >::dataLivesOnPatchBorder ( ) const

pure virtualinherited

Return true if the variable data lives on patch borders; false otherwise.
The boolean return value is supplied by the concrete variable subclass.

setPatchDataFactory()

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()

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

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

privateinherited

d_instance

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

privateinherited

d_factory

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

privateinherited

s_instance_counter

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

staticprivateinherited

---

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

• ibtk/include/ibtk/LSetVariable.h