IBAMR::IBAnchorPointSpec Class Reference

Class IBAnchorPointSpec is used to indicate that a particular node of the curvilinear mesh is anchored in place. More...

#include <ibamr/IBAnchorPointSpec.h>

Inheritance diagram for IBAMR::IBAnchorPointSpec:

Classes
class	Factory
	A factory class to rebuild IBAnchorPointSpec objects from SAMRAI::tbox::AbstractStream data streams. More...

Public Member Functions
	IBAnchorPointSpec (int node_idx=IBTK::invalid_index)
	Default constructor. More...
	~IBAnchorPointSpec ()
	Destructor. More...
const int &	getNodeIndex () const
int &	getNodeIndex ()
int	getStreamableClassID () const override
	Return the unique identifier used to specify the IBTK::StreamableFactory object used by the IBTK::StreamableManager to extract Streamable objects from data streams. More...
size_t	getDataStreamSize () const override
	Return an upper bound on the amount of space required to pack the object to a buffer. More...
void	packStream (SAMRAI::tbox::AbstractStream &stream) override
	Pack data into the output stream. More...
virtual void	registerPeriodicShift (const SAMRAI::hier::IntVector< NDIM > &offset, const Vector &displacement)
	Indicate that the Streamable object has been shifted across a periodic boundary. More...

Static Public Member Functions
static void	registerWithStreamableManager ()
	Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBAnchorPointSpec objects are created. More...
static bool	getIsRegisteredWithStreamableManager ()
	Returns a boolean indicating whether the class has been registered with the singleton IBTK::StreamableManager object. More...

Static Public Attributes
static int	STREAMABLE_CLASS_ID

Private Types
using	IBAnchorPointSpecFactory = IBAnchorPointSpec::Factory

Private Member Functions
	IBAnchorPointSpec (const IBAnchorPointSpec &from)=delete
	Copy constructor. More...
IBAnchorPointSpec &	operator= (const IBAnchorPointSpec &that)=delete
	Assignment operator. More...

Private Attributes
int	d_node_idx

Detailed Description

Note

Anchored curvilinear mesh nodes are fixed in space and are not allowed to spread force to the Cartesian grid.

Member Typedef Documentation

IBAnchorPointSpecFactory

using IBAMR::IBAnchorPointSpec::IBAnchorPointSpecFactory = IBAnchorPointSpec::Factory

private

Constructor & Destructor Documentation

IBAnchorPointSpec() [1/2]

IBAMR::IBAnchorPointSpec::IBAnchorPointSpec ( int  node_idx = IBTK::invalid_index )

inline

~IBAnchorPointSpec()

IBAMR::IBAnchorPointSpec::~IBAnchorPointSpec ( )

inline

IBAnchorPointSpec() [2/2]

IBAMR::IBAnchorPointSpec::IBAnchorPointSpec ( const IBAnchorPointSpec &  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

registerWithStreamableManager()

static void IBAMR::IBAnchorPointSpec::registerWithStreamableManager ( )

static

Note

This method is collective on all MPI processes. This is done to ensure that all processes employ the same class ID for the IBAnchorPointSpec class.

getIsRegisteredWithStreamableManager()

bool IBAMR::IBAnchorPointSpec::getIsRegisteredWithStreamableManager ( )

inlinestatic

getNodeIndex() [1/2]

int & IBAMR::IBAnchorPointSpec::getNodeIndex ( ) const

inline

Returns

A const reference to the node index.

getNodeIndex() [2/2]

int& IBAMR::IBAnchorPointSpec::getNodeIndex

(

)

Returns

A non-const reference to the node index.

getStreamableClassID()

int IBAMR::IBAnchorPointSpec::getStreamableClassID ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

getDataStreamSize()

size_t IBAMR::IBAnchorPointSpec::getDataStreamSize ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

packStream()

void IBAMR::IBAnchorPointSpec::packStream ( SAMRAI::tbox::AbstractStream &  stream )

inlineoverridevirtual

Implements IBTK::Streamable.

operator=()

IBAnchorPointSpec& IBAMR::IBAnchorPointSpec::operator= ( const IBAnchorPointSpec &  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.

registerPeriodicShift()

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

virtualinherited

Note

A default empty implementation is provided.

Member Data Documentation

STREAMABLE_CLASS_ID

int IBAMR::IBAnchorPointSpec::STREAMABLE_CLASS_ID

static

The unique class ID for this object type assigned by the IBTK::StreamableManager.

d_node_idx

int IBAMR::IBAnchorPointSpec::d_node_idx

private

The Lagrangian index of the anchored curvilinear mesh node.

---

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

• include/ibamr/IBAnchorPointSpec.h
• include/ibamr/private/IBAnchorPointSpec-inl.h