IBTK::LNodeIndex Class Reference

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

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

Private Member Functions
void	assignThatToThis (const LNodeIndex &that)

Private Attributes
int	d_lagrangian_nidx
int	d_global_petsc_nidx
int	d_local_petsc_nidx
SAMRAI::hier::IntVector< NDIM >	d_offset_0
SAMRAI::hier::IntVector< NDIM >	d_offset
Vector	d_displacement_0
Vector	d_displacement

Constructor & Destructor Documentation

LNodeIndex() [1/3]

IBTK::LNodeIndex::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()  )

inline

LNodeIndex() [2/3]

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

inline

Parameters

from	The value to copy to this object.

LNodeIndex() [3/3]

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

inline

~LNodeIndex()

IBTK::LNodeIndex::~LNodeIndex ( )

inlinevirtual

Member Function Documentation

operator=()

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

inline

Parameters

that	The value to assign to this object.

Returns

A reference to this object.

getLagrangianIndex()

int IBTK::LNodeIndex::getLagrangianIndex ( ) const

inline

Returns

The Lagrangian index referenced by this LNodeIndex object.

setLagrangianIndex()

void IBTK::LNodeIndex::setLagrangianIndex ( int  lagrangian_nidx )

inline

getGlobalPETScIndex()

int IBTK::LNodeIndex::getGlobalPETScIndex ( ) const

inline

Returns

The global PETSc index referenced by this LNodeIndex object.

setGlobalPETScIndex()

void IBTK::LNodeIndex::setGlobalPETScIndex ( int  global_petsc_nidx )

inline

getLocalPETScIndex()

int IBTK::LNodeIndex::getLocalPETScIndex ( ) const

inline

Returns

The local PETSc index referenced by this LNodeIndex object.

setLocalPETScIndex()

void IBTK::LNodeIndex::setLocalPETScIndex ( int  local_petsc_nidx )

inline

registerPeriodicShift()

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

inlinevirtual

Reimplemented in IBTK::LNode.

getInitialPeriodicOffset()

const SAMRAI::hier::IntVector< NDIM > & IBTK::LNodeIndex::getInitialPeriodicOffset ( ) const

inlinevirtual

getPeriodicOffset()

const SAMRAI::hier::IntVector< NDIM > & IBTK::LNodeIndex::getPeriodicOffset ( ) const

inlinevirtual

getInitialPeriodicDisplacement()

const Vector & IBTK::LNodeIndex::getInitialPeriodicDisplacement ( ) const

inlinevirtual

getPeriodicDisplacement()

const Vector & IBTK::LNodeIndex::getPeriodicDisplacement ( ) const

inlinevirtual

copySourceItem()

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

inlinevirtual

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

Reimplemented in IBTK::LNode.

packStream()

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

inlinevirtual

Reimplemented in IBTK::LNode.

unpackStream()

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

inlinevirtual

Reimplemented in IBTK::LNode.

assignThatToThis()

void IBTK::LNodeIndex::assignThatToThis ( const LNodeIndex &  that )

inlineprivate

Assign that to this.

Member Data Documentation

d_lagrangian_nidx

int IBTK::LNodeIndex::d_lagrangian_nidx

private

d_global_petsc_nidx

int IBTK::LNodeIndex::d_global_petsc_nidx

private

d_local_petsc_nidx

int IBTK::LNodeIndex::d_local_petsc_nidx

private

d_offset_0

SAMRAI::hier::IntVector<NDIM> IBTK::LNodeIndex::d_offset_0

private

d_offset

SAMRAI::hier::IntVector<NDIM> IBTK::LNodeIndex::d_offset

private

d_displacement_0

Vector IBTK::LNodeIndex::d_displacement_0

private

d_displacement

Vector IBTK::LNodeIndex::d_displacement

private

---

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

• ibtk/include/ibtk/LNodeIndex.h
• ibtk/include/ibtk/private/LNodeIndex-inl.h