8.3
general documentation
cs_param_sles_setup.cpp File Reference
#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <float.h>
#include <bft_error.h>
#include <bft_mem.h>
#include "cs_fp_exception.h"
#include "cs_log.h"
#include "cs_math.h"
#include "cs_multigrid.h"
#include "cs_sles.h"
#include "cs_param_sles_setup.h"
+ Include dependency graph for cs_param_sles_setup.cpp:

Functions

int cs_param_sles_setup (bool use_field_id, cs_param_sles_t *slesp)
 Define a cs_sles_t structure in accordance with the settings in 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...
 

Function Documentation

◆ cs_param_sles_setup()

int cs_param_sles_setup ( bool  use_field_id,
cs_param_sles_t slesp 
)

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

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_idif false use system name to define a SLES
[in,out]slesppointer 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_idif false use a name to retrieve the cs_sles_t struc.
[in]slesppointer to a cs_param_sles_t structure