Class IBFEDirectForcingKinematics is a helper class that provides direct forcing IBMethod functionality to the IBFEMethod class.

#include <ibamr/IBFEDirectForcingKinematics.h>

Inheritance diagram for IBAMR::IBFEDirectForcingKinematics:

[legend]

Classes
struct	KinematicsFcnData

Public Types
using	KinematicsFcnPtr = void()(double data_time, Eigen::Vector3d &U_com, Eigen::Vector3d &W_com, void ctx)
	Typedef specifying interface for specifying rigid body velocities. More...

Public Member Functions
EIGEN_MAKE_ALIGNED_OPERATOR_NEW	IBFEDirectForcingKinematics (std::string object_name, SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > input_db, SAMRAI::tbox::Pointer< IBAMR::IBFEMethod > ibfe_method_ops, int part, bool register_for_restart=true)
	Constructor. More...

virtual	~IBFEDirectForcingKinematics ()
	Destructor. More...

void	registerKinematicsFunction (KinematicsFcnPtr comvelfcn, void *ctx=nullptr)
	Register user defined constrained velocity functions. More...

void	registerKinematicsFunction (const KinematicsFcnData &data)
	Register user defined velocity function data. More...

virtual void	setSolveRigidBodyVelocity (const IBTK::FreeRigidDOFVector &solve_rigid_dofs)
	Set what rigid DOFs need to be solved for this particular structure. More...

virtual void	initializeKinematicsData (bool initial_time=true)

virtual void	preprocessIntegrateData (double current_time, double new_time, int num_cycles)

virtual void	forwardEulerStep (double current_time, double new_time, libMesh::PetscVector< double > &X_current_petsc, libMesh::PetscVector< double > &X_half_petsc, libMesh::PetscVector< double > &X_new_petsc)

virtual void	midpointStep (double current_time, double new_time, libMesh::PetscVector< double > &X_current_petsc, libMesh::PetscVector< double > &X_half_petsc, libMesh::PetscVector< double > &X_new_petsc)

virtual void	trapezoidalStep (double current_time, double new_time, libMesh::PetscVector< double > &X_current_petsc, libMesh::PetscVector< double > &X_half_petsc, libMesh::PetscVector< double > &X_new_petsc)

virtual void	computeLagrangianForce (libMesh::PetscVector< double > &F_petsc, libMesh::PetscVector< double > &X_petsc, libMesh::PetscVector< double > &U_petsc, const double data_time)

virtual void	postprocessIntegrateData (double current_time, double new_time, int num_cycles)

const Eigen::Vector3d &	getStructureCOM () const

const Eigen::Vector3d &	getCOMTransVelocity () const

const Eigen::Vector3d &	getCOMRotVelocity () const

void	putToDatabase (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db) override
	Write out object state to the given database. More...

Protected Member Functions
void	computeCOMOfStructure (Eigen::Vector3d &X0)

void	computeMOIOfStructure (Eigen::Matrix3d &I, const Eigen::Vector3d &X0)

Protected Attributes
double	d_current_time

double	d_new_time

double	d_half_time

SAMRAI::tbox::Pointer< IBAMR::IBFEMethod >	d_ibfe_method_ops

int	d_part

std::string	d_object_name

KinematicsFcnData	d_kinematics

double	d_rho

Eigen::Vector3d	d_center_of_mass_initial = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_center_of_mass_current = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_center_of_mass_half = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_center_of_mass_new = Eigen::Vector3d::Zero()

Eigen::Quaterniond	d_quaternion_current = Eigen::Quaterniond::Identity()

Eigen::Quaterniond	d_quaternion_half = Eigen::Quaterniond::Identity()

Eigen::Quaterniond	d_quaternion_new = Eigen::Quaterniond::Identity()

IBTK::FRDV	d_solve_rigid_vel

Eigen::Vector3d	d_trans_vel_current = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_trans_vel_half = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_trans_vel_new = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_rot_vel_current = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_rot_vel_half = Eigen::Vector3d::Zero()

Eigen::Vector3d	d_rot_vel_new = Eigen::Vector3d::Zero()

Eigen::Matrix3d	d_inertia_tensor_initial = Eigen::Matrix3d::Zero()

bool	d_registered_for_restart

Private Member Functions
	IBFEDirectForcingKinematics ()=delete
	Default constructor. More...

	IBFEDirectForcingKinematics (const IBFEDirectForcingKinematics &from)=delete
	Copy constructor. More...

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

void	getFromInput (SAMRAI::tbox::Pointer< SAMRAI::tbox::Database > db, bool is_from_restart)

void	getFromRestart ()

void	computeImposedLagrangianForceDensity (libMesh::PetscVector< double > &F_vec, libMesh::PetscVector< double > &X_vec, libMesh::PetscVector< double > &U_vec, const double data_time)

void	computeMixedLagrangianForceDensity (libMesh::PetscVector< double > &F_vec, libMesh::PetscVector< double > &X_vec, libMesh::PetscVector< double > &U_vec, const double data_time)

Member Typedef Documentation

◆ KinematicsFcnPtr

using IBAMR::IBFEDirectForcingKinematics::KinematicsFcnPtr = void (*)(double data_time, Eigen::Vector3d& U_com, Eigen::Vector3d& W_com, void* ctx)

Constructor & Destructor Documentation

◆ IBFEDirectForcingKinematics() [1/3]

EIGEN_MAKE_ALIGNED_OPERATOR_NEW IBAMR::IBFEDirectForcingKinematics::IBFEDirectForcingKinematics	(	std::string	object_name,
		SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	input_db,
		SAMRAI::tbox::Pointer< IBAMR::IBFEMethod >	ibfe_method_ops,
		int	part,
		bool	register_for_restart = `true`
	)

Since this class has Eigen object members, which have special alignment requirements, we must explicitly override operator new to get the correct aligment for the object as a whole.

◆ ~IBFEDirectForcingKinematics()

virtual IBAMR::IBFEDirectForcingKinematics::~IBFEDirectForcingKinematics ( )

virtual

◆ IBFEDirectForcingKinematics() [2/3]

IBAMR::IBFEDirectForcingKinematics::IBFEDirectForcingKinematics ( )

privatedelete

Note: This constructor is not implemented and should not be used.

◆ IBFEDirectForcingKinematics() [3/3]

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

◆ registerKinematicsFunction() [1/2]

void IBAMR::IBFEDirectForcingKinematics::registerKinematicsFunction	(	KinematicsFcnPtr	comvelfcn,
		void *	ctx = `nullptr`
	)

◆ registerKinematicsFunction() [2/2]

void IBAMR::IBFEDirectForcingKinematics::registerKinematicsFunction ( const KinematicsFcnData & data )

◆ setSolveRigidBodyVelocity()

virtual void IBAMR::IBFEDirectForcingKinematics::setSolveRigidBodyVelocity ( const IBTK::FreeRigidDOFVector & solve_rigid_dofs )

virtual

◆ initializeKinematicsData()

virtual void IBAMR::IBFEDirectForcingKinematics::initializeKinematicsData ( bool initial_time = true )

virtual

Initialize kinematics data only initially.

◆ preprocessIntegrateData()

virtual void IBAMR::IBFEDirectForcingKinematics::preprocessIntegrateData	(	double	current_time,
		double	new_time,
		int	num_cycles
	)

virtual

Preprocess kinematics before hierarchy integrates.

◆ forwardEulerStep()

virtual void IBAMR::IBFEDirectForcingKinematics::forwardEulerStep	(	double	current_time,
		double	new_time,
		libMesh::PetscVector< double > &	X_current_petsc,
		libMesh::PetscVector< double > &	X_half_petsc,
		libMesh::PetscVector< double > &	X_new_petsc
	)

virtual

Advance the positions of the Lagrangian structure using the forward Euler method.

◆ midpointStep()

virtual void IBAMR::IBFEDirectForcingKinematics::midpointStep	(	double	current_time,
		double	new_time,
		libMesh::PetscVector< double > &	X_current_petsc,
		libMesh::PetscVector< double > &	X_half_petsc,
		libMesh::PetscVector< double > &	X_new_petsc
	)

virtual

Advance the positions of the Lagrangian structure using the (explicit) midpoint rule.

◆ trapezoidalStep()

virtual void IBAMR::IBFEDirectForcingKinematics::trapezoidalStep	(	double	current_time,
		double	new_time,
		libMesh::PetscVector< double > &	X_current_petsc,
		libMesh::PetscVector< double > &	X_half_petsc,
		libMesh::PetscVector< double > &	X_new_petsc
	)

virtual

Advance the positions of the Lagrangian structure using the (explicit) trapezoidal rule.

◆ computeLagrangianForce()

virtual void IBAMR::IBFEDirectForcingKinematics::computeLagrangianForce	(	libMesh::PetscVector< double > &	F_petsc,
		libMesh::PetscVector< double > &	X_petsc,
		libMesh::PetscVector< double > &	U_petsc,
		const double	data_time
	)

virtual

Compute the Lagrangian force at the specified time within the current time interval.

◆ postprocessIntegrateData()

virtual void IBAMR::IBFEDirectForcingKinematics::postprocessIntegrateData	(	double	current_time,
		double	new_time,
		int	num_cycles
	)

virtual

Postprocess kinematics after hierarchy integrates.

◆ getStructureCOM()

const Eigen::Vector3d& IBAMR::IBFEDirectForcingKinematics::getStructureCOM ( ) const

inline

Get COM position.

◆ getCOMTransVelocity()

const Eigen::Vector3d& IBAMR::IBFEDirectForcingKinematics::getCOMTransVelocity ( ) const

inline

Get COM translational velocity.

◆ getCOMRotVelocity()

const Eigen::Vector3d& IBAMR::IBFEDirectForcingKinematics::getCOMRotVelocity ( ) const

inline

Get COM rotational velocity.

◆ putToDatabase()

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

overridevirtual

Implements SAMRAI::tbox::Serializable.

◆ computeCOMOfStructure()

void IBAMR::IBFEDirectForcingKinematics::computeCOMOfStructure ( Eigen::Vector3d & X0 )

protected

Compute center of mass of the structure.

◆ computeMOIOfStructure()

void IBAMR::IBFEDirectForcingKinematics::computeMOIOfStructure	(	Eigen::Matrix3d &	I,
		const Eigen::Vector3d &	X0
	)

protected

Compute moment of inertia tensor for the structure.

◆ operator=()

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

◆ getFromInput()

void IBAMR::IBFEDirectForcingKinematics::getFromInput	(	SAMRAI::tbox::Pointer< SAMRAI::tbox::Database >	db,
		bool	is_from_restart
	)

private

Read input values from a given database.

◆ getFromRestart()

void IBAMR::IBFEDirectForcingKinematics::getFromRestart ( )

private

Read object state from the restart file and initialize class data members.

◆ computeImposedLagrangianForceDensity()

void IBAMR::IBFEDirectForcingKinematics::computeImposedLagrangianForceDensity	(	libMesh::PetscVector< double > &	F_vec,
		libMesh::PetscVector< double > &	X_vec,
		libMesh::PetscVector< double > &	U_vec,
		const double	data_time
	)

private

Compute the Lagrangian force at the specified time within the current time interval for structure that has all the imposed DOFs.

◆ computeMixedLagrangianForceDensity()

void IBAMR::IBFEDirectForcingKinematics::computeMixedLagrangianForceDensity	(	libMesh::PetscVector< double > &	F_vec,
		libMesh::PetscVector< double > &	X_vec,
		libMesh::PetscVector< double > &	U_vec,
		const double	data_time
	)

private

Compute the Lagrangian force at the specified time within the current time interval for structure that has both kinds of DOFs (free and imposed).

Member Data Documentation

◆ d_current_time

double IBAMR::IBFEDirectForcingKinematics::d_current_time

protected

◆ d_new_time

double IBAMR::IBFEDirectForcingKinematics::d_new_time

protected

◆ d_half_time

double IBAMR::IBFEDirectForcingKinematics::d_half_time

protected

◆ d_ibfe_method_ops

SAMRAI::tbox::Pointer<IBAMR::IBFEMethod> IBAMR::IBFEDirectForcingKinematics::d_ibfe_method_ops

protected

◆ d_part

int IBAMR::IBFEDirectForcingKinematics::d_part

protected

◆ d_object_name

std::string IBAMR::IBFEDirectForcingKinematics::d_object_name

protected

◆ d_kinematics

KinematicsFcnData IBAMR::IBFEDirectForcingKinematics::d_kinematics

protected

◆ d_rho

double IBAMR::IBFEDirectForcingKinematics::d_rho

protected

◆ d_center_of_mass_initial

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_center_of_mass_initial = Eigen::Vector3d::Zero()

protected

◆ d_center_of_mass_current

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_center_of_mass_current = Eigen::Vector3d::Zero()

protected

◆ d_center_of_mass_half

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_center_of_mass_half = Eigen::Vector3d::Zero()

protected

◆ d_center_of_mass_new

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_center_of_mass_new = Eigen::Vector3d::Zero()

protected

◆ d_quaternion_current

Eigen::Quaterniond IBAMR::IBFEDirectForcingKinematics::d_quaternion_current = Eigen::Quaterniond::Identity()

protected

◆ d_quaternion_half

Eigen::Quaterniond IBAMR::IBFEDirectForcingKinematics::d_quaternion_half = Eigen::Quaterniond::Identity()

protected

◆ d_quaternion_new

Eigen::Quaterniond IBAMR::IBFEDirectForcingKinematics::d_quaternion_new = Eigen::Quaterniond::Identity()

protected

◆ d_solve_rigid_vel

IBTK::FRDV IBAMR::IBFEDirectForcingKinematics::d_solve_rigid_vel

protected

◆ d_trans_vel_current

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_trans_vel_current = Eigen::Vector3d::Zero()

protected

◆ d_trans_vel_half

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_trans_vel_half = Eigen::Vector3d::Zero()

protected

◆ d_trans_vel_new

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_trans_vel_new = Eigen::Vector3d::Zero()

protected

◆ d_rot_vel_current

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_rot_vel_current = Eigen::Vector3d::Zero()

protected

◆ d_rot_vel_half

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_rot_vel_half = Eigen::Vector3d::Zero()

protected

◆ d_rot_vel_new

Eigen::Vector3d IBAMR::IBFEDirectForcingKinematics::d_rot_vel_new = Eigen::Vector3d::Zero()

protected

◆ d_inertia_tensor_initial

Eigen::Matrix3d IBAMR::IBFEDirectForcingKinematics::d_inertia_tensor_initial = Eigen::Matrix3d::Zero()

protected

◆ d_registered_for_restart

bool IBAMR::IBFEDirectForcingKinematics::d_registered_for_restart

protected

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

include/ibamr/IBFEDirectForcingKinematics.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Member Typedef Documentation

◆ KinematicsFcnPtr

Constructor & Destructor Documentation

◆ IBFEDirectForcingKinematics() [1/3]

◆ ~IBFEDirectForcingKinematics()

◆ IBFEDirectForcingKinematics() [2/3]

◆ IBFEDirectForcingKinematics() [3/3]

Member Function Documentation

◆ registerKinematicsFunction() [1/2]

◆ registerKinematicsFunction() [2/2]

◆ setSolveRigidBodyVelocity()

◆ initializeKinematicsData()

◆ preprocessIntegrateData()

◆ forwardEulerStep()

◆ midpointStep()

◆ trapezoidalStep()

◆ computeLagrangianForce()

◆ postprocessIntegrateData()

◆ getStructureCOM()

◆ getCOMTransVelocity()

◆ getCOMRotVelocity()

◆ putToDatabase()

◆ computeCOMOfStructure()

◆ computeMOIOfStructure()

◆ operator=()

◆ getFromInput()

◆ getFromRestart()

◆ computeImposedLagrangianForceDensity()

◆ computeMixedLagrangianForceDensity()

Member Data Documentation

◆ d_current_time

◆ d_new_time

◆ d_half_time

◆ d_ibfe_method_ops

◆ d_part

◆ d_object_name

◆ d_kinematics

◆ d_rho

◆ d_center_of_mass_initial

◆ d_center_of_mass_current

◆ d_center_of_mass_half

◆ d_center_of_mass_new

◆ d_quaternion_current

◆ d_quaternion_half

◆ d_quaternion_new

◆ d_solve_rigid_vel

◆ d_trans_vel_current

◆ d_trans_vel_half

◆ d_trans_vel_new

◆ d_rot_vel_current

◆ d_rot_vel_half

◆ d_rot_vel_new

◆ d_inertia_tensor_initial

◆ d_registered_for_restart