IBTK::LNodeIndex Class Reference

Class LNodeIndex provides Lagrangian and PETSc indexing information for a single node of a Lagrangian mesh. More...

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

Inheritance diagram for IBTK::LNodeIndex:

Public Member Functions
	LNodeIndex (int lagrangian_nidx=-1, int global_petsc_nidx=-1, int local_petsc_nidx=-1, const SAMRAI::hier::IntVector< NDIM > &initial_periodic_offset=SAMRAI::hier::IntVector< NDIM >(0), const SAMRAI::hier::IntVector< NDIM > &current_periodic_offset=SAMRAI::hier::IntVector< NDIM >(0), const Vector &initial_periodic_displacement=Vector::Zero(), const Vector &current_periodic_displacement=Vector::Zero())
	Default constructor.
	LNodeIndex (const LNodeIndex &from)
	Copy constructor.
	LNodeIndex (SAMRAI::tbox::AbstractStream &stream, const SAMRAI::hier::IntVector< NDIM > &offset)
	Constructor that unpacks data from an input stream.
virtual	~LNodeIndex ()
	Virtual destructor.
LNodeIndex &	operator= (const LNodeIndex &that)
	Assignment operator.
int	getLagrangianIndex () const
void	setLagrangianIndex (int lagrangian_nidx)
	Reset the Lagrangian index referenced by this LNodeIndex object.
int	getGlobalPETScIndex () const
void	setGlobalPETScIndex (int global_petsc_nidx)
	Reset the global PETSc index referenced by this LNodeIndex object.
int	getLocalPETScIndex () const
void	setLocalPETScIndex (int local_petsc_nidx)
	Reset the local PETSc index referenced by this LNodeIndex object.
virtual void	registerPeriodicShift (const SAMRAI::hier::IntVector< NDIM > &offset, const Vector &displacement)
	Indicate that the LNodeIndex object has been shifted across a periodic boundary.
virtual const SAMRAI::hier::IntVector< NDIM > &	getInitialPeriodicOffset () const
	Get the initial (t = 0) periodic offset.
virtual const SAMRAI::hier::IntVector< NDIM > &	getPeriodicOffset () const
	Get the periodic offset.
virtual const Vector &	getInitialPeriodicDisplacement () const
	Get the initial (t = 0) periodic displacement.
virtual const Vector &	getPeriodicDisplacement () const
	Get the periodic displacement.
virtual void	copySourceItem (const SAMRAI::hier::Index< NDIM > &src_index, const SAMRAI::hier::IntVector< NDIM > &src_offset, const LNodeIndex &src_item)
	Copy data from the source.
virtual size_t	getDataStreamSize () const
	Return an upper bound on the amount of space required to pack the object to a buffer.
virtual void	packStream (SAMRAI::tbox::AbstractStream &stream)
	Pack data into the output stream.
virtual void	unpackStream (SAMRAI::tbox::AbstractStream &stream, const SAMRAI::hier::IntVector< NDIM > &offset)
	Unpack data from the input stream.

Detailed Description

Class LNodeIndex provides Lagrangian and PETSc indexing information for a single node of a Lagrangian mesh.

Constructor & Destructor Documentation

LNodeIndex()

IBTK::LNodeIndex::LNodeIndex ( const LNodeIndex &  from )

inline

Copy constructor.

Parameters

from	The value to copy to this object.

Member Function Documentation

copySourceItem()

void IBTK::LNodeIndex::copySourceItem ( const SAMRAI::hier::Index< NDIM > &  src_index, const SAMRAI::hier::IntVector< NDIM > &  src_offset, const LNodeIndex &  src_item  )

inlinevirtual

Copy data from the source.

Note

The cell index of the destination object is src_index + src_offset.

Reimplemented in IBTK::LNode.

getDataStreamSize()

size_t IBTK::LNodeIndex::getDataStreamSize ( ) const

inlinevirtual

Return an upper bound on the amount of space required to pack the object to a buffer.

Reimplemented in IBTK::LNode.

getGlobalPETScIndex()

int IBTK::LNodeIndex::getGlobalPETScIndex ( ) const

inline

Returns

The global PETSc index referenced by this LNodeIndex object.

getLagrangianIndex()

int IBTK::LNodeIndex::getLagrangianIndex ( ) const

inline

Returns

The Lagrangian index referenced by this LNodeIndex object.

getLocalPETScIndex()

int IBTK::LNodeIndex::getLocalPETScIndex ( ) const

inline

Returns

The local PETSc index referenced by this LNodeIndex object.

operator=()

LNodeIndex & IBTK::LNodeIndex::operator= ( const LNodeIndex &  that )

inline

Assignment operator.

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

packStream()

void IBTK::LNodeIndex::packStream ( SAMRAI::tbox::AbstractStream &  stream )

inlinevirtual

Pack data into the output stream.

Reimplemented in IBTK::LNode.

registerPeriodicShift()

void IBTK::LNodeIndex::registerPeriodicShift ( const SAMRAI::hier::IntVector< NDIM > &  offset, const Vector &  displacement  )

inlinevirtual

Indicate that the LNodeIndex object has been shifted across a periodic boundary.

Reimplemented in IBTK::LNode.

unpackStream()

void IBTK::LNodeIndex::unpackStream ( SAMRAI::tbox::AbstractStream &  stream, const SAMRAI::hier::IntVector< NDIM > &  offset  )

inlinevirtual

Unpack data from the input stream.

Reimplemented in IBTK::LNode.

---

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

• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/LNodeIndex.h
• /home/runner/work/IBAMR/IBAMR/ibtk/include/ibtk/private/LNodeIndex-inl.h