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
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. 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]	verbosity	set the level of information printed
[in]	n_max_iter	maximal number of iteration
[in]	atol	absolute tolerance
[in]	rtol	relative tolerance
[in]	dtol	divergence 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]	connect	set of additional connectivities for CDO
[in]	quant	set of additional geometrical quantities
[in]	pre_iterate	previous state of the mass flux iterate
[in]	cur_iterate	current state of the mass flux iterate
[in]	div_l2_norm	L2 norm of the velocity divergence
[in,out]	a_info	pointer to a cs_iter_algo_info_t struct.