SNESSetConvergedReason#
Sets the reason the SNES iteration was stopped.
Synopsis#
#include "petscsnes.h"
PetscErrorCode SNESSetConvergedReason(SNES snes, SNESConvergedReason reason)
Not Collective
Input Parameters#
snes - the
SNEScontextreason - negative value indicates diverged, positive value converged, see
SNESConvergedReasonor the manual pages for the individual convergence tests for complete lists
Developer Note#
Called inside the various SNESSolve() implementations
See Also#
SNES: Nonlinear Solvers, SNESGetConvergedReason(), SNESSetConvergenceTest(), SNESConvergedReason
Level#
developer
Location#
Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages