7.0
general documentation
cs_param_sles.c File Reference
#include "cs_defs.h"
#include <assert.h>
#include <stdlib.h>
#include <string.h>
#include <bft_error.h>
#include <bft_mem.h>
#include "cs_fp_exception.h"
#include "cs_log.h"
#include "cs_multigrid.h"
#include "cs_sles.h"
#include "cs_param_sles.h"
+ Include dependency graph for cs_param_sles.c:

Functions

cs_param_sles_tcs_param_sles_create (int field_id, const char *system_name)
 Create a cs_param_sles_t structure and assign a default settings. More...
 
void cs_param_sles_free (cs_param_sles_t **p_slesp)
 Free a cs_param_sles_t structure. More...
 
void cs_param_sles_log (cs_param_sles_t *slesp)
 Log information related to the linear settings stored in the structure. More...
 
void cs_param_sles_copy_from (cs_param_sles_t *src, cs_param_sles_t *dst)
 Copy a cs_param_sles_t structure from src to dst. More...
 
void cs_equation_param_set_saturne_sles (bool use_field_id, cs_param_sles_t *slesp)
 Set parameters for initializing SLES structures used for the resolution of the linear system. Case of saturne's own solvers. More...
 
void cs_equation_param_set_mumps_sles (bool use_field_id, cs_param_sles_t *slesp)
 Set parameters for initializing SLES structures used for the resolution of the linear system. Case of MUMPS's own solvers. More...
 
void cs_equation_param_set_petsc_hypre_sles (bool use_field_id, cs_param_sles_t *slesp)
 Set parameters for initializing SLES structures used for the resolution of the linear system. Case of PETSc and Hypre families of solvers. More...
 
int cs_param_sles_set (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...
 

Function Documentation

◆ cs_equation_param_set_mumps_sles()

void cs_equation_param_set_mumps_sles ( bool  use_field_id,
cs_param_sles_t slesp 
)

Set parameters for initializing SLES structures used for the resolution of the linear system. Case of MUMPS's own solvers.

Parameters
[in]use_field_idif false use system name
[in,out]slesppointer to a cs_param_sles_t structure

◆ cs_equation_param_set_petsc_hypre_sles()

void cs_equation_param_set_petsc_hypre_sles ( bool  use_field_id,
cs_param_sles_t slesp 
)

Set parameters for initializing SLES structures used for the resolution of the linear system. Case of PETSc and Hypre families of solvers.

Parameters
[in]use_field_idif false use system name
[in,out]slesppointer to a cs_param_sles_t structure

◆ cs_equation_param_set_saturne_sles()

void cs_equation_param_set_saturne_sles ( bool  use_field_id,
cs_param_sles_t slesp 
)

Set parameters for initializing SLES structures used for the resolution of the linear system. Case of saturne's own solvers.

Parameters
[in]use_field_idif false use system name
[in,out]slesppointer to a cs_param_sles_t structure

◆ cs_param_sles_copy_from()

void cs_param_sles_copy_from ( cs_param_sles_t src,
cs_param_sles_t dst 
)

Copy a cs_param_sles_t structure from src to dst.

Parameters
[in]srcreference cs_param_sles_t structure to copy
[in,out]dstcopy 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_idid related to to the variable field or -1
[in]system_namename of the system to solve or NULL
Returns
a pointer to a cs_param_sles_t stucture

◆ cs_param_sles_free()

void cs_param_sles_free ( cs_param_sles_t **  p_slesp)

Free a cs_param_sles_t structure.

Parameters
[in,out]slesppointer to a structure to free

◆ cs_param_sles_log()

void cs_param_sles_log ( cs_param_sles_t slesp)

Log information related to the linear settings stored in the structure.

Parameters
[in]slesppointer to a cs_param_sles_log

◆ cs_param_sles_set()

int cs_param_sles_set ( 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_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)