IBAMR::ConstraintIBKinematics Class Reference

Class ConstraintIBKinematics encapsulates structure information and provides abstraction to get kinematics (deformational or imposed) of immersed structure to ConstraintIBMethod class.

#include <ibamr/ConstraintIBKinematics.h>

Inheritance diagram for IBAMR::ConstraintIBKinematics:

Classes
class	StructureParameters

Public Member Functions
	ConstraintIBKinematics (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, IBTK::LDataManager *l_data_manager, bool register_for_restart=true)
	Constructor. More...
virtual	~ConstraintIBKinematics ()
	Destructor. More...
const StructureParameters &	getStructureParameters () const
	Get the object enclosing this structure's parameters. More...
virtual void	setKinematicsVelocity (const double time, const std::vector< double > &incremented_angle_from_reference_axis, const std::vector< double > &center_of_mass, const std::vector< double > &tagged_pt_position)=0
	Set the kinematics velocity (deformational or imposed) at Lagrangian points managed by this object. More...
virtual const std::vector< std::vector< double > > &	getKinematicsVelocity (const int level) const =0
	Get the kinematics velocity for the structure on the specified level. More...
virtual void	setShape (const double time, const std::vector< double > &incremented_angle_from_reference_axis)=0
	Set the shape of structure at the required time. The shape should have its center of mass at origin, with appropriate rigid body ratation applied to it. More...
virtual const std::vector< std::vector< double > > &	getShape (const int level) const =0
	Get the shape of structure on the specified level. More...
virtual void	putToDatabase (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db) override
	Write out object state to the given database. More...

Protected Attributes
std::string	d_object_name
bool	d_registered_for_restart = false

Private Member Functions
	ConstraintIBKinematics ()=delete
	Deleted default ctor. More...
	ConstraintIBKinematics (const ConstraintIBKinematics &from)=delete
	Deleted default copy ctor. More...
ConstraintIBKinematics &	operator= (const ConstraintIBKinematics &that)=delete
	Deleted default assignment. More...

Private Attributes
StructureParameters	d_struct_param
	Object enclosing all the parameters of the structure. More...

Constructor & Destructor Documentation

ConstraintIBKinematics() [1/3]

IBAMR::ConstraintIBKinematics::ConstraintIBKinematics	(	std::string	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		IBTK::LDataManager *	l_data_manager,
		bool	register_for_restart = true
	)

~ConstraintIBKinematics()

virtual IBAMR::ConstraintIBKinematics::~ConstraintIBKinematics ( )

virtual

ConstraintIBKinematics() [2/3]

IBAMR::ConstraintIBKinematics::ConstraintIBKinematics ( )

privatedelete

ConstraintIBKinematics() [3/3]

IBAMR::ConstraintIBKinematics::ConstraintIBKinematics ( const ConstraintIBKinematics &  from )

privatedelete

Member Function Documentation

getStructureParameters()

const StructureParameters& IBAMR::ConstraintIBKinematics::getStructureParameters ( ) const

inline

setKinematicsVelocity()

virtual void IBAMR::ConstraintIBKinematics::setKinematicsVelocity ( const double  time, const std::vector< double > &  incremented_angle_from_reference_axis, const std::vector< double > &  center_of_mass, const std::vector< double > &  tagged_pt_position  )

pure virtual

Parameters

time	Time at which kinematics velocity is to be set.
incremented_angle_from_reference_axis	Angle made with x,y & z axis due to rigid rotational velocity. \( \theta_n = \theta_{n-1} + \omega_{n-1} \triangle t \)
center_of_mass	COM of the structure at the given time.
tagged_pt_position	Coordinates of the tagged point of the structure.

getKinematicsVelocity()

virtual const std::vector<std::vector<double> >& IBAMR::ConstraintIBKinematics::getKinematicsVelocity ( const int  level ) const

pure virtual

Parameters

level

Kinematics velocity of the structure on this level.

setShape()

virtual void IBAMR::ConstraintIBKinematics::setShape ( const double  time, const std::vector< double > &  incremented_angle_from_reference_axis  )

pure virtual

Parameters

time	Time at which kinematics velocity is to be set.
incremented_angle_from_reference_axis	Angle made with x,y & z axis due to rigid rotational velocity. \( \theta_n = \theta_{n-1} + \omega_{n-1} \triangle t \).

Note

The call to setShape() is made after setKinematicsVelocity( ) with the same value of the common arguments.

getShape()

virtual const std::vector<std::vector<double> >& IBAMR::ConstraintIBKinematics::getShape ( const int  level ) const

pure virtual

Parameters

level

putToDatabase()

virtual void IBAMR::ConstraintIBKinematics::putToDatabase ( SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >  db )

overridevirtual

Note

An empty default implementation is provided.

Implements SAMRAI::tbox::Serializable.

operator=()

ConstraintIBKinematics& IBAMR::ConstraintIBKinematics::operator= ( const ConstraintIBKinematics &  that )

privatedelete

Member Data Documentation

d_object_name

std::string IBAMR::ConstraintIBKinematics::d_object_name

protected

Name of the object.

d_registered_for_restart

bool IBAMR::ConstraintIBKinematics::d_registered_for_restart = false

protected

If the object is registred for restart.

d_struct_param

StructureParameters IBAMR::ConstraintIBKinematics::d_struct_param

private

---

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

• include/ibamr/ConstraintIBKinematics.h