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

#include </home/runner/work/IBAMR/IBAMR/include/ibamr/IBAnchorPointSpec.h>

Inheritance diagram for IBAMR::IBAnchorPointSpec:

[legend]

Public Member Functions
	IBAnchorPointSpec (int node_idx=IBTK::invalid_index)
	Default constructor.

	~IBAnchorPointSpec ()
	Destructor.

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.

size_t	getDataStreamSize () const override
	Return an upper bound on the amount of space required to pack the object to a buffer.

void	packStream (SAMRAI::tbox::AbstractStream &stream) override
	Pack data into the output stream.

Public Member Functions inherited from IBTK::Streamable
	Streamable ()=default
	Default empty constructor.

virtual	~Streamable ()=default
	Virtual destructor.

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.

Static Public Attributes
static int	STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID()

Detailed Description

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

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

Member Function Documentation

◆ getNodeIndex() [1/2]

int & IBAMR::IBAnchorPointSpec::getNodeIndex ( )

inline

Returns: A non-const reference to the node index.

◆ getNodeIndex() [2/2]

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

inline

Returns: A const reference to the node index.

◆ registerWithStreamableManager()

void IBAMR::IBAnchorPointSpec::registerWithStreamableManager ( )

static

Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBAnchorPointSpec objects are created.

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.

Member Data Documentation

◆ STREAMABLE_CLASS_ID

int IBAMR::IBAnchorPointSpec::STREAMABLE_CLASS_ID = StreamableManager::getUnregisteredID()

static

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

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

/home/runner/work/IBAMR/IBAMR/include/ibamr/IBAnchorPointSpec.h
/home/runner/work/IBAMR/IBAMR/include/ibamr/private/IBAnchorPointSpec-inl.h
/home/runner/work/IBAMR/IBAMR/src/IB/IBAnchorPointSpec.cpp

Public Member Functions

Static Public Member Functions