cs_param_sles_setup.h File Reference

Routines to handle the setup of SLES relying on a cs_param_sles_t structure. More...

#include "cs_param_sles.h"

Include dependency graph for cs_param_sles_setup.h:

Go to the source code of this file.

Functions
int	cs_param_sles_setup (bool use_field_id, cs_param_sles_t *slesp)
	Define cs_sles_t structure in accordance with the settings of a cs_param_sles_t structure (SLES = Sparse Linear Equation Solver) More...
void	cs_param_sles_setup_cvg_param (bool use_field_id, const cs_param_sles_t *slesp)
	Update the settings associated to a cs_sles_t structure and apply those defined in the given cs_param_sles_t structure. This function is used only when a first setup has been performed. More...

Detailed Description

Routines to handle the setup of SLES relying on a cs_param_sles_t structure.

Function Documentation

cs_param_sles_setup()

int cs_param_sles_setup	(	bool	use_field_id,
		cs_param_sles_t *	slesp
	)

Define cs_sles_t structure in accordance with the settings of a cs_param_sles_t structure (SLES = Sparse Linear Equation Solver)

Parameters

[in]	use_field_id	if false use system name to define a SLES
[in,out]	slesp	pointer to a cs_param_sles_t structure

Returns

an error code (-1 if a problem is encountered, 0 otherwise)

Define cs_sles_t structure in accordance with the settings of a cs_param_sles_t structure (SLES = Sparse Linear Equation Solver)

Parameters

[in]	use_field_id	if false use system name to define a SLES
[in,out]	slesp	pointer to a cs_param_sles_t structure

Returns

an error code (-1 if a problem is encountered, 0 otherwise)

cs_param_sles_setup_cvg_param()

void cs_param_sles_setup_cvg_param	(	bool	use_field_id,
		const cs_param_sles_t *	slesp
	)

Update the settings associated to a cs_sles_t structure and apply those defined in the given cs_param_sles_t structure. This function is used only when a first setup has been performed.

One modifies only some specific options like the max. number of iterations or the relative tolerance

Parameters

[in]	use_field_id	if false use a name to retrieve the cs_sles_t struc.
[in]	slesp	pointer to a cs_param_sles_t structure