Class LSetData is a specialization of the templated class SAMRAI::pdat::IndexData that provides access to Lagrangian objects that are embedded in the a Cartesian grid patch. More...

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

Inheritance diagram for IBTK::LSetData< T >:

[legend]

Public Types
using	CellIterator = SAMRAI::pdat::CellIterator< NDIM >

using	SetIterator = SAMRAI::pdat::IndexIterator< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >

using	DataIterator = IBTK::LSetDataIterator< T >

Public Types inherited from SAMRAI::pdat::IndexData< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >
typedef IndexIterator< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >	Iterator

typedef ConstIndexIterator< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >	ConstIterator

Public Member Functions
DataIterator	data_begin (const SAMRAI::hier::Box< NDIM > &box)

DataIterator	data_end ()

	LSetData (SAMRAI::hier::Box< NDIM > box, SAMRAI::hier::IntVector< NDIM > ghosts)

virtual	~LSetData ()=default

Public Member Functions inherited from SAMRAI::pdat::IndexData< NDIM, LSet< T >, SAMRAI::pdat::CellGeometry< NDIM > >
	IndexData (const hier::Box< NDIM > &box, const hier::IntVector< NDIM > &ghosts)

virtual void	copy (const hier::PatchData< NDIM > &src)

virtual void	copy (const hier::PatchData< NDIM > &src, const hier::BoxOverlap< NDIM > &overlap)

virtual void	copy2 (hier::PatchData< NDIM > &dst) const

virtual void	copy2 (hier::PatchData< NDIM > &dst, const hier::BoxOverlap< NDIM > &overlap) const

virtual bool	canEstimateStreamSizeFromBox () const

virtual int	getDataStreamSize (const hier::BoxOverlap< NDIM > &overlap) const

virtual void	packStream (tbox::AbstractStream &stream, const hier::BoxOverlap< NDIM > &overlap) const

virtual void	unpackStream (tbox::AbstractStream &stream, const hier::BoxOverlap< NDIM > &overlap)

void	appendItem (const hier::Index< NDIM > &index, const LSet< T > &item)

void	appendItemPointer (const hier::Index< NDIM > &index, LSet< T > *item)

void	addItem (const hier::Index< NDIM > &index, const LSet< T > &item)

void	addItemPointer (const hier::Index< NDIM > &index, LSet< T > *item)

void	replaceAddItem (const hier::Index< NDIM > &index, const LSet< T > &item)

void	replaceAddItemPointer (const hier::Index< NDIM > &index, LSet< T > *item)

void	replaceAppendItem (const hier::Index< NDIM > &index, const LSet< T > &item)

void	replaceAppendItemPointer (const hier::Index< NDIM > &index, LSet< T > *item)

void	removeItem (const hier::Index< NDIM > &index)

int	getNumberOfItems () const

void	removeInsideBox (const hier::Box< NDIM > &box)

void	removeOutsideBox (const hier::Box< NDIM > &box)

void	removeGhostItems ()

void	removeAllItems ()

bool	isElement (const hier::Index< NDIM > &index) const

LSet< T > *	getItem (const hier::Index< NDIM > &index) const

virtual void	getSpecializedFromDatabase (tbox::Pointer< tbox::Database > database)

virtual void	putSpecializedToDatabase (tbox::Pointer< tbox::Database > database)

Public Member Functions inherited from SAMRAI::hier::PatchData< DIM >
	PatchData (const Box< DIM > &domain, const IntVector< DIM > &ghosts)

const Box< DIM > &	getBox () const

const Box< DIM > &	getGhostBox () const

const IntVector< DIM > &	getGhostCellWidth () const

void	setTime (const double timestamp)

double	getTime () const

virtual void	copy (const PatchData< DIM > &src)=0

virtual void	copy2 (PatchData< DIM > &dst) const=0

virtual void	copy (const PatchData< DIM > &src, const BoxOverlap< DIM > &overlap)=0

virtual void	copy2 (PatchData< DIM > &dst, const BoxOverlap< DIM > &overlap) const=0

virtual int	getDataStreamSize (const BoxOverlap< DIM > &overlap) const=0

virtual void	packStream (tbox::AbstractStream &stream, const BoxOverlap< DIM > &overlap) const =0

virtual void	unpackStream (tbox::AbstractStream &stream, const BoxOverlap< DIM > &overlap)=0

virtual void	getFromDatabase (tbox::Pointer< tbox::Database > database)

virtual void	putToDatabase (tbox::Pointer< tbox::Database > database)

Additional Inherited Members
Protected Member Functions inherited from SAMRAI::hier::PatchData< DIM >
void	setGhostBox (const Box< DIM > &ghost_box)

Detailed Description

template<class T>
class IBTK::LSetData< T >

Class LSetData is a specialization of the templated class SAMRAI::pdat::IndexData that provides access to Lagrangian objects that are embedded in the a Cartesian grid patch.

See also: SAMRAI::pdat::IndexData

Member Typedef Documentation

◆ CellIterator

template<class T >

using IBTK::LSetData< T >::CellIterator = SAMRAI::pdat::CellIterator<NDIM>

This iterator iterates over the elements of a cell centered box geometry.

◆ DataIterator

template<class T >

using IBTK::LSetData< T >::DataIterator = IBTK::LSetDataIterator<T>

This iterator iterates over the Lagrangian elements located within a cell centered box geometry.

◆ SetIterator

template<class T >

using IBTK::LSetData< T >::SetIterator = SAMRAI::pdat::IndexIterator<NDIM, LSet<T>, SAMRAI::pdat::CellGeometry<NDIM> >

This iterator iterates over the LSet elements within the IndexData patch data object.

Constructor & Destructor Documentation

◆ LSetData()

template<class T >

IBTK::LSetData< T >::LSetData	(	SAMRAI::hier::Box< NDIM >	box,
		SAMRAI::hier::IntVector< NDIM >	ghosts
	)

The constructor for an SAMRAI::pdat::IndexData<NDIM> object. The box describes the interior of the index space and the ghosts vector describes the ghost nodes in each coordinate direction.

◆ ~LSetData()

template<class T >

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

virtualdefault

The virtual destructor for an LSetData object.

Member Function Documentation

◆ data_begin()

template<class T >

LSetData< T >::DataIterator IBTK::LSetData< T >::data_begin ( const SAMRAI::hier::Box< NDIM > & box )

inline

Return an iterator to the first Lagrangian data object in the specified region of index space.

◆ data_end()

template<class T >

LSetData< T >::DataIterator IBTK::LSetData< T >::data_end

inline

Return an iterator pointing to the end of the collection of Lagrangian data objects associated with the patch data object.

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

/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LSetData.h
/home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/private/LSetData-inl.h
/home/runner/work/IBAMR/IBAMR/ibtk/src/lagrangian/LSetData.cpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<class T> class IBTK::LSetData< T >

Member Typedef Documentation

◆ CellIterator

◆ DataIterator

◆ SetIterator

Constructor & Destructor Documentation

◆ LSetData()

◆ ~LSetData()

Member Function Documentation

◆ data_begin()

◆ data_end()

template<class T>
class IBTK::LSetData< T >