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
76
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESMonitorSet.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESMonitorSet</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/SNES/SNESMonitorSet.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESMonitorSet"><H1>SNESMonitorSet</H1></A>
Sets an ADDITIONAL function that is to be used at every iteration of the nonlinear solver to display the iteration's progress.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESMonitorSet.html#SNESMonitorSet">SNESMonitorSet</A>(<A HREF="../SNES/SNES.html#SNES">SNES</A> snes,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*f)(<A HREF="../SNES/SNES.html#SNES">SNES</A>,<A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A>,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A>,void*),void *mctx,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*monitordestroy)(void**))
</PRE>
Logically Collective on <A HREF="../SNES/SNES.html#SNES">SNES</A>
<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>snes </B></TD><TD>- the <A HREF="../SNES/SNES.html#SNES">SNES</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- the monitor function, see <A HREF="../SNES/SNESMonitorFunction.html#SNESMonitorFunction">SNESMonitorFunction</A> for the calling sequence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mctx </B></TD><TD>- [optional] user-defined 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">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_monitor </B></TD><TD>- sets <A HREF="../SNES/SNESMonitorDefault.html#SNESMonitorDefault">SNESMonitorDefault</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_monitor_lg_residualnorm </B></TD><TD>- sets line graph monitor,
uses SNESMonitorLGCreate()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-snes_monitor_cancel </B></TD><TD>- cancels all monitors that have
been hardwired into a code by
calls to <A HREF="../SNES/SNESMonitorSet.html#SNESMonitorSet">SNESMonitorSet</A>(), but
does not cancel those set via
the options database.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Several different monitoring routines may be set by calling
<A HREF="../SNES/SNESMonitorSet.html#SNESMonitorSet">SNESMonitorSet</A>() multiple times; all will be called in the
order in which they were set.
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
Only a single monitor function can be set for each <A HREF="../SNES/SNES.html#SNES">SNES</A> object
<P>
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, nonlinear, set, monitor
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/SNESMonitorDefault.html#SNESMonitorDefault">SNESMonitorDefault</A>(), <A HREF="../SNES/SNESMonitorCancel.html#SNESMonitorCancel">SNESMonitorCancel</A>(), <A HREF="../SNES/SNESMonitorFunction.html#SNESMonitorFunction">SNESMonitorFunction</A>
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/interface/snes.c.html#SNESMonitorSet">src/snes/interface/snes.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex2.c.html">src/snes/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex3.c.html">src/snes/examples/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex12.c.html">src/snes/examples/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex21.c.html">src/snes/examples/tutorials/ex21.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex22.c.html">src/snes/examples/tutorials/ex22.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex7.c.html">src/ts/examples/tutorials/ex7.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex12.c.html">src/ts/examples/tutorials/ex12.c.html</A><BR>
<BR><A HREF="./index.html">Index of all SNES 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>
|
