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

#include <Parametrizations.hpp>

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

Public Member Functions

 InsertConstantMap (const int size=-1, const double val=0, const int start_index=-1)
 
 InsertConstantMap (const Eigen::VectorXd &values, const int start_index=-1)
 
int size (const int x_size) const override
 Compute DOF of y given DOF of x.
 
Eigen::VectorXd inverse_eval (const Eigen::VectorXd &y) override
 Eval x = f^-1 (y).
 
Eigen::VectorXd eval (const Eigen::VectorXd &x) const override
 Eval y = f(x).
 
Eigen::VectorXd apply_jacobian (const Eigen::VectorXd &grad, const Eigen::VectorXd &x) const override
 Apply jacobian for chain rule.
 
- Public Member Functions inherited from polyfem::solver::Parametrization
virtual ~Parametrization ()=default
 

Private Attributes

int start_index_ = -1
 
Eigen::VectorXd values_
 

Detailed Description

Definition at line 130 of file Parametrizations.hpp.

Constructor & Destructor Documentation

◆ InsertConstantMap() [1/2]

polyfem::solver::InsertConstantMap::InsertConstantMap ( const int  size = -1,
const double  val = 0,
const int  start_index = -1 
)

Definition at line 347 of file Parametrizations.cpp.

References polyfem::log_and_throw_adjoint_error(), size(), val, and values_.

Here is the call graph for this function:

◆ InsertConstantMap() [2/2]

polyfem::solver::InsertConstantMap::InsertConstantMap ( const Eigen::VectorXd &  values,
const int  start_index = -1 
)

Definition at line 354 of file Parametrizations.cpp.

Member Function Documentation

◆ apply_jacobian()

Eigen::VectorXd polyfem::solver::InsertConstantMap::apply_jacobian ( const Eigen::VectorXd &  grad_full,
const Eigen::VectorXd &  x 
) const
overridevirtual

Apply jacobian for chain rule.

Let g(y) = g(f(x)). Given ∂g/∂y, compute ∂g/∂x = ∂g/∂y * ∂y/∂x.

Parameters
[in]grad_full∂g/∂y.
[in]xWhere ∂g/∂x is evaluated.
Returns
∂g/∂x.

Implements polyfem::solver::Parametrization.

Definition at line 393 of file Parametrizations.cpp.

References start_index_, values_, and x.

◆ eval()

Eigen::VectorXd polyfem::solver::InsertConstantMap::eval ( const Eigen::VectorXd &  x) const
overridevirtual

Eval y = f(x).

Parameters
[in]xx.
Returns
y.

Implements polyfem::solver::Parametrization.

Definition at line 377 of file Parametrizations.cpp.

References size(), start_index_, values_, x, and y.

Here is the call graph for this function:

◆ inverse_eval()

Eigen::VectorXd polyfem::solver::InsertConstantMap::inverse_eval ( const Eigen::VectorXd &  y)
overridevirtual

Eval x = f^-1 (y).

This is not a strict inverse in mathematical sense, one may choose "reasonable" x even if f is not one-to-one.

Parameters
[in]yy.
Returns
x.
Exceptions
std::runtime_errorThrow if not implemented.

Reimplemented from polyfem::solver::Parametrization.

Definition at line 363 of file Parametrizations.cpp.

References start_index_, values_, x, and y.

◆ size()

int polyfem::solver::InsertConstantMap::size ( const int  x_size) const
overridevirtual

Compute DOF of y given DOF of x.

Parameters
[in]x_sizeThe DOF of x.
Returns
DOF of y.

Implements polyfem::solver::Parametrization.

Definition at line 358 of file Parametrizations.cpp.

References values_.

Referenced by eval(), and InsertConstantMap().

Here is the caller graph for this function:

Member Data Documentation

◆ start_index_

int polyfem::solver::InsertConstantMap::start_index_ = -1
private

Definition at line 144 of file Parametrizations.hpp.

Referenced by apply_jacobian(), eval(), and inverse_eval().

◆ values_

Eigen::VectorXd polyfem::solver::InsertConstantMap::values_
private

Definition at line 145 of file Parametrizations.hpp.

Referenced by apply_jacobian(), eval(), InsertConstantMap(), inverse_eval(), and size().


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