SNESLineSearchGetTolerances#

Gets the tolerances for the linesearch. These include tolerances for the relative and absolute change in the function norm, the change in lambda for iterative line searches, the minimum steplength, the maximum steplength, and the maximum number of iterations the line search procedure may take.

Synopsis#

#include "petscsnes.h" 
PetscErrorCode SNESLineSearchGetTolerances(SNESLineSearch linesearch, PetscReal *steptol, PetscReal *maxstep, PetscReal *rtol, PetscReal *atol, PetscReal *ltol, PetscInt *max_its)

Not Collective

Input Parameter#

  • linesearch - linesearch context

Output Parameters#

  • steptol - The minimum steplength

  • maxstep - The maximum steplength

  • rtol - The relative tolerance for iterative line searches

  • atol - The absolute tolerance for iterative line searches

  • ltol - The change in lambda tolerance for iterative line searches

  • max_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#

SNESLineSearch, SNESLineSearchSetTolerances()

Level#

intermediate

Location#

src/snes/linesearch/interface/linesearch.c

Edit on GitLab

Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages