pub struct SolverParameters { /* private fields */ }
Expand description

A minimal struct holding the resolution parameters

Parameters

Damping

Activate the damping to improve convergence

Plain resolution according to Newton is made through the formula X = X - J^-1*F(X)

However, if the proposed update is not performing (deterioriating the solution) it is likely it is due to a much to step-size too important. Reducing the step-size might be the solution

The damping formula is then : X = X - damping_factorJ^-1F(X) with 0 < damping_factor <= 1

As long as the error is reduced damping_factor = 1. If it is not the case, a factor is applied (the value might change according to the versions).

If the used method is a quasi-newton method and the jacobian has not been updated at the current iteration, damping won’t be performed but the jacobian will be recomputed at the next iteration.

In the case of the jacobian has been recomputed at the current iteration, damping will be performed

Tolerance

The tolerance values used by the solver to check for convergence.

Each residuals must be below this threshold

Max iteration

The maximum number of iterations the solver is allowed to make

This is required to avoid to have an infinte loop

Resolution Method

See the enum ResolutionMethod for the options available

Problem size

The dimension of the problem for the resolution

Implementations

Trait Implementations

Formats the value using the given formatter. Read more
Formats the value using the given formatter. Read more

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
Converts the given value to a String. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.