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

#include <source/patchdata/cell/CellDataFactory.h>

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

[legend]List of all members.

Public Member Functions
	CellDataFactory (int depth, const hier::IntVector< DIM > &ghosts)
virtual	~CellDataFactory ()
virtual tbox::Pointer< hier::PatchDataFactory< DIM > >	cloneFactory ()
virtual tbox::Pointer< hier::PatchData< DIM > >	allocate (const hier::Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >((0))) const
virtual tbox::Pointer< hier::BoxGeometry< DIM > >	getBoxGeometry (const hier::Box< DIM > &box) const
virtual const hier::IntVector< DIM > &	getDefaultGhostCellWidth () const
virtual void	setDefaultGhostCellWidth (const hier::IntVector< DIM > &ghosts)
int	getDefaultDepth () const
void	setDefaultDepth (const int depth)
virtual size_t	getSizeOfMemory (const hier::Box< DIM > &box) const
bool	fineBoundaryRepresentsVariable () const
bool	dataLivesOnPatchBorder () const
bool	validCopyTo (const tbox::Pointer< hier::PatchDataFactory< DIM > > &dst_pdf) const

---

Detailed Description

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

Class CellDataFactory is a factory class used to allocate new instances of CellData objects. It is a subclass of the patch data factory class and cell data is a subclass of patch data. Both the factory and data classes are templated on the type of the contained object (e.g., double or int).

See also:

pdat::CellData

pdat::PatchDataFactory

---

Constructor & Destructor Documentation

template<int DIM, class TYPE> SAMRAI::pdat::CellDataFactory< DIM, TYPE >::CellDataFactory (  int  depth, const hier::IntVector< DIM > &  ghosts )

The default constructor for the cell data factory class. The ghost cell width and depth (number of components) arguments give the defaults for all cell data objects created with this factory.

template<int DIM, class TYPE> SAMRAI::pdat::CellDataFactory< DIM, TYPE >::~CellDataFactory (   )  [virtual]

Virtual destructor for the cell data factory class.

---

Member Function Documentation

template<int DIM, class TYPE> tbox::Pointer< hier::PatchDataFactory< DIM > > SAMRAI::pdat::CellDataFactory< DIM, TYPE >::cloneFactory (   )  [virtual]

Virtual function to clone the patch data factory . This will return a new instantiation of the factory with the same properties (e.g., same type and ghost cell width). The properties of the cloned factory can then be changed without modifying the original. Implements SAMRAI::hier::PatchDataFactory< DIM >.

template<int DIM, class TYPE> tbox::Pointer< hier::PatchData< DIM > > SAMRAI::pdat::CellDataFactory< DIM, TYPE >::allocate (  const hier::Box< DIM > &  box, tbox::Pointer< tbox::Arena >  pool = tbox::Pointer< tbox::Arena >((0)) )  const [virtual]

Virtual factory function to allocate a concrete cell data object. The default information about the object (e.g., ghost cell width) is taken from the factory. If no memory pool is provided, then the allocation routine assumes some default memory pool.

template<int DIM, class TYPE> tbox::Pointer< hier::BoxGeometry< DIM > > SAMRAI::pdat::CellDataFactory< DIM, TYPE >::getBoxGeometry (  const hier::Box< DIM > &  box  )  const [virtual]

Allocate the box geometry object associated with the patch data. This information will be used in the computation of intersections and data dependencies between objects.

template<int DIM, class TYPE> const hier::IntVector< DIM > & SAMRAI::pdat::CellDataFactory< DIM, TYPE >::getDefaultGhostCellWidth (   )  const [virtual]

Get the default ghost cell width. This is the ghost cell width that will be used in the instantiation of concrete cell data objects. Implements SAMRAI::hier::PatchDataFactory< DIM >.

template<int DIM, class TYPE> void SAMRAI::pdat::CellDataFactory< DIM, TYPE >::setDefaultGhostCellWidth (  const hier::IntVector< DIM > &  ghosts  )  [virtual]

Set the default ghost cell width. This is the ghost cell width that will be used in the instantiation of concrete cell data instances.

template<int DIM, class TYPE> int SAMRAI::pdat::CellDataFactory< DIM, TYPE >::getDefaultDepth (   )  const [inline]

Get the default depth (number of components). This is the default depth that will be used in the instantiation of cell data objects.

template<int DIM, class TYPE> void SAMRAI::pdat::CellDataFactory< DIM, TYPE >::setDefaultDepth (  const int  depth  )  [inline]

Set the default depth (number of components). This is the default depth that will be used in the instantiation of cell data objects.

template<int DIM, class TYPE> size_t SAMRAI::pdat::CellDataFactory< DIM, TYPE >::getSizeOfMemory (  const hier::Box< DIM > &  box  )  const [virtual]

Calculate the amount of memory needed to store the cell data object, including object data and dynamically allocated data.

template<int DIM, class TYPE> bool SAMRAI::pdat::CellDataFactory< DIM, TYPE >::fineBoundaryRepresentsVariable (   )  const [inline, virtual]

Return a boolean true value indicating that the cell data quantities will always be treated as though fine values represent them on coarse-fine interfaces. See the CellVariable<DIM> class header file for more information. Implements SAMRAI::hier::PatchDataFactory< DIM >.

template<int DIM, class TYPE> bool SAMRAI::pdat::CellDataFactory< DIM, TYPE >::dataLivesOnPatchBorder (   )  const [inline, virtual]

Return false since the cell data index space matches the cell-centered index space for AMR patches. Thus, cell data does not live on patch borders. Implements SAMRAI::hier::PatchDataFactory< DIM >.

template<int DIM, class TYPE> bool SAMRAI::pdat::CellDataFactory< DIM, TYPE >::validCopyTo (  const tbox::Pointer< hier::PatchDataFactory< DIM > > &  dst_pdf  )  const

Return whether it is valid to copy this CellDataFactory to the supplied destination patch data factory. It will return true if dst_pdf is a CellDataFactory, false otherwise.

---

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

• source/patchdata/cell/CellDataFactory.h
• source/patchdata/cell/CellDataFactory.C
• source/patchdata/cell/CellDataFactory.I

---