Class IBLagrangianForceStrategy provides a generic interface for specifying nodal forces (not force densities) on the Lagrangian curvilinear mesh. More...

#include <ibamr/IBLagrangianForceStrategy.h>

Inheritance diagram for IBAMR::IBLagrangianForceStrategy:

[legend]

Public Member Functions
	IBLagrangianForceStrategy ()=default
	Default constructor. More...

virtual	~IBLagrangianForceStrategy ()=default
	Virtual destructor. More...

virtual void	setTimeInterval (double current_time, double new_time)
	Set the current and new times for the present timestep. More...

virtual void	initializeLevelData (SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, int level_number, double init_data_time, bool initial_time, IBTK::LDataManager *l_data_manager)
	Setup the data needed to compute the curvilinear force on the specified level of the patch hierarchy. More...

virtual void	computeLagrangianForce (SAMRAI::tbox::Pointer< IBTK::LData > F_data, SAMRAI::tbox::Pointer< IBTK::LData > X_data, SAMRAI::tbox::Pointer< IBTK::LData > U_data, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, int level_number, double data_time, IBTK::LDataManager *l_data_manager)
	Compute the curvilinear force generated by the given configuration of the curvilinear mesh. More...

virtual void	computeLagrangianForceJacobianNonzeroStructure (std::vector< int > &d_nnz, std::vector< int > &o_nnz, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, int level_number, IBTK::LDataManager *l_data_manager)
	Compute the non-zero structure of the force Jacobian matrix. More...

virtual void	computeLagrangianForceJacobian (Mat &J_mat, MatAssemblyType assembly_type, double X_coef, SAMRAI::tbox::Pointer< IBTK::LData > X_data, double U_coef, SAMRAI::tbox::Pointer< IBTK::LData > U_data, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, int level_number, double data_time, IBTK::LDataManager *l_data_manager)
	Compute the Jacobian of the force with respect to the present structure configuration and velocity. More...

virtual double	computeLagrangianEnergy (SAMRAI::tbox::Pointer< IBTK::LData > X_data, SAMRAI::tbox::Pointer< IBTK::LData > U_data, SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > > hierarchy, int level_number, double data_time, IBTK::LDataManager *l_data_manager)
	Compute the potential energy with respect to the present structure configuration and velocity. More...

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

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

Detailed Description

Note: Implementations of class IBLagrangianForceStrategy must compute the total nodal forces. In particular, they must not compute the nodal force densities.

See also: IBBeamForceGen; IBLagrangianForceStrategySet; IBSpringForceGen; IBStandardForceGen; IBTargetPointForceGen

Constructor & Destructor Documentation

◆ IBLagrangianForceStrategy() [1/2]

IBAMR::IBLagrangianForceStrategy::IBLagrangianForceStrategy ( )

default

◆ ~IBLagrangianForceStrategy()

virtual IBAMR::IBLagrangianForceStrategy::~IBLagrangianForceStrategy ( )

virtualdefault

◆ IBLagrangianForceStrategy() [2/2]

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

◆ setTimeInterval()

virtual void IBAMR::IBLagrangianForceStrategy::setTimeInterval	(	double	current_time,
		double	new_time
	)

virtual

Note: A default empty implementation is provided.

Reimplemented in IBAMR::IBLagrangianForceStrategySet.

◆ initializeLevelData()

virtual void IBAMR::IBLagrangianForceStrategy::initializeLevelData	(	SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		double	init_data_time,
		bool	initial_time,
		IBTK::LDataManager *	l_data_manager
	)

virtual

Note: A default empty implementation is provided.

Reimplemented in IBAMR::IBStandardForceGen, and IBAMR::IBLagrangianForceStrategySet.

◆ computeLagrangianForce()

virtual void IBAMR::IBLagrangianForceStrategy::computeLagrangianForce	(	SAMRAI::tbox::Pointer< IBTK::LData >	F_data,
		SAMRAI::tbox::Pointer< IBTK::LData >	X_data,
		SAMRAI::tbox::Pointer< IBTK::LData >	U_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		double	data_time,
		IBTK::LDataManager *	l_data_manager
	)

virtual

Note: Nodal forces computed by implementations of this method must be added to the force vector.; A default implementation is provided that results in an assertion failure.

Reimplemented in IBAMR::IBStandardForceGen, IBAMR::IBLagrangianForceStrategySet, IBAMR::NonbondedForceEvaluator, and IBAMR::WallForceEvaluator.

◆ computeLagrangianForceJacobianNonzeroStructure()

virtual void IBAMR::IBLagrangianForceStrategy::computeLagrangianForceJacobianNonzeroStructure	(	std::vector< int > &	d_nnz,
		std::vector< int > &	o_nnz,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		IBTK::LDataManager *	l_data_manager
	)

virtual

Note: Elements indices must be global PETSc indices.; A default implementation is provided that results in an assertion failure.

Reimplemented in IBAMR::IBStandardForceGen, and IBAMR::IBLagrangianForceStrategySet.

◆ computeLagrangianForceJacobian()

virtual void IBAMR::IBLagrangianForceStrategy::computeLagrangianForceJacobian	(	Mat &	J_mat,
		MatAssemblyType	assembly_type,
		double	X_coef,
		SAMRAI::tbox::Pointer< IBTK::LData >	X_data,
		double	U_coef,
		SAMRAI::tbox::Pointer< IBTK::LData >	U_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		double	data_time,
		IBTK::LDataManager *	l_data_manager
	)

virtual

Note: The elements of the Jacobian should be "accumulated" in the provided matrix J.; A default implementation is provided that results in an assertion failure.

Reimplemented in IBAMR::IBStandardForceGen, and IBAMR::IBLagrangianForceStrategySet.

◆ computeLagrangianEnergy()

virtual double IBAMR::IBLagrangianForceStrategy::computeLagrangianEnergy	(	SAMRAI::tbox::Pointer< IBTK::LData >	X_data,
		SAMRAI::tbox::Pointer< IBTK::LData >	U_data,
		SAMRAI::tbox::Pointer< SAMRAI::hier::PatchHierarchy< NDIM > >	hierarchy,
		int	level_number,
		double	data_time,
		IBTK::LDataManager *	l_data_manager
	)

virtual

Note: A default implementation is provided that results in an assertion failure.

Reimplemented in IBAMR::IBStandardForceGen, and IBAMR::IBLagrangianForceStrategySet.

◆ operator=()

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

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

include/ibamr/IBLagrangianForceStrategy.h

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ IBLagrangianForceStrategy() [1/2]

◆ ~IBLagrangianForceStrategy()

◆ IBLagrangianForceStrategy() [2/2]

Member Function Documentation

◆ setTimeInterval()

◆ initializeLevelData()

◆ computeLagrangianForce()

◆ computeLagrangianForceJacobianNonzeroStructure()

◆ computeLagrangianForceJacobian()

◆ computeLagrangianEnergy()

◆ operator=()