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

Constant saddle-point coupling between velocity and pressure. More...

#include <NavierStokesForm.hpp>

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

Public Member Functions

 MixedLinearForm (int n_velocity_bases, int n_pressure_bases, const std::vector< basis::ElementBases > &velocity_bases, const std::vector< basis::ElementBases > &pressure_bases, const std::vector< basis::ElementBases > &geom_bases, const assembler::MixedAssembler &assembler, const assembler::AssemblyValsCache &velocity_cache, const assembler::AssemblyValsCache &pressure_cache, double t, bool is_volume)
 
std::string name () const override
 
void set_row_weights (double velocity_weight, double pressure_weight)
 
- 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 update_quantities (const double t, const Eigen::VectorXd &x)
 Update time-dependent fields.
 
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.
 
void first_derivative_unweighted (const Eigen::VectorXd &x, Eigen::VectorXd &residual) const override
 Compute the first derivative of the value wrt x.
 
void second_derivative_unweighted (const Eigen::VectorXd &x, StiffnessMatrix &jacobian) 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
 
virtual Eigen::VectorXd value_per_element_unweighted (const Eigen::VectorXd &x) const
 Compute the value of the form multiplied per element.
 

Private Attributes

int velocity_ndof_
 
int pressure_ndof_
 
StiffnessMatrix coupling_
 
double velocity_weight_ = 1
 
double pressure_weight_ = 1
 

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

Constant saddle-point coupling between velocity and pressure.

Definition at line 54 of file NavierStokesForm.hpp.

Constructor & Destructor Documentation

◆ MixedLinearForm()

polyfem::solver::MixedLinearForm::MixedLinearForm ( int  n_velocity_bases,
int  n_pressure_bases,
const std::vector< basis::ElementBases > &  velocity_bases,
const std::vector< basis::ElementBases > &  pressure_bases,
const std::vector< basis::ElementBases > &  geom_bases,
const assembler::MixedAssembler assembler,
const assembler::AssemblyValsCache velocity_cache,
const assembler::AssemblyValsCache pressure_cache,
double  t,
bool  is_volume 
)

Definition at line 76 of file NavierStokesForm.cpp.

References polyfem::assembler::MixedAssembler::assemble(), coupling_, entries, pressure_ndof_, and velocity_ndof_.

Here is the call graph for this function:

Member Function Documentation

◆ first_derivative_unweighted()

void polyfem::solver::MixedLinearForm::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 123 of file NavierStokesForm.cpp.

References coupling_, pressure_ndof_, pressure_weight_, velocity_ndof_, velocity_weight_, and x.

◆ name()

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

Implements polyfem::solver::Form.

Definition at line 69 of file NavierStokesForm.hpp.

◆ second_derivative_unweighted()

void polyfem::solver::MixedLinearForm::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 131 of file NavierStokesForm.cpp.

References coupling_, pressure_weight_, velocity_ndof_, and velocity_weight_.

◆ set_row_weights()

void polyfem::solver::MixedLinearForm::set_row_weights ( double  velocity_weight,
double  pressure_weight 
)

Definition at line 111 of file NavierStokesForm.cpp.

References pressure_weight_, and velocity_weight_.

◆ value_unweighted()

double polyfem::solver::MixedLinearForm::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 118 of file NavierStokesForm.cpp.

References polyfem::log_and_throw_error().

Here is the call graph for this function:

Member Data Documentation

◆ coupling_

StiffnessMatrix polyfem::solver::MixedLinearForm::coupling_
private

◆ pressure_ndof_

int polyfem::solver::MixedLinearForm::pressure_ndof_
private

Definition at line 79 of file NavierStokesForm.hpp.

Referenced by first_derivative_unweighted(), and MixedLinearForm().

◆ pressure_weight_

double polyfem::solver::MixedLinearForm::pressure_weight_ = 1
private

◆ velocity_ndof_

int polyfem::solver::MixedLinearForm::velocity_ndof_
private

◆ velocity_weight_

double polyfem::solver::MixedLinearForm::velocity_weight_ = 1
private

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