cs_param_convergence_t Struct Reference

Set of parameters to check the convergence (or the divergence) of an iterative process (tolerances or max. number of iterations) More...

#include <cs_param_types.h>

Collaboration diagram for cs_param_convergence_t:

Data Fields
double	atol
double	rtol
double	dtol
int	n_max_iter

Detailed Description

Set of parameters to check the convergence (or the divergence) of an iterative process (tolerances or max. number of iterations)

Field Documentation

atol

double atol

Absolute tolerance under which the iterative process is stopped

dtol

double dtol

Tolerance above which the iterative process is stated as "diverged". Not used if < 0

n_max_iter

int n_max_iter

Maximal number of iterations before stopping the iterative process

rtol

double rtol

Relative tolerance under which the iterative process is stopped

---

The documentation for this struct was generated from the following file:

• src/base/cs_param_types.h