Structure to handle the convergence of an iterative algorithm. More...

#include <cs_iter_algo.h>

Collaboration diagram for cs_iter_algo_t:

Data Fields
cs_iter_algo_type_t	type
cs_param_convergence_t	cvg_param
int	verbosity
void *	context

Detailed Description

Structure to handle the convergence of an iterative algorithm.

Metadata to manage an iterative algorithm such as Picard or Uzawa for instance. This structure can handle a two-level (i.e. outer/inner) iterative algorithm since the notion of inner and outer iterations is defined. Nevertheless, only the outer iterative algorithm is managed (information about inner iterations are only for monitoring purposes).

Field Documentation

◆ context

void* context

pointer to structure cast on the fly

◆ cvg_param

cs_param_convergence_t cvg_param

structure storing the main settings

◆ type

cs_iter_algo_type_t type

Type of iterative algorithm to consider. Useful to cast on-the-fly the context structure

◆ verbosity

int verbosity

Level of printed information

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

src/cdo/cs_iter_algo.h