SNESGetConvergedReason#
Gets the reason the SNES iteration was stopped.
Synopsis#
#include "petscsnes.h"
PetscErrorCode SNESGetConvergedReason(SNES snes, SNESConvergedReason *reason)
Not Collective
Input Parameter#
snes - the
SNEScontext
Output Parameter#
reason - negative value indicates diverged, positive value converged, see
SNESConvergedReasonfor the individual convergence tests for complete lists
Options Database Key#
-snes_converged_reason - prints the reason to standard out
Note#
Should only be called after the call the SNESSolve() is complete, if it is called earlier it returns the value SNES__CONVERGED_ITERATING.
See Also#
SNES: Nonlinear Solvers, SNESSolve(), SNESSetConvergenceTest(), SNESSetConvergedReason(), SNESConvergedReason, SNESGetConvergedReasonString()
Level#
intermediate
Location#
Examples#
src/snes/tutorials/ex15.c
src/snes/tutorials/ex30.c
src/snes/tutorials/ex42.c
src/snes/tutorials/ex48.c
src/snes/tutorials/ex6.c
src/ts/tutorials/ex14.c
src/ts/tutorials/ex48.c
Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages