petsc-3.14.6 2021-03-30

SNESMonitorSet

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

Synopsis

#include "petscsnes.h"  
PetscErrorCode  SNESMonitorSet(SNES snes,PetscErrorCode (*f)(SNES,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))

Logically Collective on SNES

Input Parameters

	snes	- the SNES context
	f	- the monitor function, see SNESMonitorFunction for the calling sequence
	mctx	- [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
	monitordestroy	- [optional] routine that frees monitor context (may be NULL)

Options Database Keys

	-snes_monitor	- sets SNESMonitorDefault()
	-snes_monitor_lg_residualnorm	- sets line graph monitor, uses SNESMonitorLGCreate()
	-snes_monitor_cancel	- cancels all monitors that have been hardwired into a code by calls to SNESMonitorSet(), but does not cancel those set via the options database.

Notes

Several different monitoring routines may be set by calling SNESMonitorSet() multiple times; all will be called in the order in which they were set.

Fortran Notes

Only a single monitor function can be set for each SNES object

Level

intermediate

Location

src/snes/interface/snes.c

Examples

src/snes/tutorials/ex2.c.html
src/snes/tutorials/ex3.c.html
src/snes/tutorials/ex12.c.html
src/snes/tutorials/ex21.c.html
src/snes/tutorials/ex22.c.html
src/ts/tutorials/ex7.c.html
src/ts/tutorials/ex12.c.html
src/ts/tutorials/ex52.c.html

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