SNESConverged_UM_LS

Monitors the convergence of the SNESSolve_UM_LS() routine (default).

Synopsis

#include "snes.h" 
int SNESConverged_UM_LS(SNES snes,double xnorm,double gnorm,double f,SNESConvergedReason *reason,void *dummy)
Collective on SNES

Input Parameters

snes - the SNES context
xnorm - 2-norm of current iterate
gnorm - 2-norm of current gradient
f - objective function value
dummy - unused dummy context

Output Parameter

reason -one of
  SNES_CONVERGED_FNORM_ABS         (F < F_minabs),
  SNES_CONVERGED_GNORM_ABS         (grad F < grad),
  SNES_DIVERGED_FUNCTION_COUNT     (nfunc > max_func),
  SNES_DIVERGED_LS_FAILURE         (line search attempt failed)
  SNES_DIVERGED_FNORM_NAN          (f = NaN),
  SNES_CONVERGED_ITERATING         otherwise

where

atol - absolute gradient norm tolerance, set with SNESSetTolerances()
fmin - lower bound on function value, set with SNESSetMinimizationFunctionTolerance()
max_func - maximum number of function evaluations, set with SNESSetTolerances()
nfunc - number of function evaluations

Level:intermediate
Location:src/snes/impls/umls/umls.c
SNES Index
Table of Contents