Loading [MathJax]/extensions/tex2jax.js
PolyFEM
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
polyfem::solver::PeriodicLagrangianForm Class Reference

Form of the augmented lagrangian for bc constraints. More...

#include <PeriodicLagrangianForm.hpp>

Inheritance diagram for polyfem::solver::PeriodicLagrangianForm:
[legend]
Collaboration diagram for polyfem::solver::PeriodicLagrangianForm:
[legend]

Public Member Functions

 PeriodicLagrangianForm (const int ndof, const std::shared_ptr< utils::PeriodicBoundary > &periodic_bc)
 Construct a new PeriodicLagrangianForm object.
 
std::string name () const override
 
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.
 
void update_quantities (const double t, const Eigen::VectorXd &x) override
 Update time dependent quantities.
 
void update_lagrangian (const Eigen::VectorXd &x, const double k_al) override
 
double compute_error (const Eigen::VectorXd &x) const override
 
virtual bool can_project () const override
 
virtual void project_gradient (Eigen::VectorXd &grad) const override
 
virtual void project_hessian (StiffnessMatrix &hessian) const override
 
- Public Member Functions inherited from polyfem::solver::AugmentedLagrangianForm
 AugmentedLagrangianForm ()
 
virtual ~AugmentedLagrangianForm ()
 
void set_initial_weight (const double k_al)
 
double lagrangian_weight () const
 
const StiffnessMatrixconstraint_matrix () const
 
const Eigen::MatrixXd & constraint_value () const
 
const StiffnessMatrixconstraint_projection_matrix () const
 
const Eigen::MatrixXd & constraint_projection_vector () const
 
bool has_projection () const
 
void set_scale (const double scale) override
 sets the scale for the form
 
- 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?
 
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)
 

Private Attributes

const std::shared_ptr< utils::PeriodicBoundaryperiodic_bc_
 
const int n_dofs_
 
Eigen::VectorXi constraints_
 Constraints.
 
Eigen::VectorXi not_constraints_
 Not Constraints.
 

Additional Inherited Members

- Protected Member Functions inherited from polyfem::solver::AugmentedLagrangianForm
double L_weight () const
 
double A_weight () const
 
- 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::AugmentedLagrangianForm
double k_al_
 penalty parameter
 
Eigen::VectorXd lagr_mults_
 vector of lagrange multipliers
 
StiffnessMatrix A_
 Constraints matrix.
 
Eigen::MatrixXd b_
 Constraints value.
 
StiffnessMatrix A_proj_
 Constraints projection matrix.
 
Eigen::MatrixXd b_proj_
 Constraints projection value.
 
- 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 augmented lagrangian for bc constraints.

Definition at line 9 of file PeriodicLagrangianForm.hpp.

Constructor & Destructor Documentation

◆ PeriodicLagrangianForm()

polyfem::solver::PeriodicLagrangianForm::PeriodicLagrangianForm ( const int  ndof,
const std::shared_ptr< utils::PeriodicBoundary > &  periodic_bc 
)

Construct a new PeriodicLagrangianForm object.

Parameters
ndofNumber of degrees of freedom
boundary_nodesDoFs that are part of the Periodic boundary
n_boundary_samples
periodic_bcPeriodic boundary conditions

Definition at line 8 of file PeriodicLagrangianForm.cpp.

References polyfem::solver::AugmentedLagrangianForm::A_, polyfem::solver::AugmentedLagrangianForm::A_proj_, polyfem::solver::AugmentedLagrangianForm::b_, polyfem::solver::AugmentedLagrangianForm::b_proj_, polyfem::solver::AugmentedLagrangianForm::lagr_mults_, n_dofs_, and periodic_bc_.

Member Function Documentation

◆ can_project()

bool polyfem::solver::PeriodicLagrangianForm::can_project ( ) const
overridevirtual

Reimplemented from polyfem::solver::AugmentedLagrangianForm.

Definition at line 50 of file PeriodicLagrangianForm.cpp.

◆ compute_error()

double polyfem::solver::PeriodicLagrangianForm::compute_error ( const Eigen::VectorXd &  x) const
overridevirtual

◆ first_derivative_unweighted()

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

Compute the first derivative of the value wrt x.

Parameters
[in]xCurrent solution
[out]gradvOutput gradient of the value wrt x

Implements polyfem::solver::Form.

Definition at line 71 of file PeriodicLagrangianForm.cpp.

References polyfem::solver::AugmentedLagrangianForm::A_, polyfem::solver::AugmentedLagrangianForm::A_weight(), polyfem::solver::AugmentedLagrangianForm::b_, polyfem::solver::AugmentedLagrangianForm::L_weight(), polyfem::solver::AugmentedLagrangianForm::lagr_mults_, and x.

Here is the call graph for this function:

◆ name()

std::string polyfem::solver::PeriodicLagrangianForm::name ( ) const
inlineoverridevirtual

Implements polyfem::solver::Form.

Definition at line 20 of file PeriodicLagrangianForm.hpp.

◆ project_gradient()

void polyfem::solver::PeriodicLagrangianForm::project_gradient ( Eigen::VectorXd &  grad) const
overridevirtual

Reimplemented from polyfem::solver::AugmentedLagrangianForm.

Definition at line 52 of file PeriodicLagrangianForm.cpp.

References periodic_bc_.

◆ project_hessian()

void polyfem::solver::PeriodicLagrangianForm::project_hessian ( StiffnessMatrix hessian) const
overridevirtual

Reimplemented from polyfem::solver::AugmentedLagrangianForm.

Definition at line 57 of file PeriodicLagrangianForm.cpp.

References periodic_bc_.

◆ second_derivative_unweighted()

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

Compute the second derivative of the value wrt x.

Parameters
[in]xCurrent solution
[out]hessianOutput Hessian of the value wrt x

Implements polyfem::solver::Form.

Definition at line 76 of file PeriodicLagrangianForm.cpp.

References polyfem::solver::AugmentedLagrangianForm::A_, and polyfem::solver::AugmentedLagrangianForm::A_weight().

Here is the call graph for this function:

◆ update_lagrangian()

void polyfem::solver::PeriodicLagrangianForm::update_lagrangian ( const Eigen::VectorXd &  x,
const double  k_al 
)
overridevirtual

◆ update_quantities()

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

Update time dependent quantities.

Parameters
tNew time
xSolution at time t

Reimplemented from polyfem::solver::Form.

Definition at line 44 of file PeriodicLagrangianForm.hpp.

◆ value_unweighted()

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

Compute the value of the form.

Parameters
xCurrent solution
Returns
Computed value

Implements polyfem::solver::Form.

Definition at line 62 of file PeriodicLagrangianForm.cpp.

References polyfem::solver::AugmentedLagrangianForm::A_, polyfem::solver::AugmentedLagrangianForm::A_weight(), polyfem::solver::AugmentedLagrangianForm::b_, polyfem::solver::AugmentedLagrangianForm::L_weight(), polyfem::solver::AugmentedLagrangianForm::lagr_mults_, and x.

Here is the call graph for this function:

Member Data Documentation

◆ constraints_

Eigen::VectorXi polyfem::solver::PeriodicLagrangianForm::constraints_
private

Constraints.

Definition at line 57 of file PeriodicLagrangianForm.hpp.

◆ n_dofs_

const int polyfem::solver::PeriodicLagrangianForm::n_dofs_
private

Definition at line 56 of file PeriodicLagrangianForm.hpp.

Referenced by PeriodicLagrangianForm().

◆ not_constraints_

Eigen::VectorXi polyfem::solver::PeriodicLagrangianForm::not_constraints_
private

Not Constraints.

Definition at line 58 of file PeriodicLagrangianForm.hpp.

◆ periodic_bc_

const std::shared_ptr<utils::PeriodicBoundary> polyfem::solver::PeriodicLagrangianForm::periodic_bc_
private

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