Module newton_rootfinder::residuals

Definition of residuals

The residuals are splitted between the solver parametrization and the model output:

• ResidualsConfig for the solver
• ResidualsValues for the model output

In addition to this two base struct, the following one are introduced:

• ResidualConfig to make easier to create the ResidualsConfigfrom a slice of the ladder
• JacobianValues to manipulate the jacobian outputs of a model when it is provided (non applicable for finite-differences)

Structs

JacobianValues

Residuals jacobian values outputs of the model

ResidualConfig

Single residual configuration

ResidualsConfig

Residuals configuration used by the solver

ResidualsValues

Residuals values outputs of the model

Enums

NormalizationMethod

Normalization method used by the normalization function.

StoppingCriteria

Not used yet

Functions

default_vec_residuals

Default method to construct a residual with Abs values

deriv_normalization

Derivation of the normalization method

normalization

Compute the residue according to the normalization method