File numerics/src/tools/SolverOptions_helpers.h¶
Go to the source code of this file
Helper functions for setting common solver options.
Functions
-
static inline void SN_set_tolerance(double *dparam, double tol)¶
set the tolerance for the solver
- Parameters
dparam – the set of double parameters
tol – the new tolerance
-
static inline double SN_get_tolerance(double *dparam)¶
get the tolerance for the solver
- Parameters
dparam – the set of double parameters
- Returns
tol the tolerance
-
static inline void SN_set_residual(double *dparam, double res)¶
set the residual from the solver
- Parameters
dparam – the set of double parameters
res – the new tolerance
-
static inline double SN_get_residual(double *dparam)¶
get the residual
- Parameters
dparam – the set of double parameters
- Returns
the residual
-
static inline void SN_set_max_iters(int *iparam, int max_iters)¶
set the maximum number of iterations
- Parameters
iparam – the set of integer parameters
max_iters – the new tolerance
-
static inline int SN_get_max_iters(int *iparam)¶
get the number of iterations
- Parameters
iparam – the set of integer parameters
- Returns
the maximum number of iterations
-
static inline void SN_set_nb_iters(int *iparam, int nb_iters)¶
set the number of iterations done in the solver
- Parameters
iparam – the set of integer parameters
nb_iters – the new tolerance
-
static inline int SN_get_nb_iters(int *iparam)¶
get the number of iterations
- Parameters
iparam – the set of double parameters
- Returns
the number of iterations done in the solver