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).

#include <ibamr/IBTargetPointForceSpec.h>

Inheritance diagram for IBAMR::IBTargetPointForceSpec:

[legend]

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

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. More...

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. 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 IBTargetPointForceSpec 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	IBTargetPointForceSpecFactory = IBTargetPointForceSpec::Factory

Private Member Functions
	IBTargetPointForceSpec (const IBTargetPointForceSpec &from)=delete
	Copy constructor. More...

IBTargetPointForceSpec &	operator= (const IBTargetPointForceSpec &that)=delete
	Assignment operator. More...

Private Attributes
int	d_master_idx

double	d_kappa_target

double	d_eta_target

IBTK::Point	d_X_target

Member Typedef Documentation

◆ IBTargetPointForceSpecFactory

using IBAMR::IBTargetPointForceSpec::IBTargetPointForceSpecFactory = IBTargetPointForceSpec::Factory

private

Constructor & Destructor Documentation

◆ IBTargetPointForceSpec() [1/2]

IBAMR::IBTargetPointForceSpec::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()`
	)

inline

◆ IBTargetPointForceSpec() [2/2]

IBAMR::IBTargetPointForceSpec::IBTargetPointForceSpec ( const IBTargetPointForceSpec & 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::IBTargetPointForceSpec::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 IBTargetPointForceSpec class.

◆ getIsRegisteredWithStreamableManager()

bool IBAMR::IBTargetPointForceSpec::getIsRegisteredWithStreamableManager ( )

inlinestatic

◆ getMasterNodeIndex() [1/2]

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

inline

Returns: A const reference to the master node index.

◆ getMasterNodeIndex() [2/2]

int& IBAMR::IBTargetPointForceSpec::getMasterNodeIndex ( )

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

◆ getStiffness() [1/2]

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

inline

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

◆ getStiffness() [2/2]

double& IBAMR::IBTargetPointForceSpec::getStiffness ( )

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

◆ getDamping() [1/2]

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

inline

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

◆ getDamping() [2/2]

double& IBAMR::IBTargetPointForceSpec::getDamping ( )

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

◆ getTargetPointPosition() [1/2]

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

inline

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

◆ getTargetPointPosition() [2/2]

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

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

◆ getStreamableClassID()

int IBAMR::IBTargetPointForceSpec::getStreamableClassID ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

◆ getDataStreamSize()

size_t IBAMR::IBTargetPointForceSpec::getDataStreamSize ( ) const

inlineoverridevirtual

Implements IBTK::Streamable.

◆ packStream()

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

inlineoverridevirtual

Implements IBTK::Streamable.

◆ operator=()

IBTargetPointForceSpec& IBAMR::IBTargetPointForceSpec::operator= ( const IBTargetPointForceSpec & 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::IBTargetPointForceSpec::STREAMABLE_CLASS_ID

static

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

◆ d_master_idx

int IBAMR::IBTargetPointForceSpec::d_master_idx

private

Data required to define the target point penalty forces.

◆ d_kappa_target

double IBAMR::IBTargetPointForceSpec::d_kappa_target

private

◆ d_eta_target

double IBAMR::IBTargetPointForceSpec::d_eta_target

private

◆ d_X_target

IBTK::Point IBAMR::IBTargetPointForceSpec::d_X_target

private

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

include/ibamr/IBTargetPointForceSpec.h
include/ibamr/private/IBTargetPointForceSpec-inl.h

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ IBTargetPointForceSpecFactory

Constructor & Destructor Documentation

◆ IBTargetPointForceSpec() [1/2]

◆ IBTargetPointForceSpec() [2/2]

Member Function Documentation

◆ registerWithStreamableManager()

◆ getIsRegisteredWithStreamableManager()

◆ getMasterNodeIndex() [1/2]

◆ getMasterNodeIndex() [2/2]

◆ getStiffness() [1/2]

◆ getStiffness() [2/2]

◆ getDamping() [1/2]

◆ getDamping() [2/2]

◆ getTargetPointPosition() [1/2]

◆ getTargetPointPosition() [2/2]

◆ getStreamableClassID()

◆ getDataStreamSize()

◆ packStream()

◆ operator=()

◆ registerPeriodicShift()

Member Data Documentation

◆ STREAMABLE_CLASS_ID

◆ d_master_idx

◆ d_kappa_target

◆ d_eta_target

◆ d_X_target