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
77
78
79
80
81
82
83
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/Tao/TaoSetMonitor.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetMonitor</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/Tao/TaoSetMonitor.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetMonitor"><H1>TaoSetMonitor</H1></A>
Sets an ADDITIONAL function that is to be used at every iteration of the solver to display the iteration's progress.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoSetMonitor.html#TaoSetMonitor">TaoSetMonitor</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*func)(<A HREF="../Tao/Tao.html#Tao">Tao</A>, void*), void *ctx,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*dest)(void**))
</PRE>
Logically Collective on <A HREF="../Tao/Tao.html#Tao">Tao</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>tao </B></TD><TD>- the <A HREF="../Tao/Tao.html#Tao">Tao</A> solver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mymonitor </B></TD><TD>- monitoring routine
</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 (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence of mymonitor</FONT></H3>
<pre>
int mymonitor(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao,void *mctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>tao </B></TD><TD>- the <A HREF="../Tao/Tao.html#Tao">Tao</A> solver context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mctx </B></TD><TD>- [optional] monitoring context
</TD></TR></TABLE>
<P>
<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>-tao_monitor </B></TD><TD>- sets <A HREF="../Tao/TaoMonitorDefault.html#TaoMonitorDefault">TaoMonitorDefault</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_smonitor </B></TD><TD>- sets short monitor
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_cmonitor </B></TD><TD>- same as smonitor plus constraint norm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_solution </B></TD><TD>- view solution at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_gradient </B></TD><TD>- view gradient at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_view_separableobjective </B></TD><TD>- view separable objective function at each iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-tao_cancelmonitors </B></TD><TD>- cancels all monitors that have been hardwired into a code by calls to <A HREF="../Tao/TaoSetMonitor.html#TaoSetMonitor">TaoSetMonitor</A>(), but does not cancel those set via the options database.
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Several different monitoring routines may be set by calling
<A HREF="../Tao/TaoSetMonitor.html#TaoSetMonitor">TaoSetMonitor</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 one monitor function may be set
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Tao/TaoMonitorDefault.html#TaoMonitorDefault">TaoMonitorDefault</A>(), <A HREF="../Tao/TaoCancelMonitors.html#TaoCancelMonitors">TaoCancelMonitors</A>(), TaoSetDestroyRoutine()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/interface/taosolver.c.html#TaoSetMonitor">src/tao/interface/taosolver.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/minsurf2.c.html">src/tao/unconstrained/examples/tutorials/minsurf2.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/spectraladjointassimilation.c.html">src/tao/unconstrained/examples/tutorials/spectraladjointassimilation.c.html</A><BR>
<A HREF="../../../src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html">src/tao/unconstrained/examples/tutorials/eptorsion2f.F.html</A><BR>
<A HREF="../../../src/tao/bound/examples/tutorials/jbearing2.c.html">src/tao/bound/examples/tutorials/jbearing2.c.html</A><BR>
<A HREF="../../../src/tao/leastsquares/examples/tutorials/chwirut2.c.html">src/tao/leastsquares/examples/tutorials/chwirut2.c.html</A><BR>
<BR><A HREF="./index.html">Index of all Tao 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>
|
