Sets an ADDITIONAL function to be called at every iteration to monitor the residual/error etc.


#include "petscksp.h" 
PetscErrorCode PETSCKSP_DLLEXPORT KSPMonitorSet(KSP ksp,PetscErrorCode (*monitor)(KSP,PetscInt,PetscReal,void*),void *mctx,PetscErrorCode (*monitordestroy)(void*))
Collective on KSP

Input Parameters

ksp - iterative context obtained from KSPCreate()
monitor - pointer to function (if this is PETSC_NULL, it turns off monitoring
mctx - [optional] context for private data for the monitor routine (use PETSC_NULL if no context is desired)
monitordestroy - [optional] routine that frees monitor context (may be PETSC_NULL)

Calling Sequence of monitor

    monitor (KSP ksp, int it, PetscReal rnorm, void *mctx)

ksp - iterative context obtained from KSPCreate()
it - iteration number
rnorm - (estimated) 2-norm of (preconditioned) residual
mctx - optional monitoring context, as set by KSPMonitorSet()

Options Database Keys

-ksp_monitor - sets KSPMonitorDefault()
-ksp_monitor_true_residual_norm - sets KSPMonitorTrueResidualNorm()
-ksp_monitor_draw - sets line graph monitor, uses KSPMonitorLGCreate()
-ksp_monitor_draw_true_residual - sets line graph monitor, uses KSPMonitorLGCreate()
-ksp_monitor_singular_value - sets KSPMonitorSingularValue()
-ksp_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to KSPMonitorSet(), but does not cancel those set via the options database.


The default is to do nothing. To print the residual, or preconditioned residual if KSPSetNormType(ksp,KSP_PRECONDITIONED_NORM) was called, use KSPMonitorDefault() as the monitoring routine, with a null monitoring context.

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


KSP, set, monitor

See Also

KSPMonitorDefault(), KSPMonitorLGCreate(), KSPMonitorCancel()

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