IBTK::LSetDataFactory< T > Class Template Reference

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

#include </home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LSetDataFactory.h>

Inheritance diagram for IBTK::LSetDataFactory< T >:

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=NULL) const override
SAMRAI::tbox::Pointer< SAMRAI::hier::PatchData< NDIM > >	allocate (const SAMRAI::hier::Patch< NDIM > &patch, SAMRAI::tbox::Pointer< SAMRAI::tbox::Arena > pool=NULL) 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
Public Member Functions inherited from SAMRAI::pdat::IndexDataFactory< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >
	IndexDataFactory (const hier::IntVector< NDIM > &ghosts)
virtual tbox::Pointer< hier::BoxGeometry< NDIM > >	getBoxGeometry (const hier::Box< NDIM > &box) const
bool	fineBoundaryRepresentsVariable () const
bool	dataLivesOnPatchBorder () const
bool	validCopyTo (const tbox::Pointer< hier::PatchDataFactory< NDIM > > &dst_pdf) const
Public Member Functions inherited from SAMRAI::hier::PatchDataFactory< DIM >
	PatchDataFactory (const IntVector< DIM > &ghosts)
virtual tbox::Pointer< PatchDataFactory< DIM > >	cloneFactory (const IntVector< DIM > &ghosts)=0
virtual tbox::Pointer< PatchData< DIM > >	allocate (const Box< DIM > &box, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *) NULL) const=0
virtual tbox::Pointer< PatchData< DIM > >	allocate (const Patch< DIM > &patch, tbox::Pointer< tbox::Arena > pool=(tbox::Arena *) NULL) const=0
virtual tbox::Pointer< BoxGeometry< DIM > >	getBoxGeometry (const Box< DIM > &box) const=0
const IntVector< DIM > &	getGhostCellWidth () const
virtual size_t	getSizeOfMemory (const Box< DIM > &box) const=0
virtual bool	validCopyTo (const tbox::Pointer< PatchDataFactory< DIM > > &dst_pdf) const=0
virtual MultiblockDataTranslator< DIM > *	getMultiblockDataTranslator ()

Additional Inherited Members
Protected Attributes inherited from SAMRAI::hier::PatchDataFactory< DIM >
IntVector< DIM >	d_ghosts

Detailed Description

template<class T>
class IBTK::LSetDataFactory< T >

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

Constructor & Destructor Documentation

LSetDataFactory()

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.

Member Function Documentation

allocate() [1/2]

template<class T >

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

overridevirtual

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.

Reimplemented from SAMRAI::pdat::IndexDataFactory< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >.

allocate() [2/2]

template<class T >

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

overridevirtual

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.

Reimplemented from SAMRAI::pdat::IndexDataFactory< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >.

cloneFactory()

template<class T >

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

overridevirtual

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.

Reimplemented from SAMRAI::pdat::IndexDataFactory< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >.

getSizeOfMemory()

template<class T >

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

overridevirtual

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

Reimplemented from SAMRAI::pdat::IndexDataFactory< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >.

validCopyTo()

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.

---

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

• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LSetDataFactory.h
• /home/runner/work/IBAMR/IBAMR/ibtk/src/lagrangian/LSetDataFactory.cpp