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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
|
<!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/TaoGetConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoGetConvergedReason</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/TaoGetConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoGetConvergedReason"><H1>TaoGetConvergedReason</H1></A>
Gets the reason the <A HREF="../Tao/Tao.html#Tao">Tao</A> iteration was stopped.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petsctao.h"
PetscErrorCode TaoGetConvergedReason(Tao tao, TaoConvergedReason *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>tao </B> -the <A HREF="../Tao/Tao.html#Tao">Tao</A> solver context
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>reason </B> -one of
<br>
<pre>
TAO_CONVERGED_GATOL (3) ||g(X)|| < gatol
</pre>
<pre>
TAO_CONVERGED_GRTOL (4) ||g(X)|| / f(X) < grtol
</pre>
<pre>
TAO_CONVERGED_GTTOL (5) ||g(X)|| / ||g(X0)|| < gttol
</pre>
<pre>
TAO_CONVERGED_STEPTOL (6) step size small
</pre>
<pre>
TAO_CONVERGED_MINF (7) F < F_min
</pre>
<pre>
TAO_CONVERGED_USER (8) User defined
</pre>
<pre>
TAO_DIVERGED_MAXITS (-2) its > maxits
</pre>
<pre>
TAO_DIVERGED_NAN (-4) Numerical problems
</pre>
<pre>
TAO_DIVERGED_MAXFCN (-5) fevals > max_funcsals
</pre>
<pre>
TAO_DIVERGED_LS_FAILURE (-6) line search failure
</pre>
<pre>
TAO_DIVERGED_TR_REDUCTION (-7) trust region failure
</pre>
<pre>
TAO_DIVERGED_USER(-8) (user defined)
</pre>
$ TAO_CONTINUE_ITERATING (0)
<P>
where
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X </B></TD><TD>- current solution
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>X0 </B></TD><TD>- initial guess
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f(X) </B></TD><TD>- current function value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f(X*) </B></TD><TD>- true solution (estimated)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>g(X) </B></TD><TD>- current gradient
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>its </B></TD><TD>- current iterate number
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>maxits </B></TD><TD>- maximum number of iterates
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fevals </B></TD><TD>- number of function evaluations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>max_funcsals </B></TD><TD>- maximum number of function evaluations
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../Tao/TaoSetConvergenceTest.html#TaoSetConvergenceTest">TaoSetConvergenceTest</A>(), <A HREF="../Tao/TaoSetTolerances.html#TaoSetTolerances">TaoSetTolerances</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#TaoGetConvergedReason">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/constrained/examples/tutorials/maros.c.html">src/tao/constrained/examples/tutorials/maros.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>
|
