7.0
general documentation
cs_iter_algo.h File Reference
#include "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_math.h"
#include "cs_sles.h"
+ Include dependency graph for cs_iter_algo.h:

Go to the source code of this file.

Data Structures

struct  cs_iter_algo_info_t
 Set of information related to the convergence of the iterative algorithm (Picard or Uzawa for instance) More...
 

Functions

static void cs_iter_algo_reset (cs_iter_algo_info_t *info)
 Reset a cs_iter_algo_info_t structure. More...
 
static void cs_iter_algo_navsto_print_header (const char *algo_name)
 Print header before dumping information gathered in the structure cs_iter_algo_info_t. More...
 
static void cs_iter_algo_navsto_print (const char *algo_name, const cs_iter_algo_info_t *info, double div_l2)
 Print header before dumping information gathered in the structure cs_iter_algo_info_t. More...
 
cs_iter_algo_info_tcs_iter_algo_define (int verbosity, int n_max_iter, double atol, double rtol, double dtol)
 Create and initialize a new cs_iter_algo_info_t structure. More...
 
void cs_iter_algo_navsto_fb_picard_cvg (const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant, const cs_real_t *pre_iterate, const cs_real_t *cur_iterate, cs_real_t div_l2_norm, cs_iter_algo_info_t *a_info)
 Test if one has to do one more Picard iteration. Test if performed on the relative norm on the increment between two iterations but also on the divergence. More...
 

Function Documentation

◆ cs_iter_algo_define()

cs_iter_algo_info_t* cs_iter_algo_define ( int  verbosity,
int  n_max_iter,
double  atol,
double  rtol,
double  dtol 
)

Create and initialize a new cs_iter_algo_info_t structure.

Parameters
[in]verbosityset the level of information printed
[in]n_max_itermaximal number of iteration
[in]atolabsolute tolerance
[in]rtolrelative tolerance
[in]dtoldivergence tolerance
Returns
a pointer to the new allocated structure

◆ cs_iter_algo_navsto_fb_picard_cvg()

void cs_iter_algo_navsto_fb_picard_cvg ( const cs_cdo_connect_t connect,
const cs_cdo_quantities_t quant,
const cs_real_t pre_iterate,
const cs_real_t cur_iterate,
cs_real_t  div_l2_norm,
cs_iter_algo_info_t a_info 
)

Test if one has to do one more Picard iteration. Test if performed on the relative norm on the increment between two iterations but also on the divergence.

Parameters
[in]connectset of additional connectivities for CDO
[in]quantset of additional geometrical quantities
[in]pre_iterateprevious state of the mass flux iterate
[in]cur_iteratecurrent state of the mass flux iterate
[in]div_l2_normL2 norm of the velocity divergence
[in,out]a_infopointer to a cs_iter_algo_info_t struct.

◆ cs_iter_algo_navsto_print()

static void cs_iter_algo_navsto_print ( const char *  algo_name,
const cs_iter_algo_info_t info,
double  div_l2 
)
inlinestatic

Print header before dumping information gathered in the structure cs_iter_algo_info_t.

Parameters
[in]algo_namename of the algorithm
[in]infopointer to cs_iter_algo_info_t structure
[in]div_l2l2 norm of the divergence

◆ cs_iter_algo_navsto_print_header()

static void cs_iter_algo_navsto_print_header ( const char *  algo_name)
inlinestatic

Print header before dumping information gathered in the structure cs_iter_algo_info_t.

Parameters
[in]algo_namename of the algorithm

◆ cs_iter_algo_reset()

static void cs_iter_algo_reset ( cs_iter_algo_info_t info)
inlinestatic

Reset a cs_iter_algo_info_t structure.

Parameters
[in,out]infopointer to a cs_iter_algo_info_t