SNESSetConvergenceTest

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

Synopsis

#include "petscsnes.h"  
int SNESSetConvergenceTest(SNES snes,int (*func)(SNES,PetscReal,PetscReal,PetscReal,SNESConvergedReason*,void*),void *cctx)
Collective on SNES

Input Parameters

snes - the SNES context
func - routine to test for convergence
cctx - [optional] context for private data for the convergence routine (may be PETSC_NULL)

Calling sequence of func

    int func (SNES snes,PetscReal xnorm,PetscReal gnorm,PetscReal f,SNESConvergedReason *reason,void *cctx)

snes - the SNES context
cctx - [optional] convergence context
reason - reason for convergence/divergence
xnorm - 2-norm of current iterate
gnorm - 2-norm of current step
f - 2-norm of function

Keywords

SNES, nonlinear, set, convergence, test

See Also

SNESConverged_LS(), SNESConverged_TR()

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