Class LSetPatchDataFactory provides a SAMRAI::hier::PatchDataFactory class corresponding to patch data of type LSetData.

#include <ibtk/LSetDataFactory.h>

Inheritance diagram for IBTK::LSetDataFactory< T >:

[legend]

Public Member Functions
	LSetDataFactory (SAMRAI::hier::IntVector< NDIM > ghosts)

virtual	~LSetDataFactory ()=default

SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	allocate (const SAMRAI::hier::Box< NDIM > &box, SAMRAI::tbox::Pointer< SAMRAI::tbox::Arena > pool=nullptr) const override

SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	allocate (const SAMRAI::hier::Patch< NDIM > &patch, SAMRAI::tbox::Pointer< SAMRAI::tbox::Arena > pool=nullptr) const override

size_t	getSizeOfMemory (const SAMRAI::hier::Box< NDIM > &box) const override

SAMRAI::tbox::Pointer< SAMRAI::hier::PatchDataFactory< NDIM > >	cloneFactory (const SAMRAI::hier::IntVector< NDIM > &ghosts) override

bool	validCopyTo (const SAMRAI::tbox::Pointer< SAMRAI::hier::PatchDataFactory< NDIM > > &dst_pdf) const override

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< PatchDataFactory< DIM > >	cloneFactory (const IntVector< DIM > &ghosts)=0
	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::Arena *) NULL) const

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< 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< hier::BoxGeometry< DIM > >	getBoxGeometry (const hier::Box< DIM > &box) const

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

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

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...

bool	fineBoundaryRepresentsVariable () const

virtual bool	fineBoundaryRepresentsVariable () const =0
	Return true if the fine data values represent the data quantity on coarse-fine interfaces if data lives on patch borders; false otherwise. More...

bool	dataLivesOnPatchBorder () const

virtual bool	dataLivesOnPatchBorder () const =0
	Return true if the variable data lives on patch borders; false otherwise. More...

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

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

virtual MultiblockDataTranslator< DIM > *	getMultiblockDataTranslator ()

Protected Attributes
IntVector< DIM >	d_ghosts

Private Member Functions
	LSetDataFactory ()=delete
	Default constructor. More...

	LSetDataFactory (const LSetDataFactory< T > &from)=delete
	Copy constructor. More...

LSetDataFactory &	operator= (const LSetDataFactory< T > &that)=delete
	Assignment operator. More...

Constructor & Destructor Documentation

◆ LSetDataFactory() [1/3]

template<class T >

IBTK::LSetDataFactory< T >::LSetDataFactory ( SAMRAI::hier::IntVector< NDIM > ghosts )

The default constructor for the LSetDataFactory class. The ghost cell width argument gives the default width for all data objects created with this factory.

◆ ~LSetDataFactory()

template<class T >

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

virtualdefault

Virtual destructor for the data factory class.

◆ LSetDataFactory() [2/3]

template<class T >

IBTK::LSetDataFactory< T >::LSetDataFactory ( )

privatedelete

Note: This constructor is not implemented and should not be used.

◆ LSetDataFactory() [3/3]

template<class T >

IBTK::LSetDataFactory< T >::LSetDataFactory ( const LSetDataFactory< 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

◆ allocate() [1/5]

template<class T >

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchData<NDIM> > IBTK::LSetDataFactory< T >::allocate	(	const SAMRAI::hier::Box< NDIM > &	box,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Arena >	pool = `nullptr`
	)		const

override

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

◆ allocate() [2/5]

template<class T >

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchData<NDIM> > IBTK::LSetDataFactory< T >::allocate	(	const SAMRAI::hier::Patch< NDIM > &	patch,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Arena >	pool = `nullptr`
	)		const

override

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

◆ getSizeOfMemory() [1/3]

template<class T >

size_t IBTK::LSetDataFactory< T >::getSizeOfMemory ( const SAMRAI::hier::Box< NDIM > & box ) const

override

Calculate the amount of memory needed to store the data object, including object data but not dynamically allocated data.

◆ cloneFactory() [1/3]

template<class T >

SAMRAI::tbox::Pointer<SAMRAI::hier::PatchDataFactory<NDIM> > IBTK::LSetDataFactory< T >::cloneFactory ( const SAMRAI::hier::IntVector< NDIM > & ghosts )

override

Virtual function to clone the data factory. This will return a new instantiation of the factory with the same properties (e.g., same type). The properties of the cloned factory can then be changed without modifying the original.

◆ validCopyTo() [1/2]

template<class T >

bool IBTK::LSetDataFactory< T >::validCopyTo ( const SAMRAI::tbox::Pointer< SAMRAI::hier::PatchDataFactory< NDIM > > & dst_pdf ) const

override

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

◆ operator=()

template<class T >

LSetDataFactory& IBTK::LSetDataFactory< T >::operator= ( const LSetDataFactory< 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.

◆ cloneFactory() [2/3]

virtual tbox::Pointer< hier::PatchDataFactory<DIM> > SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::cloneFactory ( const hier::IntVector< DIM > & ghosts )

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 default ghost cell width for concrete classes created from the factory.

◆ cloneFactory() [3/3]

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/5]

virtual tbox::Pointer< hier::PatchData<DIM> > SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::allocate	(	const hier::Box< DIM > &	box,
		tbox::Pointer< tbox::Arena >	pool = `(tbox::Arena *) NULL`
	)		const

virtualinherited

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

◆ allocate() [4/5]

virtual tbox::Pointer< hier::PatchData<DIM> > SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::allocate	(	const hier::Patch< DIM > &	patch,
		tbox::Pointer< tbox::Arena >	pool = `tbox::Pointer<tbox::Arena>(NULL)`
	)		const

virtualinherited

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

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

◆ allocate() [5/5]

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() [1/2]

virtual tbox::Pointer< hier::BoxGeometry<DIM> > SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::getBoxGeometry ( const hier::Box< DIM > & box ) const

virtualinherited

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.

◆ 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.

◆ getSizeOfMemory() [2/3]

virtual size_t SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::getSizeOfMemory ( const hier::Box< DIM > & box ) const

virtualinherited

Calculate the amount of memory needed to store the irregular data object, including object data but not dynamically allocated data. Because the irregular data list can grow and shrink, it would be impossible to estimate the necessary amount of memory. Instead, dynamic data is allocated via the standard new/free mechanisms.

◆ getSizeOfMemory() [3/3]

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.

◆ fineBoundaryRepresentsVariable() [1/2]

bool SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::fineBoundaryRepresentsVariable ( ) const

inlineinherited

Return a boolean true value indicating that the index data quantities will always be treated as though fine values represent them on coarse-fine interfaces. See the IndexVariable<DIM> class header file for more information.

◆ fineBoundaryRepresentsVariable() [2/2]

template<int DIM>

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

pure virtualinherited

The boolean return value is supplied by the concrete patch data factory subclass.

Implemented in SAMRAI::pdat::SideDataFactory< DIM, TYPE >, SAMRAI::pdat::OuteredgeDataFactory< DIM, TYPE >, SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >, SAMRAI::pdat::NodeDataFactory< DIM, TYPE >, SAMRAI::pdat::CellDataFactory< DIM, TYPE >, SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >, SAMRAI::pdat::FaceDataFactory< DIM, TYPE >, SAMRAI::pdat::OuterfaceDataFactory< DIM, TYPE >, SAMRAI::pdat::OutersideDataFactory< DIM, TYPE >, and SAMRAI::pdat::IndexDataFactory< DIM, TYPE, BOX_GEOMETRY >.

◆ dataLivesOnPatchBorder() [1/2]

bool SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::dataLivesOnPatchBorder ( ) const

inlineinherited

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

◆ dataLivesOnPatchBorder() [2/2]

template<int DIM>

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

pure virtualinherited

The boolean return value is supplied by the concrete patch data factory subclass.

Implemented in SAMRAI::pdat::SideDataFactory< DIM, TYPE >, SAMRAI::pdat::OuteredgeDataFactory< DIM, TYPE >, SAMRAI::pdat::OuternodeDataFactory< DIM, TYPE >, SAMRAI::pdat::NodeDataFactory< DIM, TYPE >, SAMRAI::pdat::CellDataFactory< DIM, TYPE >, SAMRAI::pdat::EdgeDataFactory< DIM, TYPE >, SAMRAI::pdat::FaceDataFactory< DIM, TYPE >, SAMRAI::pdat::OuterfaceDataFactory< DIM, TYPE >, SAMRAI::pdat::OutersideDataFactory< DIM, TYPE >, and SAMRAI::pdat::IndexDataFactory< DIM, TYPE, BOX_GEOMETRY >.

◆ validCopyTo() [2/2]

bool SAMRAI::pdat::IndexDataFactory< DIM, LSet< T > , SAMRAI::pdat::CellGeometry< NDIM > >::validCopyTo ( const tbox::Pointer< hier::PatchDataFactory< DIM > > & dst_pdf ) const

virtualinherited

Return whether it is valid to copy this IndexDataFactory to the supplied destination patch data factory. It will return true if dst_pdf is an IndexDataFactory of the same type and dimension, false otherwise.

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

◆ 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.

◆ 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_ghosts

template<int DIM>

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

protectedinherited

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

ibtk/include/ibtk/LSetDataFactory.h

Public Member Functions

Protected Attributes

Private Member Functions

Constructor & Destructor Documentation

◆ LSetDataFactory() [1/3]

◆ ~LSetDataFactory()

◆ LSetDataFactory() [2/3]

◆ LSetDataFactory() [3/3]

Member Function Documentation

◆ allocate() [1/5]

◆ allocate() [2/5]

◆ getSizeOfMemory() [1/3]

◆ cloneFactory() [1/3]

◆ validCopyTo() [1/2]

◆ operator=()

◆ cloneFactory() [2/3]

◆ cloneFactory() [3/3]

◆ allocate() [3/5]

◆ allocate() [4/5]

◆ allocate() [5/5]

◆ getBoxGeometry() [1/2]

◆ getBoxGeometry() [2/2]

◆ getSizeOfMemory() [2/3]

◆ getSizeOfMemory() [3/3]

◆ fineBoundaryRepresentsVariable() [1/2]

◆ fineBoundaryRepresentsVariable() [2/2]

◆ dataLivesOnPatchBorder() [1/2]

◆ dataLivesOnPatchBorder() [2/2]

◆ validCopyTo() [2/2]

◆ getGhostCellWidth()

◆ getMultiblockDataTranslator()

Member Data Documentation

◆ d_ghosts