Form of the inertia. More...

#include <InertiaForm.hpp>

Inheritance diagram for polyfem::solver::InertiaForm:

Collaboration diagram for polyfem::solver::InertiaForm:

Public Types
using	XTildeUpdater = std::function< void(const double, const Eigen::VectorXd &, Eigen::VectorXd &)>

Public Member Functions
	InertiaForm (const StiffnessMatrix &mass, const time_integrator::ImplicitTimeIntegrator &time_integrator)
	Construct a new Inertia Form object.

std::string	name () const override

void	set_x_tilde_updater (XTildeUpdater updater)

void	update_quantities (const double t, const Eigen::VectorXd &x) override
	Update time-dependent fields.

Public Member Functions inherited from polyfem::solver::Form
virtual	~Form ()

virtual void	init (const Eigen::VectorXd &x)
	Initialize the form.

virtual void	finish ()

virtual double	value (const Eigen::VectorXd &x) const
	Compute the value of the form multiplied with the weigth.

Eigen::VectorXd	value_per_element (const Eigen::VectorXd &x) const
	Compute the value of the form multiplied with the weigth.

virtual void	first_derivative (const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const
	Compute the first derivative of the value wrt x multiplied with the weigth.

void	second_derivative (const Eigen::VectorXd &x, StiffnessMatrix &hessian) const
	Compute the second derivative of the value wrt x multiplied with the weigth.

virtual bool	is_step_valid (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const
	Determine if a step from solution x0 to solution x1 is allowed.

virtual double	max_step_size (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const
	Determine the maximum step size allowable between the current and next solution.

virtual void	line_search_begin (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1)
	Initialize variables used during the line search.

virtual void	line_search_end ()
	Clear variables used during the line search.

virtual void	post_step (const polysolve::nonlinear::PostStepData &data)
	Update fields after a step in the optimization.

virtual void	solution_changed (const Eigen::VectorXd &new_x)
	Update cached fields upon a change in the solution.

virtual void	init_lagging (const Eigen::VectorXd &x)
	Initialize lagged fields TODO: more than one step.

virtual void	update_lagging (const Eigen::VectorXd &x, const int iter_num)
	Update lagged fields.

virtual int	max_lagging_iterations () const
	Get the maximum number of lagging iteration allowable.

virtual bool	uses_lagging () const
	Does this form require lagging?

virtual void	set_project_to_psd (bool val)
	Set project to psd.

bool	is_project_to_psd () const
	Get if the form's second derivative is projected to psd.

void	enable ()
	Enable the form.

void	disable ()
	Disable the form.

void	set_enabled (const bool enabled)
	Set if the form is enabled.

bool	enabled () const
	Determine if the form is enabled.

virtual double	weight () const
	Get the form's multiplicative constant weight.

void	set_weight (const double weight)
	Set the form's multiplicative constant weight.

virtual bool	is_step_collision_free (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const
	Checks if the step is collision free.

void	set_output_dir (const std::string &output_dir)

virtual void	set_scale (const double scale)
	sets the scale for the form

Protected Member Functions
double	value_unweighted (const Eigen::VectorXd &x) const override
	Compute the value of the form.

void	first_derivative_unweighted (const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const override
	Compute the first derivative of the value wrt x.

void	second_derivative_unweighted (const Eigen::VectorXd &x, StiffnessMatrix &hessian) const override
	Compute the second derivative of the value wrt x.

Protected Member Functions inherited from polyfem::solver::Form
std::string	resolve_output_path (const std::string &path) const

virtual Eigen::VectorXd	value_per_element_unweighted (const Eigen::VectorXd &x) const
	Compute the value of the form multiplied per element.

Private Member Functions
Eigen::VectorXd	x_tilde () const

Private Attributes
const StiffnessMatrix &	mass_
	Mass matrix.

const time_integrator::ImplicitTimeIntegrator &	time_integrator_
	Time integrator.

XTildeUpdater	x_tilde_updater_

Eigen::VectorXd	x_tilde_

Friends
class	InertiaForceDerivative

Additional Inherited Members
Protected Attributes inherited from polyfem::solver::Form
bool	project_to_psd_ = false
	If true, the form's second derivative is projected to be positive semidefinite.

double	weight_ = 1
	weight of the form (e.g., AL penalty weight or Δt²)

bool	enabled_ = true
	If true, the form is enabled.

std::string	output_dir_

Detailed Description

Form of the inertia.

Definition at line 15 of file InertiaForm.hpp.

Member Typedef Documentation

◆ XTildeUpdater

using polyfem::solver::InertiaForm::XTildeUpdater = std::function<void(const double, const Eigen::VectorXd &, Eigen::VectorXd &)>

Definition at line 28 of file InertiaForm.hpp.

Constructor & Destructor Documentation

◆ InertiaForm()

polyfem::solver::InertiaForm::InertiaForm	(	const StiffnessMatrix &	mass,
		const time_integrator::ImplicitTimeIntegrator &	time_integrator
	)

Construct a new Inertia Form object.

Parameters

mass	Mass matrix
time_integrator	Time integrator

Definition at line 11 of file InertiaForm.cpp.

References x_tilde_.

Member Function Documentation

◆ first_derivative_unweighted()

void polyfem::solver::InertiaForm::first_derivative_unweighted	(	const Eigen::VectorXd &	x,
		Eigen::VectorXd &	gradv
	)		const

overrideprotectedvirtual

Compute the first derivative of the value wrt x.

Parameters

[in]	x	Current solution
[out]	gradv	Output gradient of the value wrt x

Implements polyfem::solver::Form.

Definition at line 48 of file InertiaForm.cpp.

References mass_, x, and x_tilde().

Here is the call graph for this function:

◆ name()

std::string polyfem::solver::InertiaForm::name ( ) const

inlineoverridevirtual

Implements polyfem::solver::Form.

Definition at line 26 of file InertiaForm.hpp.

◆ second_derivative_unweighted()

void polyfem::solver::InertiaForm::second_derivative_unweighted	(	const Eigen::VectorXd &	x,
		StiffnessMatrix &	hessian
	)		const

overrideprotectedvirtual

Compute the second derivative of the value wrt x.

Parameters

[in]	x	Current solution
[out]	hessian	Output Hessian of the value wrt x

Implements polyfem::solver::Form.

Definition at line 53 of file InertiaForm.cpp.

References mass_.

◆ set_x_tilde_updater()

void polyfem::solver::InertiaForm::set_x_tilde_updater ( XTildeUpdater updater )

Definition at line 19 of file InertiaForm.cpp.

References x_tilde_updater_.

◆ update_quantities()

void polyfem::solver::InertiaForm::update_quantities	(	const double	t,
		const Eigen::VectorXd &	x
	)

overridevirtual

Update time-dependent fields.

Parameters

t	Current time
x	Current solution at time t

Reimplemented from polyfem::solver::Form.

Definition at line 30 of file InertiaForm.cpp.

References mass_, time_integrator_, x, polyfem::time_integrator::ImplicitTimeIntegrator::x_tilde(), x_tilde_, and x_tilde_updater_.

Here is the call graph for this function:

◆ value_unweighted()

double polyfem::solver::InertiaForm::value_unweighted ( const Eigen::VectorXd & x ) const

overrideprotectedvirtual

Compute the value of the form.

Parameters

x	Current solution

Returns: Computed value

Implements polyfem::solver::Form.

Definition at line 40 of file InertiaForm.cpp.

References mass_, x, and x_tilde().

Here is the call graph for this function:

◆ x_tilde()

Eigen::VectorXd polyfem::solver::InertiaForm::x_tilde ( ) const

private

Definition at line 24 of file InertiaForm.cpp.

References mass_, and x_tilde_.

Referenced by first_derivative_unweighted(), and value_unweighted().

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ InertiaForceDerivative

friend class InertiaForceDerivative

friend

Definition at line 17 of file InertiaForm.hpp.

Member Data Documentation

◆ mass_

const StiffnessMatrix& polyfem::solver::InertiaForm::mass_

private

Mass matrix.

Definition at line 55 of file InertiaForm.hpp.

Referenced by first_derivative_unweighted(), second_derivative_unweighted(), update_quantities(), value_unweighted(), and x_tilde().

◆ time_integrator_

const time_integrator::ImplicitTimeIntegrator& polyfem::solver::InertiaForm::time_integrator_

private

Time integrator.

Definition at line 56 of file InertiaForm.hpp.

Referenced by update_quantities().

◆ x_tilde_

Eigen::VectorXd polyfem::solver::InertiaForm::x_tilde_

private

Definition at line 58 of file InertiaForm.hpp.

Referenced by InertiaForm(), update_quantities(), and x_tilde().

◆ x_tilde_updater_

XTildeUpdater polyfem::solver::InertiaForm::x_tilde_updater_

private

Definition at line 57 of file InertiaForm.hpp.

Referenced by set_x_tilde_updater(), and update_quantities().

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

src/polyfem/solver/forms/InertiaForm.hpp
src/polyfem/solver/forms/InertiaForm.cpp

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ XTildeUpdater

Constructor & Destructor Documentation

◆ InertiaForm()

Member Function Documentation

◆ first_derivative_unweighted()

◆ name()

◆ second_derivative_unweighted()

◆ set_x_tilde_updater()

◆ update_quantities()

◆ value_unweighted()

◆ x_tilde()

Friends And Related Symbol Documentation

◆ InertiaForceDerivative

Member Data Documentation

◆ mass_

◆ time_integrator_

◆ x_tilde_

◆ x_tilde_updater_