PolyFEM
Loading...
Searching...
No Matches
polyfem::solver::ProxyTransientForm Class Reference

#include <TransientForm.hpp>

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

Public Member Functions

 ProxyTransientForm (const VariableToSimulationGroup &variable_to_simulations, const int time_steps, const double dt, const std::string &transient_integral_type, const std::vector< int > &steps, const std::shared_ptr< StaticForm > &obj)
 
virtual ~ProxyTransientForm ()=default
 
Eigen::MatrixXd compute_adjoint_rhs (const Eigen::VectorXd &x, const State &state) const override
 
void compute_partial_gradient (const Eigen::VectorXd &x, Eigen::VectorXd &gradv) const override
 
- Public Member Functions inherited from polyfem::solver::TransientForm
 TransientForm (const VariableToSimulationGroup &variable_to_simulations, const int time_steps, const double dt, const std::string &transient_integral_type, const std::vector< int > &steps, const std::shared_ptr< StaticForm > &obj)
 
virtual ~TransientForm ()=default
 
void init (const Eigen::VectorXd &x) override
 Initialize the form.
 
bool is_step_valid (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const override
 Determine if a step from solution x0 to solution x1 is allowed.
 
double max_step_size (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const override
 Determine the maximum step size allowable between the current and next solution.
 
void line_search_begin (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) override
 Initialize variables used during the line search.
 
void line_search_end () override
 Clear variables used during the line search.
 
void post_step (const polysolve::nonlinear::PostStepData &data) override
 Update fields after a step in the optimization.
 
void solution_changed (const Eigen::VectorXd &new_x) override
 Update cached fields upon a change in the solution.
 
bool is_step_collision_free (const Eigen::VectorXd &x0, const Eigen::VectorXd &x1) const 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 VariableToSimulationGroupget_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 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)
 

Protected Member Functions

double value_unweighted (const Eigen::VectorXd &x) const override
 Compute the value of the form.
 
- 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.
 

Private Member Functions

double eval (const Eigen::VectorXd &y) const
 
Eigen::VectorXd eval_grad (const Eigen::VectorXd &y) const
 

Additional Inherited Members

- Protected Types inherited from polyfem::solver::AdjointForm
enum class  PrintStage { Inactive , AlreadyPrinted , ToPrint }
 
- Protected Attributes inherited from polyfem::solver::TransientForm
int time_steps_
 
double dt_
 
std::vector< int > steps_
 
std::shared_ptr< StaticFormobj_
 
- 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 38 of file TransientForm.hpp.

Constructor & Destructor Documentation

◆ ProxyTransientForm()

polyfem::solver::ProxyTransientForm::ProxyTransientForm ( const VariableToSimulationGroup variable_to_simulations,
const int  time_steps,
const double  dt,
const std::string &  transient_integral_type,
const std::vector< int > &  steps,
const std::shared_ptr< StaticForm > &  obj 
)
inline

Definition at line 41 of file TransientForm.hpp.

◆ ~ProxyTransientForm()

virtual polyfem::solver::ProxyTransientForm::~ProxyTransientForm ( )
virtualdefault

Member Function Documentation

◆ compute_adjoint_rhs()

Eigen::MatrixXd polyfem::solver::ProxyTransientForm::compute_adjoint_rhs ( const Eigen::VectorXd &  x,
const State state 
) const
overridevirtual

Reimplemented from polyfem::solver::TransientForm.

Definition at line 159 of file TransientForm.cpp.

References eval_grad(), polyfem::State::ndof(), polyfem::solver::TransientForm::obj_, polyfem::solver::TransientForm::steps_, polyfem::solver::TransientForm::time_steps_, vals, polyfem::solver::Form::weight(), and x.

Here is the call graph for this function:

◆ compute_partial_gradient()

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

Reimplemented from polyfem::solver::TransientForm.

Definition at line 184 of file TransientForm.cpp.

References eval_grad(), polyfem::solver::TransientForm::obj_, polyfem::solver::TransientForm::steps_, vals, polyfem::solver::Form::weight(), and x.

Here is the call graph for this function:

◆ eval()

double polyfem::solver::ProxyTransientForm::eval ( const Eigen::VectorXd &  y) const
private

Definition at line 202 of file TransientForm.cpp.

References y.

Referenced by eval_grad(), and value_unweighted().

Here is the caller graph for this function:

◆ eval_grad()

Eigen::VectorXd polyfem::solver::ProxyTransientForm::eval_grad ( const Eigen::VectorXd &  y) const
private

Definition at line 207 of file TransientForm.cpp.

References eval(), and y.

Referenced by compute_adjoint_rhs(), and compute_partial_gradient().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ value_unweighted()

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

Compute the value of the form.

Parameters
xCurrent solution
Returns
Computed value

Reimplemented from polyfem::solver::TransientForm.

Definition at line 148 of file TransientForm.cpp.

References eval(), polyfem::solver::TransientForm::obj_, polyfem::solver::TransientForm::steps_, vals, and x.

Here is the call graph for this function:

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