EPSMonitorSet

Sets an ADDITIONAL function to be called at every iteration to monitor the error estimates for each requested eigenpair.

Synopsis

#include "slepceps.h" 
PetscErrorCode EPSMonitorSet(EPS eps,PetscErrorCode (*monitor)(EPS,PetscInt,PetscInt,PetscScalar*,PetscScalar*,PetscReal*,PetscInt,void*),
                             void *mctx,PetscErrorCode (*monitordestroy)(void*))
Collective on EPS

Input Parameters

eps - eigensolver context obtained from EPSCreate()
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 (EPS eps, int its, int nconv, PetscScalar *eigr, PetscScalar *eigi, PetscReal* errest, int nest, void *mctx)

eps - eigensolver context obtained from EPSCreate()
its - iteration number
nconv - number of converged eigenpairs
eigr - real part of the eigenvalues
eigi - imaginary part of the eigenvalues
errest - relative error estimates for each eigenpair
nest - number of error estimates
mctx - optional monitoring context, as set by EPSMonitorSet()

Options Database Keys

-eps_monitor - print error estimates at each iteration
-eps_monitor_draw - sets line graph monitor
-eps_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to EPSMonitorSet(), but does not cancel those set via the options database.

Notes

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

See Also

EPSMonitorDefault(), EPSMonitorCancel()

Location: src/eps/interface/monitor.c
Index of all EPS routines
Table of Contents for all manual pages
Index of all manual pages