#include <TargetForms.hpp>

Inheritance diagram for polyfem::solver::TargetForm:

Collaboration diagram for polyfem::solver::TargetForm:

Public Member Functions
	TargetForm (const VariableToSimulationGroup &variable_to_simulations, const State &state, const json &args)

	~TargetForm ()=default

virtual std::string	name () const override

void	set_reference (const std::shared_ptr< const State > &target_state, const std::set< int > &reference_cached_body_ids)

void	set_reference (const Eigen::VectorXd &disp)

void	set_reference (const json &func, const json &grad_func)

void	set_active_dimension (const std::vector< bool > &mask)

Public Member Functions inherited from polyfem::solver::SpatialIntegralForm
	SpatialIntegralForm (const VariableToSimulationGroup &variable_to_simulations, const State &state, const json &args)

const State &	get_state ()

Eigen::VectorXd	compute_adjoint_rhs_step (const int time_step, const Eigen::VectorXd &x, const State &state) const override

double	value_unweighted_step (const int time_step, const Eigen::VectorXd &x) const override

void	compute_partial_gradient_step (const int time_step, const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const override

Public Member Functions inherited from polyfem::solver::StaticForm
virtual	~StaticForm ()=default

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

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

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

virtual Eigen::VectorXd	compute_adjoint_rhs_step_prev (const int time_step, const Eigen::VectorXd &x, const State &state) const

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

virtual void	solution_changed_step (const int time_step, const Eigen::VectorXd &new_x)

virtual bool	depends_on_step_prev () const final

	AdjointForm (const VariableToSimulationGroup &variable_to_simulations)

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

virtual	~AdjointForm ()

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 Eigen::MatrixXd	compute_reduced_adjoint_rhs (const Eigen::VectorXd &x, const State &state) 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 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	init (const Eigen::VectorXd &x)
	Initialize the 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 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 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.

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
IntegrableFunctional	get_integral_functional () const override

Protected Member Functions inherited from polyfem::solver::SpatialIntegralForm
void	set_integral_type (const SpatialIntegralType type)

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
std::shared_ptr< const State >	target_state_

std::map< int, int >	e_to_ref_e_

std::vector< bool >	active_dimension_mask

Eigen::VectorXd	target_disp

bool	have_target_func = false

utils::ExpressionValue	target_func

std::array< utils::ExpressionValue, 3 >	target_func_grad

Protected Attributes inherited from polyfem::solver::SpatialIntegralForm
const State &	state_

SpatialIntegralType	spatial_integral_type_

std::set< int >	ids_

Protected Attributes inherited from polyfem::solver::StaticForm
bool	depends_on_step_prev_ = false

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_

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

Detailed Description

Definition at line 11 of file TargetForms.hpp.

Constructor & Destructor Documentation

◆ TargetForm()

polyfem::solver::TargetForm::TargetForm	(	const VariableToSimulationGroup &	variable_to_simulations,
		const State &	state,
		const json &	args
	)

inline

Definition at line 14 of file TargetForms.hpp.

References polyfem::solver::SpatialIntegralForm::ids_, polyfem::solver::SpatialIntegralForm::set_integral_type(), and polyfem::solver::Surface.

Here is the call graph for this function:

◆ ~TargetForm()

polyfem::solver::TargetForm::~TargetForm ( )

default

Member Function Documentation

◆ get_integral_functional()

IntegrableFunctional polyfem::solver::TargetForm::get_integral_functional ( ) const

overrideprotectedvirtual

Implements polyfem::solver::SpatialIntegralForm.

Definition at line 32 of file TargetForms.cpp.

References active_dimension_mask, e_to_ref_e_, have_target_func, polyfem::io::Evaluator::interpolate_at_local_vals(), polyfem::log_and_throw_adjoint_error(), polyfem::State::mesh, name(), polyfem::IntegrableFunctional::set_dj_du(), polyfem::IntegrableFunctional::set_dj_dx(), polyfem::IntegrableFunctional::set_j(), polyfem::solver::SpatialIntegralForm::state_, target_disp, target_func, target_func_grad, target_state_, val, and vals.

Here is the call graph for this function:

◆ name()

virtual std::string polyfem::solver::TargetForm::name ( ) const

inlineoverridevirtual

Reimplemented from polyfem::solver::SpatialIntegralForm.

Definition at line 23 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

Here is the caller graph for this function:

◆ set_active_dimension()

void polyfem::solver::TargetForm::set_active_dimension ( const std::vector< bool > & mask )

inline

Definition at line 28 of file TargetForms.hpp.

References active_dimension_mask.

◆ set_reference() [1/3]

void polyfem::solver::TargetForm::set_reference ( const Eigen::VectorXd & disp )

inline

Definition at line 26 of file TargetForms.hpp.

References target_disp.

◆ set_reference() [2/3]

void polyfem::solver::TargetForm::set_reference	(	const json &	func,
		const json &	grad_func
	)

Definition at line 181 of file TargetForms.cpp.

References have_target_func, polyfem::solver::Form::init(), polyfem::utils::ExpressionValue::init(), target_func, and target_func_grad.

Here is the call graph for this function:

◆ set_reference() [3/3]

void polyfem::solver::TargetForm::set_reference	(	const std::shared_ptr< const State > &	target_state,
		const std::set< int > &	reference_cached_body_ids
	)

Definition at line 135 of file TargetForms.cpp.

References polyfem::adjoint_logger(), polyfem::State::bases, e_to_ref_e_, polyfem::State::mesh, name(), polyfem::solver::SpatialIntegralForm::state_, and target_state_.

Here is the call graph for this function:

Member Data Documentation

◆ active_dimension_mask

std::vector<bool> polyfem::solver::TargetForm::active_dimension_mask

protected

Definition at line 36 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_active_dimension().

◆ e_to_ref_e_

std::map<int, int> polyfem::solver::TargetForm::e_to_ref_e_

protected

Definition at line 34 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

◆ have_target_func

bool polyfem::solver::TargetForm::have_target_func = false

protected

Definition at line 39 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

◆ target_disp

Eigen::VectorXd polyfem::solver::TargetForm::target_disp

protected

Definition at line 37 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

◆ target_func

utils::ExpressionValue polyfem::solver::TargetForm::target_func

protected

Definition at line 40 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

◆ target_func_grad

std::array<utils::ExpressionValue, 3> polyfem::solver::TargetForm::target_func_grad

protected

Definition at line 41 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

◆ target_state_

std::shared_ptr<const State> polyfem::solver::TargetForm::target_state_

protected

Definition at line 33 of file TargetForms.hpp.

Referenced by get_integral_functional(), and set_reference().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TargetForm()

◆ ~TargetForm()

Member Function Documentation

◆ get_integral_functional()

◆ name()

◆ set_active_dimension()

◆ set_reference() [1/3]

◆ set_reference() [2/3]

◆ set_reference() [3/3]

Member Data Documentation

◆ active_dimension_mask

◆ e_to_ref_e_

◆ have_target_func

◆ target_disp

◆ target_func

◆ target_func_grad

◆ target_state_