SVDMonitorSet#
Sets an ADDITIONAL function to be called at every iteration to monitor the error estimates for each requested singular triplet.
Synopsis#
#include "slepcsvd.h"
PetscErrorCode SVDMonitorSet(SVD svd,SVDMonitorFn *monitor,void *mctx,PetscCtxDestroyFn *monitordestroy)
Logically Collective
Input Parameters#
svd - the singular value solver context
monitor - pointer to function (if this is
NULL, it turns off monitoring), seeSVDMonitorFnmctx - [optional] context for private data for the monitor routine (use
NULLif no context is desired)monitordestroy - [optional] routine that frees monitor context (may be
NULL), seePetscCtxDestroyFnfor the calling sequence
Options Database Keys#
-svd_monitor - print only the first error estimate
-svd_monitor_all - print error estimates at each iteration
-svd_monitor_conv - print the singular value approximations only when convergence has been reached
-svd_monitor_conditioning - print the condition number when available
-svd_monitor draw::draw_lg - sets line graph monitor for the first unconverged approximate singular value
-svd_monitor_all draw::draw_lg - sets line graph monitor for all unconverged approximate singular values
-svd_monitor_conv draw::draw_lg - sets line graph monitor for convergence history
-svd_monitor_cancel - cancels all monitors that have been hardwired into a code by calls to
SVDMonitorSet(), but does not cancel those set via the options database.
Notes#
The options database option -svd_monitor and related options are the easiest way
to turn on SVD iteration monitoring.
SVDMonitorRegister() provides a way to associate an options database key with SVD
monitor function.
Several different monitoring routines may be set by calling SVDMonitorSet() multiple
times; all will be called in the order in which they were set.
Fortran Note#
Only a single monitor function can be set for each SVD object.
See Also#
SVD: Singular Value Decomposition, SVDMonitorFirst(), SVDMonitorAll(), SVDMonitorConverged(), SVDMonitorConditioning(), SVDMonitorFirstDrawLG(), SVDMonitorAllDrawLG(), SVDMonitorConvergedDrawLG(), SVDMonitorCancel()
Level#
intermediate
Location#
Index of all SVD routines Table of Contents for all manual pages Index of all manual pages