Class OuternodeDataFactory is a factory class used to allocate new instances of OuternodeData objects. It is a subclass of the patch data factory class and outernode 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 <OuternodeDataFactory.h>

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

[legend]

Public Member Functions
	OuternodeDataFactory (int depth)
	The default constructor for the outernode data factory class. More...

virtual	~OuternodeDataFactory ()
	Virtual destructor for the outernode data factory class. More...

virtual tbox::Pointer< hier::PatchDataFactory< DIM > >	cloneFactory (const hier::IntVector< DIM > &ghosts)
	Abstract virtual function to clone a patch data factory. More...

virtual tbox::Pointer< hier::PatchData< DIM > >	allocate (const hier::Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >(NULL)) const
	Virtual factory function to allocate a concrete outernode data object. More...

virtual tbox::Pointer< hier::PatchData< DIM > >	allocate (const hier::Patch< DIM > &patch, tbox::Pointer< tbox::Arena > pool=tbox::Pointer< tbox::Arena >(NULL)) const

virtual tbox::Pointer< hier::BoxGeometry< DIM > >	getBoxGeometry (const hier::Box< DIM > &box) const
	Allocate the box geometry object associated with the patch data. More...

int	getDefaultDepth () const
	Get the default depth (number of components). More...

void	setDefaultDepth (const int depth)
	Set the default depth (number of components). More...

virtual size_t	getSizeOfMemory (const hier::Box< DIM > &box) const
	Calculate the amount of memory needed to store the outernode data object, including object data and dynamically allocated data. More...

bool	fineBoundaryRepresentsVariable () const

bool	dataLivesOnPatchBorder () const

bool	validCopyTo (const tbox::Pointer< hier::PatchDataFactory< DIM > > &dst_pdf) const

virtual tbox::Pointer< PatchDataFactory< DIM > >	cloneFactory (const IntVector< DIM > &ghosts)=0
	Abstract virtual function to clone a patch data factory. More...

virtual tbox::Pointer< PatchData< DIM > >	allocate (const Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *) NULL) const =0
	Abstract virtual function to allocate a concrete patch data object. More...

virtual tbox::Pointer< BoxGeometry< DIM > >	getBoxGeometry (const Box< DIM > &box) const =0
	Abstract virtual function to allocate a concrete box geometry object. More...

const IntVector< DIM > &	getGhostCellWidth () const
	Get the ghost cell width. More...

virtual size_t	getSizeOfMemory (const Box< DIM > &box) const =0
	Abstract virtual function to compute the amount of memory needed to allocate for object data and to represent the object itself. More...

virtual MultiblockDataTranslator< DIM > *	getMultiblockDataTranslator ()

Protected Attributes
IntVector< DIM >	d_ghosts

Private Attributes
int	d_depth

hier::IntVector< DIM >	d_no_ghosts

Detailed Description

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

See also: pdat::OuternodeData; pdat::PatchDataFactory

Constructor & Destructor Documentation

◆ OuternodeDataFactory()

template<int DIM, class TYPE >

SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::OuternodeDataFactory ( int depth )

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

◆ ~OuternodeDataFactory()

template<int DIM, class TYPE >

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

virtual

Member Function Documentation

◆ cloneFactory() [1/2]

template<int DIM, class TYPE >

virtual tbox::Pointer< hier::PatchDataFactory<DIM> > SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::cloneFactory ( const hier::IntVector< DIM > & ghosts )

virtual

This will return a new instantiation of the abstract factory with the same properties. The properties of the cloned factory can then be changed without modifying the original.

Parameters

ghosts default ghost cell width for concrete classes created from the factory.

◆ allocate() [1/3]

template<int DIM, class TYPE >

virtual tbox::Pointer<hier::PatchData<DIM> > SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::allocate	(	const hier::Box< DIM > &	box,
		tbox::Pointer< tbox::Arena >	pool = `tbox::Pointer< tbox::Arena >(NULL)`
	)		const

virtual

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.

◆ allocate() [2/3]

template<int DIM, class TYPE >

virtual tbox::Pointer< hier::PatchData<DIM> > SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::allocate	(	const hier::Patch< DIM > &	patch,
		tbox::Pointer< tbox::Arena >	pool = `tbox::Pointer< tbox::Arena >(NULL)`
	)		const

virtual

Virtual factory function to allocate a concrete cell data object. Same as above function, except passes in a patch instead of a box.

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

◆ getBoxGeometry() [1/2]

template<int DIM, class TYPE >

virtual tbox::Pointer<hier::BoxGeometry<DIM> > SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::getBoxGeometry ( const hier::Box< DIM > & box ) const

virtual

This information will be used in the computation of intersections and data dependencies between objects.

◆ getDefaultDepth()

template<int DIM, class TYPE >

int SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::getDefaultDepth ( ) const

This is the default depth that will be used in the instantiation of outernode data objects.

◆ setDefaultDepth()

template<int DIM, class TYPE >

void SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::setDefaultDepth ( const int depth )

This is the default depth that will be used in the instantiation of outernode data objects.

◆ getSizeOfMemory() [1/2]

template<int DIM, class TYPE >

virtual size_t SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::getSizeOfMemory ( const hier::Box< DIM > & box ) const

virtual

◆ fineBoundaryRepresentsVariable()

template<int DIM, class TYPE >

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

inlinevirtual

Return a boolean true value indicating that fine data for the outernode quantity will take precedence on coarse-fine interfaces. See the OuternodeVariable class header file for more information.

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

◆ dataLivesOnPatchBorder()

template<int DIM, class TYPE >

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

inlinevirtual

Return true since the outernode data index space extends beyond the interior of patches. That is, outernode data lives on patch borders.

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

◆ validCopyTo()

template<int DIM, class TYPE >

bool SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::validCopyTo ( const tbox::Pointer< hier::PatchDataFactory< DIM > > & dst_pdf ) const

virtual

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

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

◆ cloneFactory() [2/2]

template<int DIM>

virtual tbox::Pointer< PatchDataFactory<DIM> > SAMRAI::hier::PatchDataFactory< DIM >::cloneFactory ( const IntVector< DIM > & ghosts )

pure virtualinherited

This will return a new instantiation of the abstract factory with the same properties. The properties of the cloned factory can then be changed without modifying the original.

Parameters

ghosts ghost cell width for concrete classes created from the factory.

◆ allocate() [3/3]

template<int DIM>

virtual tbox::Pointer< PatchData<DIM> > SAMRAI::hier::PatchDataFactory< DIM >::allocate	(	const Box< DIM > &	box,
		tbox::Pointer< tbox::Arena >	pool = `(tbox::Arena *) NULL`
	)		const

pure virtualinherited

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.

◆ getBoxGeometry() [2/2]

template<int DIM>

virtual tbox::Pointer< BoxGeometry<DIM> > SAMRAI::hier::PatchDataFactory< DIM >::getBoxGeometry ( const Box< DIM > & box ) const

pure virtualinherited

The box geometry object will be used in the calculation of box intersections for the computation of data dependencies.

◆ getGhostCellWidth()

template<int DIM>

const IntVector<DIM>& SAMRAI::hier::PatchDataFactory< DIM >::getGhostCellWidth ( ) const

inherited

This is the ghost cell width that will be used in the instantiation of concrete patch data instances. The ghost width is specified in the clone method.

◆ getSizeOfMemory() [2/2]

template<int DIM>

virtual size_t SAMRAI::hier::PatchDataFactory< DIM >::getSizeOfMemory ( const Box< DIM > & box ) const

pure virtualinherited

This includes any dynamic storage, such as arrays, needed by the concrete patch data instance. Although the patch data subclass may choose not to allocate memory from the provided memory pool, it must not use more memory than requested here.

◆ getMultiblockDataTranslator()

template<int DIM>

virtual MultiblockDataTranslator<DIM>* SAMRAI::hier::PatchDataFactory< DIM >::getMultiblockDataTranslator ( )

virtualinherited

Reimplemented in SAMRAI::pdat::SideDataFactory< DIM, TYPE >, SAMRAI::pdat::NodeDataFactory< DIM, TYPE >, SAMRAI::pdat::CellDataFactory< DIM, TYPE >, SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >, and SAMRAI::pdat::FaceDataFactory< DIM, TYPE >.

Member Data Documentation

◆ d_depth

template<int DIM, class TYPE >

int SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::d_depth

private

◆ d_no_ghosts

template<int DIM, class TYPE >

hier::IntVector<DIM> SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >::d_no_ghosts

private

◆ d_ghosts

template<int DIM>

IntVector<DIM> SAMRAI::hier::PatchDataFactory< DIM >::d_ghosts

protectedinherited

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

/samrai/include/OuternodeDataFactory.h

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

◆ OuternodeDataFactory()

◆ ~OuternodeDataFactory()

Member Function Documentation

◆ cloneFactory() [1/2]

◆ allocate() [1/3]

◆ allocate() [2/3]

◆ getBoxGeometry() [1/2]

◆ getDefaultDepth()

◆ setDefaultDepth()

◆ getSizeOfMemory() [1/2]

◆ fineBoundaryRepresentsVariable()

◆ dataLivesOnPatchBorder()

◆ validCopyTo()

◆ cloneFactory() [2/2]

◆ allocate() [3/3]

◆ getBoxGeometry() [2/2]

◆ getGhostCellWidth()

◆ getSizeOfMemory() [2/2]

◆ getMultiblockDataTranslator()

Member Data Documentation

◆ d_depth

◆ d_no_ghosts

◆ d_ghosts

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