8.3
general documentation
Data Fields
cs_param_sles_t Struct Reference

Structure storing all metadata related to the resolution of a linear system with an iterative solver. More...

#include <cs_param_sles.h>

+ Collaboration diagram for cs_param_sles_t:

Data Fields

char * name
 
int field_id
 
int verbosity
 
cs_param_solver_class_t solver_class
 
cs_param_precond_type_t precond
 
cs_param_solver_type_t solver
 
bool need_flexible
 
int restart
 
cs_param_amg_type_t amg_type
 
cs_param_precond_block_t precond_block_type
 
cs_param_resnorm_type_t resnorm_type
 
bool allow_no_op
 
bool mat_is_sym
 
cs_param_convergence_t cvg_param
 
void * context_param
 

Detailed Description

Structure storing all metadata related to the resolution of a linear system with an iterative solver.

Field Documentation

◆ allow_no_op

allow_no_op

allow one to not call the solve function in some specific situations Please refer to _needs_solving for more details

◆ amg_type

cs_param_amg_type_t amg_type

type of AMG algorithm

◆ context_param

context_param

Pointer to a structure cast on-the-fly storing specific parameters related to the given solver (MUMPS for instance)

◆ cvg_param

cvg_param

Structure storing the parameters to know if an iterative process has to stop (convergence or divergence).

◆ field_id

int field_id

Field id related to a SLES. By default, this is set to -1

◆ mat_is_sym

mat_is_sym

allow one to know if the matric is symmetric (independent of the way the storage is done). Default value is false

◆ name

char* name

System name (equation name if this is automatic)

◆ need_flexible

bool need_flexible

need a flexible variant ?

◆ precond

cs_param_precond_type_t precond

type of preconditioner

◆ precond_block_type

precond_block_type

type of block preconditioner to use (only meaningful for vector-valued systems or more complex systems)

◆ resnorm_type

resnorm_type

normalized or not the norm of the residual used for the stopping criterion See CS_EQKEY_SOLVER_RESNORM_TYPE for more details.

◆ restart

int restart

max. iter. before restarting

◆ solver

cs_param_solver_type_t solver

type of solver

◆ solver_class

cs_param_solver_class_t solver_class

class of SLES to consider

◆ verbosity

int verbosity

SLES verbosity

The documentation for this struct was generated from the following file: