SNESGetConvergedReason
Gets the reason the SNES iteration was stopped.
Synopsis
#include "snes.h"
int SNESGetConvergedReason(SNES snes,SNESConvergedReason *reason)
Not Collective
Input Parameter
snes -the SNES context
Output Parameter
reason -negative value indicates diverged, positive value converged, see snes.h or the
manual pages for the individual convergence tests for complete lists
Notes: Can only be called after the call the SNESSolve() is complete.
Keywords
SNES, nonlinear, set, convergence, test
See Also
SNESSetConvergenceTest(), SNESConverged_EQ_LS(), SNESConverged_EQ_TR(),
SNESConverged_UM_LS(), SNESConverged_UM_TR()
Level:intermediate
Location:src/snes/interface/snes.c
SNES Index
Table of Contents