SNESSetConvergenceTest#

Sets the function that is to be used to test for convergence of the nonlinear iterative solution.

Synopsis#

#include "petscsnes.h"  
PetscErrorCode SNESSetConvergenceTest(SNES snes, PetscErrorCode (*SNESConvergenceTestFunction)(SNES, PetscInt, PetscReal, PetscReal, PetscReal, SNESConvergedReason *, void *), void *cctx, PetscErrorCode (*destroy)(void *))

Logically Collective

Input Parameters#

  • snes - the SNES context

  • SNESConvergenceTestFunction - routine to test for convergence

  • cctx - [optional] context for private data for the convergence routine (may be NULL)

  • destroy - [optional] destructor for the context (may be NULL; PETSC_NULL_FUNCTION in Fortran)

See Also#

SNES: Nonlinear Solvers, SNES, SNESConvergedDefault(), SNESConvergedSkip(), SNESConvergenceTestFunction

Level#

advanced

Location#

src/snes/interface/snes.c

Examples#

src/snes/tutorials/ex30.c
src/snes/tutorials/ex5f.F90
src/snes/tutorials/ex69.c

Edit on GitLab

Index of all SNES routines
Table of Contents for all manual pages
Index of all manual pages