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
|
<!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/TaoGetConvergenceHistory.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoGetConvergenceHistory</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/TaoGetConvergenceHistory.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoGetConvergenceHistory"><H1>TaoGetConvergenceHistory</H1></A>
Gets the arrays used to hold the convergence history.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../Tao/TaoGetConvergenceHistory.html#TaoGetConvergenceHistory">TaoGetConvergenceHistory</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> **obj, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> **resid, <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> **cnorm, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> **lits, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *nhist)
</PRE>
Collective on <A HREF="../Tao/Tao.html#Tao">Tao</A>
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>tao </B> -the <A HREF="../Tao/Tao.html#Tao">Tao</A> context
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>obj </B></TD><TD>- array used to hold objective value history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>resid </B></TD><TD>- array used to hold residual history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>cnorm </B></TD><TD>- array used to hold constraint violation history
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lits </B></TD><TD>- integer array used to hold linear solver iteration count
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nhist </B></TD><TD>- size of obj, resid, cnorm, and lits (will be less than or equal to na given in TaoSetHistory)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This routine must be preceded by calls to <A HREF="../Tao/TaoSetConvergenceHistory.html#TaoSetConvergenceHistory">TaoSetConvergenceHistory</A>()
and <A HREF="../Tao/TaoSolve.html#TaoSolve">TaoSolve</A>(), otherwise it returns useless information.
<P>
The calling sequence for this routine in Fortran is
<pre>
call <A HREF="../Tao/TaoGetConvergenceHistory.html#TaoGetConvergenceHistory">TaoGetConvergenceHistory</A>(<A HREF="../Tao/Tao.html#Tao">Tao</A> tao, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> nhist, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> ierr)
</pre>
<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/TaoSetConvergenceHistory.html#TaoSetConvergenceHistory">TaoSetConvergenceHistory</A>()
<BR>
<P>
<P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/interface/taosolver.c.html#TaoGetConvergenceHistory">src/tao/interface/taosolver.c</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.F90.html">src/tao/leastsquares/examples/tutorials/chwirut1f.F90.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>
|
