#include <CompositeForm.hpp>

Inheritance diagram for polyfem::solver::CompositeForm:

Collaboration diagram for polyfem::solver::CompositeForm:

Public Member Functions
	CompositeForm (const VariableToSimulationGroup &variable_to_simulations, const std::vector< std::shared_ptr< AdjointForm > > &forms)

	CompositeForm (const std::vector< std::shared_ptr< AdjointForm > > &forms)

virtual	~CompositeForm ()

virtual int	n_objs () const final

virtual Eigen::MatrixXd	compute_reduced_adjoint_rhs (const Eigen::VectorXd &x, const State &state) const override final

virtual void	compute_partial_gradient (const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const override final

virtual double	compose (const Eigen::VectorXd &inputs) const =0

virtual Eigen::VectorXd	compose_grad (const Eigen::VectorXd &inputs) const =0

Eigen::VectorXd	get_inputs (const Eigen::VectorXd &x) const

virtual double	value_unweighted (const Eigen::VectorXd &x) const final override
	Compute the value of the form.

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

virtual bool	is_step_valid (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const final override
	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 final override
	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) final override
	Initialize variables used during the line search.

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

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

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

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

Public Member Functions inherited from polyfem::solver::AdjointForm
	AdjointForm (const VariableToSimulationGroup &variable_to_simulations)

virtual	~AdjointForm ()

virtual std::string	name () const override

void	enable_energy_print (const std::string &print_energy_keyword)

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

const VariableToSimulationGroup &	get_variable_to_simulations () const

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

virtual Eigen::MatrixXd	compute_adjoint_rhs (const Eigen::VectorXd &x, const State &state) const

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

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

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

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

virtual void	finish ()

Eigen::VectorXd	value_per_element (const Eigen::VectorXd &x) const
	Compute the value of the form 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 int	max_lagging_iterations () const
	Get the maximum number of lagging iteration allowable.

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

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.

void	set_output_dir (const std::string &output_dir)

Private Attributes
friend	AdjointForm

std::vector< std::shared_ptr< AdjointForm > >	forms_

Additional Inherited Members
Protected Types inherited from polyfem::solver::AdjointForm
enum class	PrintStage { Inactive , AlreadyPrinted , ToPrint }

Protected Member Functions inherited from polyfem::solver::AdjointForm
virtual void	first_derivative_unweighted (const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const final override
	Compute the first derivative of the value wrt x.

virtual void	second_derivative_unweighted (const Eigen::VectorXd &x, StiffnessMatrix &hessian) const final 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.

Protected Attributes inherited from polyfem::solver::AdjointForm
const VariableToSimulationGroup	variable_to_simulations_

PrintStage	print_energy_ = PrintStage::Inactive

std::string	print_energy_keyword_

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

Definition at line 9 of file CompositeForm.hpp.

Constructor & Destructor Documentation

◆ CompositeForm() [1/2]

polyfem::solver::CompositeForm::CompositeForm	(	const VariableToSimulationGroup &	variable_to_simulations,
		const std::vector< std::shared_ptr< AdjointForm > > &	forms
	)

inline

Definition at line 13 of file CompositeForm.hpp.

◆ CompositeForm() [2/2]

polyfem::solver::CompositeForm::CompositeForm ( const std::vector< std::shared_ptr< AdjointForm > > & forms )

inline

Definition at line 14 of file CompositeForm.hpp.

◆ ~CompositeForm()

virtual polyfem::solver::CompositeForm::~CompositeForm ( )

inlinevirtual

Definition at line 15 of file CompositeForm.hpp.

Member Function Documentation

◆ compose()

virtual double polyfem::solver::CompositeForm::compose ( const Eigen::VectorXd & inputs ) const

pure virtual

Implemented in polyfem::solver::HomoCompositeForm, polyfem::solver::NegativeCompositeForm, polyfem::solver::PlusConstCompositeForm, polyfem::solver::InequalityConstraintForm, polyfem::solver::PowerForm, polyfem::solver::DivideForm, and polyfem::solver::SumCompositeForm.

Referenced by value_unweighted().

Here is the caller graph for this function:

◆ compose_grad()

virtual Eigen::VectorXd polyfem::solver::CompositeForm::compose_grad ( const Eigen::VectorXd & inputs ) const

pure virtual

Implemented in polyfem::solver::HomoCompositeForm, polyfem::solver::NegativeCompositeForm, polyfem::solver::PlusConstCompositeForm, polyfem::solver::InequalityConstraintForm, polyfem::solver::PowerForm, polyfem::solver::DivideForm, and polyfem::solver::SumCompositeForm.

Referenced by compute_partial_gradient(), and compute_reduced_adjoint_rhs().

Here is the caller graph for this function:

◆ compute_partial_gradient()

void polyfem::solver::CompositeForm::compute_partial_gradient	(	const Eigen::VectorXd &	x,
		Eigen::VectorXd &	gradv
	)		const

finaloverridevirtual

Reimplemented from polyfem::solver::AdjointForm.

Definition at line 23 of file CompositeForm.cpp.

References compose_grad(), forms_, get_inputs(), polyfem::solver::Form::weight(), and x.

Here is the call graph for this function:

◆ compute_reduced_adjoint_rhs()

Eigen::MatrixXd polyfem::solver::CompositeForm::compute_reduced_adjoint_rhs	(	const Eigen::VectorXd &	x,
		const State &	state
	)		const

finaloverridevirtual

Reimplemented from polyfem::solver::AdjointForm.

Definition at line 6 of file CompositeForm.cpp.

References compose_grad(), forms_, get_inputs(), polyfem::solver::Form::weight(), and x.

Here is the call graph for this function:

◆ get_inputs()

Eigen::VectorXd polyfem::solver::CompositeForm::get_inputs ( const Eigen::VectorXd & x ) const

Definition at line 37 of file CompositeForm.cpp.

References forms_, and x.

Referenced by compute_partial_gradient(), compute_reduced_adjoint_rhs(), and value_unweighted().

Here is the caller graph for this function:

◆ init()

void polyfem::solver::CompositeForm::init ( const Eigen::VectorXd & x )

finaloverridevirtual

Initialize the form.

Parameters

x	Current solution

Reimplemented from polyfem::solver::Form.

Definition at line 53 of file CompositeForm.cpp.

References forms_, and x.

◆ is_step_collision_free()

bool polyfem::solver::CompositeForm::is_step_collision_free	(	const Eigen::VectorXd &	x0,
		const Eigen::VectorXd &	x1
	)		const

finaloverridevirtual

Checks if the step is collision free.

Returns: True if the step is collision free else false

Reimplemented from polyfem::solver::Form.

Definition at line 103 of file CompositeForm.cpp.

References forms_.

◆ is_step_valid()

bool polyfem::solver::CompositeForm::is_step_valid	(	const Eigen::VectorXd &	x0,
		const Eigen::VectorXd &	x1
	)		const

finaloverridevirtual

Determine if a step from solution x0 to solution x1 is allowed.

Parameters

x0	Current solution
x1	Proposed next solution

Returns: True if the step is allowed

Reimplemented from polyfem::solver::Form.

Definition at line 59 of file CompositeForm.cpp.

References forms_.

◆ line_search_begin()

void polyfem::solver::CompositeForm::line_search_begin	(	const Eigen::VectorXd &	x0,
		const Eigen::VectorXd &	x1
	)

finaloverridevirtual

Initialize variables used during the line search.

Parameters

x0	Current solution
x1	Next solution

Reimplemented from polyfem::solver::Form.

Definition at line 79 of file CompositeForm.cpp.

References forms_.

◆ line_search_end()

void polyfem::solver::CompositeForm::line_search_end ( )

finaloverridevirtual

Clear variables used during the line search.

Reimplemented from polyfem::solver::Form.

Definition at line 85 of file CompositeForm.cpp.

References forms_.

◆ max_step_size()

double polyfem::solver::CompositeForm::max_step_size	(	const Eigen::VectorXd &	x0,
		const Eigen::VectorXd &	x1
	)		const

finaloverridevirtual

Determine the maximum step size allowable between the current and next solution.

Parameters

x0	Current solution (step size = 0)
x1	Next solution (step size = 1)

Returns: Maximum allowable step size

Reimplemented from polyfem::solver::Form.

Definition at line 69 of file CompositeForm.cpp.

References forms_.

◆ n_objs()

virtual int polyfem::solver::CompositeForm::n_objs ( ) const

inlinefinalvirtual

Definition at line 17 of file CompositeForm.hpp.

References forms_.

◆ post_step()

void polyfem::solver::CompositeForm::post_step ( const polysolve::nonlinear::PostStepData & data )

finaloverridevirtual

Update fields after a step in the optimization.

Parameters

iter_num	Optimization iteration number
x	Current solution
data	Data containing info about the current iteration

Reimplemented from polyfem::solver::Form.

Definition at line 91 of file CompositeForm.cpp.

References forms_.

◆ solution_changed()

void polyfem::solver::CompositeForm::solution_changed ( const Eigen::VectorXd & new_x )

finaloverridevirtual

Update cached fields upon a change in the solution.

Parameters

new_x New solution

Reimplemented from polyfem::solver::AdjointForm.

Definition at line 97 of file CompositeForm.cpp.

References forms_, and polyfem::solver::AdjointForm::solution_changed().

Here is the call graph for this function:

◆ value_unweighted()

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

finaloverridevirtual

Compute the value of the form.

Parameters

x	Current solution

Returns: Computed value

Implements polyfem::solver::Form.

Definition at line 48 of file CompositeForm.cpp.

References compose(), get_inputs(), and x.

Here is the call graph for this function:

Member Data Documentation

◆ AdjointForm

friend polyfem::solver::CompositeForm::AdjointForm

private

Definition at line 11 of file CompositeForm.hpp.

◆ forms_

std::vector<std::shared_ptr<AdjointForm> > polyfem::solver::CompositeForm::forms_

private

Definition at line 38 of file CompositeForm.hpp.

Referenced by compute_partial_gradient(), compute_reduced_adjoint_rhs(), get_inputs(), init(), is_step_collision_free(), is_step_valid(), line_search_begin(), line_search_end(), max_step_size(), n_objs(), post_step(), and solution_changed().

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

src/polyfem/solver/forms/adjoint_forms/CompositeForm.hpp
src/polyfem/solver/forms/adjoint_forms/CompositeForm.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CompositeForm() [1/2]

◆ CompositeForm() [2/2]

◆ ~CompositeForm()

Member Function Documentation

◆ compose()

◆ compose_grad()

◆ compute_partial_gradient()

◆ compute_reduced_adjoint_rhs()

◆ get_inputs()

◆ init()

◆ is_step_collision_free()

◆ is_step_valid()

◆ line_search_begin()

◆ line_search_end()

◆ max_step_size()

◆ n_objs()

◆ post_step()

◆ solution_changed()

◆ value_unweighted()

Member Data Documentation

◆ AdjointForm

◆ forms_