petsc-3.5.4 2015-05-23

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 SNES context

Output Parameter

reason -negative value indicates diverged, positive value converged, see SNESConvergedReason 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

Examples