1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/LME/LMEMonitorSet.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>LMEMonitorSet</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.23.1 2025-05-01</b></div>
<div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/LME/LMEMonitorSet.html "><small>Report Typos and Errors</small></a></div>
<H1>LMEMonitorSet</H1>
Sets an ADDITIONAL function to be called at every iteration to monitor convergence.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepclme.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../LME/LMEMonitorSet.html#LMEMonitorSet">LMEMonitorSet</A>(<A HREF="../LME/LME.html#LME">LME</A> lme,<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*monitor)(<A HREF="../LME/LME.html#LME">LME</A> lme,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> its,<A HREF="https://petsc.org/release/manualpages/Sys/PetscReal.html#PetscReal">PetscReal</A> errest,void*mctx),void *mctx,<A HREF="https://petsc.org/release/manualpages/Sys/PetscCtxDestroyFn.html#PetscCtxDestroyFn">PetscCtxDestroyFn</A> *monitordestroy)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lme </B></TD><TD> - linear matrix equation solver context obtained from <A HREF="../LME/LMECreate.html#LMECreate">LMECreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>monitor </B></TD><TD> - pointer to function (if this is NULL, it turns off monitoring)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mctx </B></TD><TD> - [optional] context for private data for the
monitor routine (use NULL if no context is desired)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>monitordestroy </B></TD><TD> - [optional] routine that frees monitor context (may be NULL),
see <A HREF="https://petsc.org/release/manualpages/Sys/PetscCtxDestroyFn.html#PetscCtxDestroyFn">PetscCtxDestroyFn</A> for the calling sequence
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Calling sequence of monitor</FONT></H3>
<pre>
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> monitor(<A HREF="../LME/LME.html#LME">LME</A> lme,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> its,<A HREF="https://petsc.org/release/manualpages/Sys/PetscReal.html#PetscReal">PetscReal</A> errest,void*mctx)
</pre>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lme </B></TD><TD> - linear matrix equation solver context obtained from <A HREF="../LME/LMECreate.html#LMECreate">LMECreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>its </B></TD><TD> - iteration number
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>errest </B></TD><TD> - error estimate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mctx </B></TD><TD> - optional monitoring context, as set by <A HREF="../LME/LMEMonitorSet.html#LMEMonitorSet">LMEMonitorSet</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-lme_monitor </B></TD><TD> - print the error estimate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-lme_monitor draw::draw_lg </B></TD><TD> - sets line graph monitor for the error estimate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-lme_monitor_cancel </B></TD><TD> - cancels all monitors that have been hardwired into
a code by calls to <A HREF="../LME/LMEMonitorSet.html#LMEMonitorSet">LMEMonitorSet</A>(), but does not cancel those set via
the options database.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
Several different monitoring routines may be set by calling
<A HREF="../LME/LMEMonitorSet.html#LMEMonitorSet">LMEMonitorSet</A>() multiple times; all will be called in the
order in which they were set.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../LME/LMEMonitorCancel.html#LMEMonitorCancel">LMEMonitorCancel</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/lme/interface/lmemon.c.html#LMEMonitorSet">src/lme/interface/lmemon.c</A>
<BR><BR><A HREF="./index.html">Index of all LME routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
