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
|
<!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/TaoSetConvergenceHistory.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoSetConvergenceHistory</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/Tao/TaoSetConvergenceHistory.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoSetConvergenceHistory"><H1>TaoSetConvergenceHistory</H1></A>
Sets the array used to hold the convergence history.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
PetscErrorCode TaoSetConvergenceHistory(Tao tao, PetscReal *obj, PetscReal *resid, PetscReal *cnorm, PetscInt *lits, PetscInt na,PetscBool reset)
</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>obj </B></TD><TD>- array to hold objective value history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>resid </B></TD><TD>- array to hold residual history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cnorm </B></TD><TD>- array to hold constraint violation history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lits </B></TD><TD>- integer array holds the number of linear iterations for each <A HREF="../Tao/Tao.html#Tao">Tao</A> iteration
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>na </B></TD><TD>- size of obj, resid, and cnorm
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reset </B></TD><TD>- PetscTrue indicates each new minimization resets the history counter to zero,
else it continues storing new values for new minimizations after the old ones
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If set, TAO will fill the given arrays with the indicated
information at each iteration. If 'obj','resid','cnorm','lits' are
*all* NULL then space (using size na, or 1000 if na is <A HREF="../Sys/PETSC_DECIDE.html#PETSC_DECIDE">PETSC_DECIDE</A> or
<A HREF="../Sys/PETSC_DEFAULT.html#PETSC_DEFAULT">PETSC_DEFAULT</A>) is allocated for the history.
If not all are NULL, then only the non-NULL information categories
will be stored, the others will be ignored.
<P>
Any convergence information after iteration number 'na' will not be stored.
<P>
This routine is useful, e.g., when running a code for purposes
of accurate performance monitoring, when no I/O should be done
during the section of code that is being timed.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Tao/TaoGetConvergenceHistory.html#TaoGetConvergenceHistory">TaoGetConvergenceHistory</A>()
<BR>
<P>
<P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>intermediate
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/tao/interface/taosolver.c.html#TaoSetConvergenceHistory">src/tao/interface/taosolver.c</A>
<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>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/tao/leastsquares/examples/tutorials/chwirut1.c.html">src/tao/leastsquares/examples/tutorials/chwirut1.c.html</A><BR>
<A HREF="../../../src/tao/leastsquares/examples/tutorials/chwirut1f.F.html">src/tao/leastsquares/examples/tutorials/chwirut1f.F.html</A><BR>
</BODY></HTML>
|
