IBAMR::IBTargetPointForceSpec Class Reference

Class IBTargetPointForceSpec encapsulates the data necessary to compute the penalty force generated by a single fixed target point (i.e., a force that approximately imposes a Dirichlet boundary condition at a single node of the Lagrangian mesh). More...

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

Inheritance diagram for IBAMR::IBTargetPointForceSpec:

Public Member Functions
	IBTargetPointForceSpec (int master_idx=IBTK::invalid_index, double kappa_target=0.0, double eta_target=0.0, const IBTK::Point &X_target=IBTK::Point::Zero())
	Default constructor.
const int &	getMasterNodeIndex () const
int &	getMasterNodeIndex ()
const double &	getStiffness () const
double &	getStiffness ()
const double &	getDamping () const
double &	getDamping ()
const IBTK::Point &	getTargetPointPosition () const
IBTK::Point &	getTargetPointPosition ()
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 IBTargetPointForceSpec 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 IBTargetPointForceSpec encapsulates the data necessary to compute the penalty force generated by a single fixed target point (i.e., a force that approximately imposes a Dirichlet boundary condition at a single node of the Lagrangian mesh).

Member Function Documentation

getDamping() [1/2]

double & IBAMR::IBTargetPointForceSpec::getDamping ( )

inline

Returns

A non-const reference to the damping factor of the spring attached to the target point.

getDamping() [2/2]

const double & IBAMR::IBTargetPointForceSpec::getDamping ( ) const

inline

Returns

A const reference to the damping factor of the spring attached to the target point.

getMasterNodeIndex() [1/2]

int & IBAMR::IBTargetPointForceSpec::getMasterNodeIndex ( )

inline

Returns

A non-const reference to the master node index.

getMasterNodeIndex() [2/2]

const int & IBAMR::IBTargetPointForceSpec::getMasterNodeIndex ( ) const

inline

Returns

A const reference to the master node index.

getStiffness() [1/2]

double & IBAMR::IBTargetPointForceSpec::getStiffness ( )

inline

Returns

A non-const reference to the stiffness of the spring attached to the target point.

getStiffness() [2/2]

const double & IBAMR::IBTargetPointForceSpec::getStiffness ( ) const

inline

Returns

A const reference to the stiffness of the spring attached to the target point.

getTargetPointPosition() [1/2]

IBTK::Point & IBAMR::IBTargetPointForceSpec::getTargetPointPosition ( )

inline

Returns

A non-const reference to the position of the target point attached to the node.

getTargetPointPosition() [2/2]

const IBTK::Point & IBAMR::IBTargetPointForceSpec::getTargetPointPosition ( ) const

inline

Returns

A const reference to the position of the target point attached to the node.

registerWithStreamableManager()

void IBAMR::IBTargetPointForceSpec::registerWithStreamableManager ( )

static

Register this class and its factory class with the singleton IBTK::StreamableManager object. This method must be called before any IBTargetPointForceSpec 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 IBTargetPointForceSpec class.

Member Data Documentation

STREAMABLE_CLASS_ID

int IBAMR::IBTargetPointForceSpec::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/IBTargetPointForceSpec.h
• /home/runner/work/IBAMR/IBAMR/include/ibamr/private/IBTargetPointForceSpec-inl.h
• /home/runner/work/IBAMR/IBAMR/src/IB/IBTargetPointForceSpec.cpp