#include "cs_equation_param.h"
#include "cs_iter_algo.h"
#include "cs_param_sles.h"
#include "cs_param_types.h"

Include dependency graph for cs_equation_system_param.h:

Data Structures
struct	cs_equation_system_param_t
	Main structure storing the parameter settings. More...

Enumerations
enum	cs_equation_system_sles_strategy_t { CS_EQUATION_SYSTEM_SLES_MUMPS , CS_EQUATION_SYSTEM_N_SLES_TYPES }
	High-level information about the way of solving the system of equations. More...

enum	cs_equation_system_key_t { CS_SYSKEY_LINEAR_SOLVER_ATOL , CS_SYSKEY_LINEAR_SOLVER_DTOL , CS_SYSKEY_LINEAR_SOLVER_RTOL , CS_SYSKEY_LINEAR_SOLVER_MAX_ITER , CS_SYSKEY_SLES_STRATEGY , CS_SYSKEY_VERBOSITY , CS_SYSKEY_N_KEYS }
	List of available keys for setting the parameters of a system of equations. More...

Functions
cs_equation_system_param_t *	cs_equation_system_param_create (const char *name, int block_var_dim)
	Create and initialize a new cs_equation_system_param_t structure. More...

cs_equation_system_param_t *	cs_equation_system_param_free (cs_equation_system_param_t *sysp)
	Free a cs_equation_system_param_t structure. More...

void	cs_equation_system_param_log (const cs_equation_system_param_t *sysp)
	Log the setup gathered in the structure cs_equation_system_param_t. More...

void	cs_equation_system_param_set (cs_equation_system_param_t sysp, cs_equation_system_key_t key, const char keyval)
	Set a parameter related to a keyname in a cs_equation_system_param_t structure. More...

Enumeration Type Documentation

◆ cs_equation_system_key_t

List of available keys for setting the parameters of a system of equations.

Enumerator
CS_SYSKEY_LINEAR_SOLVER_ATOL	Absolute tolerance for which the (main) linear solver stops iterating
CS_SYSKEY_LINEAR_SOLVER_DTOL	Divergence tolerance for which the (main) linear solver stops iterating
CS_SYSKEY_LINEAR_SOLVER_RTOL	Relative tolerance for which the (main) linear solver stops iterating
CS_SYSKEY_LINEAR_SOLVER_MAX_ITER	Maximal number of iterations for the (main) linear solver
CS_SYSKEY_SLES_STRATEGY	Strategy for solving the linear system arising from the discretization of the system of equations
CS_SYSKEY_VERBOSITY	Level of verbosity related to the system of equations (a specific verbosity is available for the linear algebra; cf. CS_SYSKEY_LINEAR_SOLVER_VERBOSITY)
CS_SYSKEY_N_KEYS

High-level information about the way of solving the system of equations.

Enumerator
CS_EQUATION_SYSTEM_SLES_MUMPS	Associated keyword: "mumps" Direct solver to solve the full system
CS_EQUATION_SYSTEM_N_SLES_TYPES

cs_equation_system_param_t* cs_equation_system_param_create	(	const char *	name,
		int	block_var_dim
	)

Create and initialize a new cs_equation_system_param_t structure.

Parameters

[in]	name	name of system of equations
[in]	block_var_dim	dimension of the variable in each block

cs_equation_system_param_t* cs_equation_system_param_free ( cs_equation_system_param_t * sysp )

Parameters

[in,out] sysp pointer to the structure to free

void cs_equation_system_param_log ( const cs_equation_system_param_t * sysp )

Log the setup gathered in the structure cs_equation_system_param_t.

Parameters

[in] sysp pointer to a parameter structure to log

void cs_equation_system_param_set	(	cs_equation_system_param_t *	sysp,
		cs_equation_system_key_t	key,
		const char *	keyval
	)

Set a parameter related to a keyname in a cs_equation_system_param_t structure.

Parameters

[in,out]	sysp	pointer to a parameter structure to set
[in]	key	key related to the member of eq to set
[in]	keyval	accessor to the value to set