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

#include <MixedAssemblerForm.hpp>

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

Public Member Functions

 MixedAssemblerForm (const int n_phi_bases, const int n_psi_bases, const std::vector< basis::ElementBases > &phi_bases, const std::vector< basis::ElementBases > &psi_bases, const std::vector< basis::ElementBases > &geom_bases, const assembler::MixedNLAssembler &assembler, assembler::AssemblyValsCache &phi_cache, assembler::AssemblyValsCache &psi_cache, const double t, const double dt, const bool is_volume)
 
std::string name () const override
 
void set_row_weights (const double phi_weight, const double psi_weight)
 
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.
 
Eigen::VectorXd value_per_element_unweighted (const Eigen::VectorXd &x) const override
 Compute the value of the form multiplied per element.
 
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
 

Private Member Functions

int phi_ndof () const
 
int psi_ndof () const
 
assembler::MixedNLAssembler::SolutionSplitter split_solution () const
 

Private Attributes

const int n_phi_bases_
 
const int n_psi_bases_
 
const std::vector< basis::ElementBases > & phi_bases_
 
const std::vector< basis::ElementBases > & psi_bases_
 
const std::vector< basis::ElementBases > & geom_bases_
 
const assembler::MixedNLAssemblerassembler_
 
assembler::AssemblyValsCachephi_cache_
 
assembler::AssemblyValsCachepsi_cache_
 
double t_
 
const double dt_
 
const bool is_volume_
 
Eigen::VectorXd x_prev_
 
double phi_row_weight_ = 1
 
double psi_row_weight_ = 1
 
std::unique_ptr< utils::MatrixCachemat_cache_
 

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

Definition at line 16 of file MixedAssemblerForm.hpp.

Constructor & Destructor Documentation

◆ MixedAssemblerForm()

polyfem::solver::MixedAssemblerForm::MixedAssemblerForm ( const int  n_phi_bases,
const int  n_psi_bases,
const std::vector< basis::ElementBases > &  phi_bases,
const std::vector< basis::ElementBases > &  psi_bases,
const std::vector< basis::ElementBases > &  geom_bases,
const assembler::MixedNLAssembler assembler,
assembler::AssemblyValsCache phi_cache,
assembler::AssemblyValsCache psi_cache,
const double  t,
const double  dt,
const bool  is_volume 
)

Member Function Documentation

◆ first_derivative_unweighted()

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

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 74 of file MixedAssemblerForm.cpp.

References polyfem::assembler::MixedNLAssembler::assemble_gradient(), assembler_, dt_, geom_bases_, is_volume_, n_phi_bases_, n_psi_bases_, phi_bases_, phi_cache_, phi_ndof(), phi_row_weight_, psi_bases_, psi_cache_, psi_ndof(), psi_row_weight_, split_solution(), t_, x, and x_prev_.

Here is the call graph for this function:

◆ name()

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

Implements polyfem::solver::Form.

Definition at line 32 of file MixedAssemblerForm.hpp.

◆ phi_ndof()

int polyfem::solver::MixedAssemblerForm::phi_ndof ( ) const
private

Definition at line 117 of file MixedAssemblerForm.cpp.

References assembler_, n_phi_bases_, and polyfem::assembler::Assembler::size().

Referenced by first_derivative_unweighted(), second_derivative_unweighted(), and split_solution().

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

◆ psi_ndof()

int polyfem::solver::MixedAssemblerForm::psi_ndof ( ) const
private

Definition at line 122 of file MixedAssemblerForm.cpp.

References n_psi_bases_.

Referenced by first_derivative_unweighted(), and split_solution().

Here is the caller graph for this function:

◆ second_derivative_unweighted()

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

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 90 of file MixedAssemblerForm.cpp.

References polyfem::assembler::MixedNLAssembler::assemble_hessian(), assembler_, dt_, geom_bases_, is_volume_, mat_cache_, n_phi_bases_, n_psi_bases_, phi_bases_, phi_cache_, phi_ndof(), phi_row_weight_, POLYFEM_SCOPED_TIMER, polyfem::solver::Form::project_to_psd_, psi_bases_, psi_cache_, psi_row_weight_, split_solution(), t_, x, and x_prev_.

Here is the call graph for this function:

◆ set_row_weights()

void polyfem::solver::MixedAssemblerForm::set_row_weights ( const double  phi_weight,
const double  psi_weight 
)

Definition at line 42 of file MixedAssemblerForm.cpp.

References phi_row_weight_, and psi_row_weight_.

◆ split_solution()

assembler::MixedNLAssembler::SolutionSplitter polyfem::solver::MixedAssemblerForm::split_solution ( ) const
private

Definition at line 127 of file MixedAssemblerForm.cpp.

References phi_ndof(), psi_ndof(), and x.

Referenced by first_derivative_unweighted(), second_derivative_unweighted(), value_per_element_unweighted(), and value_unweighted().

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

◆ update_quantities()

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

Update time-dependent fields.

Parameters
tCurrent time
xCurrent solution at time t

Reimplemented from polyfem::solver::Form.

Definition at line 36 of file MixedAssemblerForm.hpp.

References t_, x, and x_prev_.

◆ value_per_element_unweighted()

Eigen::VectorXd polyfem::solver::MixedAssemblerForm::value_per_element_unweighted ( const Eigen::VectorXd &  x) const
overrideprotectedvirtual

Compute the value of the form multiplied per element.

Parameters
xCurrent solution
Returns
Computed value per element

Reimplemented from polyfem::solver::Form.

Definition at line 61 of file MixedAssemblerForm.cpp.

References polyfem::assembler::MixedNLAssembler::assemble_energy_per_element(), assembler_, dt_, geom_bases_, is_volume_, n_phi_bases_, n_psi_bases_, phi_bases_, phi_cache_, psi_bases_, psi_cache_, split_solution(), t_, value_unweighted(), x, and x_prev_.

Here is the call graph for this function:

◆ value_unweighted()

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

Compute the value of the form.

Parameters
xCurrent solution
Returns
Computed value

Implements polyfem::solver::Form.

Definition at line 50 of file MixedAssemblerForm.cpp.

References polyfem::assembler::MixedNLAssembler::assemble_energy(), assembler_, dt_, geom_bases_, is_volume_, n_phi_bases_, n_psi_bases_, phi_bases_, phi_cache_, psi_bases_, psi_cache_, split_solution(), t_, x, and x_prev_.

Referenced by value_per_element_unweighted().

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

Member Data Documentation

◆ assembler_

const assembler::MixedNLAssembler& polyfem::solver::MixedAssemblerForm::assembler_
private

◆ dt_

const double polyfem::solver::MixedAssemblerForm::dt_
private

◆ geom_bases_

const std::vector<basis::ElementBases>& polyfem::solver::MixedAssemblerForm::geom_bases_
private

◆ is_volume_

const bool polyfem::solver::MixedAssemblerForm::is_volume_
private

◆ mat_cache_

std::unique_ptr<utils::MatrixCache> polyfem::solver::MixedAssemblerForm::mat_cache_
mutableprivate

Definition at line 67 of file MixedAssemblerForm.hpp.

Referenced by MixedAssemblerForm(), and second_derivative_unweighted().

◆ n_phi_bases_

const int polyfem::solver::MixedAssemblerForm::n_phi_bases_
private

◆ n_psi_bases_

const int polyfem::solver::MixedAssemblerForm::n_psi_bases_
private

◆ phi_bases_

const std::vector<basis::ElementBases>& polyfem::solver::MixedAssemblerForm::phi_bases_
private

◆ phi_cache_

assembler::AssemblyValsCache& polyfem::solver::MixedAssemblerForm::phi_cache_
private

◆ phi_row_weight_

double polyfem::solver::MixedAssemblerForm::phi_row_weight_ = 1
private

◆ psi_bases_

const std::vector<basis::ElementBases>& polyfem::solver::MixedAssemblerForm::psi_bases_
private

◆ psi_cache_

assembler::AssemblyValsCache& polyfem::solver::MixedAssemblerForm::psi_cache_
private

◆ psi_row_weight_

double polyfem::solver::MixedAssemblerForm::psi_row_weight_ = 1
private

◆ t_

double polyfem::solver::MixedAssemblerForm::t_
private

◆ x_prev_

Eigen::VectorXd polyfem::solver::MixedAssemblerForm::x_prev_
private

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