petsc-3.14.6 2021-03-30
Report Typos and Errors

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 SNES context
reason - negative value indicates diverged, positive value converged, see SNESConvergedReason or the manual pages for the individual convergence tests for complete lists

See Also

SNESGetConvergedReason(), SNESSetConvergenceTest(), SNESConvergedReason

Level

intermediate

Location

src/snes/interface/snes.c
Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages