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

Class OuteredgeDataFactory<DIM> is a factory class used to allocate new instances of OuteredgeData<DIM> objects. It is a subclass of the patch data factory class and outeredge 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). More...

#include <source/patchdata/outeredge/OuteredgeDataFactory.h>

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

[legend]List of all members.

Public Member Functions
	OuteredgeDataFactory (int depth)
	The default constructor for the outeredge data factory class.
virtual	~OuteredgeDataFactory ()
	Virtual destructor for the outeredge data factory class.
virtual tbox::Pointer< hier::PatchDataFactory< DIM > >	cloneFactory ()
	Virtual function to clone the patch data factory .
virtual tbox::Pointer< hier::PatchData< DIM > >	allocate (const hier::Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >((0))) const
	Virtual factory function to allocate a concrete outeredge data object.
virtual tbox::Pointer< hier::BoxGeometry< DIM > >	getBoxGeometry (const hier::Box< DIM > &box) const
	Allocate the box geometry object associated with the patch data.
virtual const hier::IntVector< DIM > &	getDefaultGhostCellWidth () const
	Get the default ghost cell width.
virtual void	setDefaultGhostCellWidth (const hier::IntVector< DIM > &ghosts)
	Set the default ghost cell width.
int	getDefaultDepth () const
	Get the default depth (number of components).
void	setDefaultDepth (const int depth)
	Set the default depth (number of components).
virtual size_t	getSizeOfMemory (const hier::Box< DIM > &box) const
	Calculate the amount of memory needed to store the outeredge data object, including object data and dynamically allocated data.
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::OuteredgeDataFactory< DIM, TYPE >

Class OuteredgeDataFactory<DIM> is a factory class used to allocate new instances of OuteredgeData<DIM> objects. It is a subclass of the patch data factory class and outeredge 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::OuteredgeData

pdat::PatchDataFactory

---

Constructor & Destructor Documentation

template<int DIM, class TYPE> SAMRAI::pdat::OuteredgeDataFactory< DIM, TYPE >::OuteredgeDataFactory (  int  depth  )

The default constructor for the outeredge data factory class. The depth (number of components) gives the default for all of the outeredge data objects created with this factory.

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

Virtual destructor for the outeredge data factory class.

---

Member Function Documentation

template<int DIM, class TYPE> tbox::Pointer< hier::PatchDataFactory< DIM > > SAMRAI::pdat::OuteredgeDataFactory< 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 depth). 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::OuteredgeDataFactory< 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 outeredge data object. The default information about the object (e.g., depth) 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::OuteredgeDataFactory< 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::OuteredgeDataFactory< 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 outeredge data objects. This is set to zero currently for outeredge data objects. Implements SAMRAI::hier::PatchDataFactory< DIM >.

template<int DIM, class TYPE> void SAMRAI::pdat::OuteredgeDataFactory< 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 outeredge data instances. This routine should not be called with a non-zero ghost cell width and will cause an abort if the code is compiled with assertions enabled.

template<int DIM, class TYPE> int SAMRAI::pdat::OuteredgeDataFactory< 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 outeredge data objects.

template<int DIM, class TYPE> void SAMRAI::pdat::OuteredgeDataFactory< 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 outeredge data objects.

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

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

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

Return a boolean true value indicating that fine data for the outeredge quantity will take precedence on coarse-fine interfaces. See the OuteredgeVariable<DIM> class header file for more information. Implements SAMRAI::hier::PatchDataFactory< DIM >.

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

Return true since the outeredge data index space extends beyond the interior of patches. That is, outeredge data lives on patch borders. Implements SAMRAI::hier::PatchDataFactory< DIM >.

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

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

---

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

• source/patchdata/outeredge/OuteredgeDataFactory.h
• source/patchdata/outeredge/OuteredgeDataFactory.C
• source/patchdata/outeredge/OuteredgeDataFactory.I

---