SNESSetMonitor

Sets an ADDITIONAL function that is to be used at every iteration of the nonlinear solver to display the iteration's progress.

Synopsis

int SNESSetMonitor( SNES snes, int (*func)(SNES,int,double,void*),void *mctx )
Collective on SNES

Input Parameters

snes - the SNES context
func - monitoring routine
mctx - [optional] user-defined context for private data for the monitor routine (may be PETSC_NULL)

Calling sequence of func

    int func(SNES snes,int its, Vec x,Vec f,double norm,void *mctx)

snes - the SNES context
its - iteration number
mctx - [optional] monitoring context
norm - 2-norm function value (may be estimated) for SNES_NONLINEAR_EQUATIONS methods
norm - 2-norm gradient value (may be estimated) for SNES_UNCONSTRAINED_MINIMIZATION methods

Options Database Keys

Notes

Several different monitoring routines may be set by callingSNESSetMonitor() multiple times; all will be called in theorder in which they were set.

Keywords

SNES, nonlinear, set, monitor

See Also

SNESDefaultMonitor(), SNESClearMonitor()

Examples

src/snes/examples/tutorials/ex2.c
src/snes/examples/tutorials/ex3.c

Location: src/snes/interface/snes.c
SNES Index
Table of Contents

-snes_monitor - sets SNESDefaultMonitor()
-snes_xmonitor - sets line graph monitor, uses SNESLGMonitorCreate() _ -snes_cancelmonitors - cancels all monitors that have been hardwired into a code by calls to SNESSetMonitor(), but does not cancel those set via the options database.