Structure and routines handling the SLES settings stored inside a cs_param_sles_t structure.
More...
Go to the source code of this file.
|
struct | cs_param_sles_cvg_t |
| Set of parameters to check the convergence (or the divergence) of an iterative process (tolerances or max. number of iterations) More...
|
|
struct | cs_param_sles_t |
| Structure storing all metadata related to the resolution of a linear system with an iterative solver. More...
|
|
struct | cs_param_sles_saddle_t |
| Structure storing all metadata related to the resolution of a saddle-point linear system. More...
|
|
Structure and routines handling the SLES settings stored inside a cs_param_sles_t structure.
◆ cs_param_sles_check_amg()
Check if the setting related to the AMG is consistent with the solver class.
- Parameters
-
[in,out] | slesp | pointer to a cs_pparam_sles_t structure |
◆ cs_param_sles_check_class()
Check the availability of a solver library and return the requested one if this is possible or an alternative or CS_PARAM_SLES_N_CLASSES if no alternative is available.
- Parameters
-
[in] | wanted_class | requested class of solvers |
- Returns
- the available solver class related to the requested class
◆ cs_param_sles_copy_from()
Copy a cs_param_sles_t structure from src to dst.
- Parameters
-
[in] | src | reference cs_param_sles_t structure to copy |
[in,out] | dst | copy of the reference at exit |
◆ cs_param_sles_create()
cs_param_sles_t* cs_param_sles_create |
( |
int |
field_id, |
|
|
const char * |
system_name |
|
) |
| |
Create a cs_param_sles_t structure and assign a default settings.
- Parameters
-
[in] | field_id | id related to to the variable field or -1 |
[in] | system_name | name of the system to solve or NULL |
- Returns
- a pointer to a cs_param_sles_t stucture
◆ cs_param_sles_free()
Free a cs_param_sles_t structure.
- Parameters
-
[in,out] | slesp | pointer to a \cs_param_sles_t structure to free |
◆ cs_param_sles_get_class_from_amg()
Retrieve the related solver class from the amg type.
- Parameters
-
[in] | amg_type | type of AMG to consider |
- Returns
- the related solver class or CS_PARAM_SLES_CLASS_CS
◆ cs_param_sles_is_mumps_set()
Find if a MUMPS-related solver is set or not.
- Parameters
-
- Returns
- true or false
◆ cs_param_sles_log()
Log information related to the linear settings stored in the structure.
- Parameters
-
◆ cs_param_sles_saddle_copy()
Copy a cs_param_sles_saddle_t structure from ref to dest.
- Parameters
-
[in] | ref | reference structure to be copied |
[in,out] | dest | destination structure |
◆ cs_param_sles_saddle_create()
◆ cs_param_sles_saddle_free()
Free the structure storing the parameter settings for a saddle-point system.
- Parameters
-
[in,out] | p_saddlep | double pointer to the structure to free |
◆ cs_param_sles_saddle_init_schur()
Initialize a cs_param_sles_t structure for the Schur approximation nested inside a ref cs_param_sles_saddle_t structure. By default, this member is not allocated. Do nothing if the related structure is already allocated.
- Parameters
-
[in] | basename | prefix for the naming of the Schur system |
[in,out] | saddlep | pointer to the structure to update |
◆ cs_param_sles_set()
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_update_cvg_settings()
void cs_param_sles_update_cvg_settings |
( |
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 |