SNESLineSearchGetTolerances#
Gets the tolerances for the line search.
Synopsis#
#include "petscsnes.h"
PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch linesearch, PetscReal *minlambda, PetscReal *maxlambda, PetscReal *rtol, PetscReal *atol, PetscReal *ltol, PetscInt *max_it)
Not Collective
Input Parameter#
linesearch - the line search context
Output Parameters#
minlambda - The minimum
lambda
allowedmaxlambda - The maximum
lambda
allowedrtol - The relative tolerance for iterative line searches
atol - The absolute tolerance for iterative line searches
ltol - The change in
lambda
tolerance for iterative line searchesmax_it - The maximum number of iterations of the line search
Note#
Different line searches may implement these parameters slightly differently as the type requires.
See Also#
SNES: Nonlinear Solvers, SNES
, SNESLineSearch
, SNESLineSearchSetTolerances()
Level#
intermediate
Location#
src/snes/linesearch/interface/linesearch.c
Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages