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
74
75
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Sys/PetscOptionsMonitorSet.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>PetscOptionsMonitorSet</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.4.2 2013-07-02</b></div>
<A NAME="PetscOptionsMonitorSet"><H1>PetscOptionsMonitorSet</H1></A>
Sets an ADDITIONAL function to be called at every method that modified the PETSc options database.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsys.h"
PetscErrorCode PetscOptionsMonitorSet(PetscErrorCode (*monitor)(const char name[], const char value[], void*),void *mctx,PetscErrorCode (*monitordestroy)(void**))
</PRE>
Not collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<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)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling Sequence of monitor</FONT></H3>
<pre>
monitor (const char name[], const char value[], void *mctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>name </B></TD><TD>- option name string
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>value </B></TD><TD>- option value string
</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="../Sys/PetscOptionsMonitorSet.html#PetscOptionsMonitorSet">PetscOptionsMonitorSet</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-options_monitor </B></TD><TD>- sets <A HREF="../Sys/PetscOptionsMonitorDefault.html#PetscOptionsMonitorDefault">PetscOptionsMonitorDefault</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-options_monitor_cancel </B></TD><TD>- cancels all monitors that have
been hardwired into a code by
calls to <A HREF="../Sys/PetscOptionsMonitorSet.html#PetscOptionsMonitorSet">PetscOptionsMonitorSet</A>(), but
does not cancel those set via
the options database.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The default is to do nothing. To print the name and value of options
being inserted into the database, use <A HREF="../Sys/PetscOptionsMonitorDefault.html#PetscOptionsMonitorDefault">PetscOptionsMonitorDefault</A>() as the monitoring routine,
with a null monitoring context.
<P>
Several different monitoring routines may be set by calling
<A HREF="../Sys/PetscOptionsMonitorSet.html#PetscOptionsMonitorSet">PetscOptionsMonitorSet</A>() multiple times; all will be called in the
order in which they were set.
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
PetscOptions, set, monitor
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Sys/PetscOptionsMonitorDefault.html#PetscOptionsMonitorDefault">PetscOptionsMonitorDefault</A>(), <A HREF="../Sys/PetscOptionsMonitorCancel.html#PetscOptionsMonitorCancel">PetscOptionsMonitorCancel</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>beginner
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/sys/objects/options.c.html#PetscOptionsMonitorSet">src/sys/objects/options.c</A>
<BR><A HREF="./index.html">Index of all Sys routines</A>
<BR><A HREF="../../index.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
