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
|
<!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/TaoConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TaoConvergedReason</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/TaoConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TaoConvergedReason"><H1>TaoConvergedReason</H1></A>
reason a TAO method was said to have converged or diverged
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef enum {/* converged */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_GATOL</A> = 3, /* ||g(X)|| < gatol */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_GRTOL</A> = 4, /* ||g(X)|| / f(X) < grtol */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_GTTOL</A> = 5, /* ||g(X)|| / ||g(X0)|| < gttol */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_STEPTOL</A> = 6, /* step size small */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_MINF</A> = 7, /* F < F_min */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONVERGED_USER</A> = 8, /* User defined */
/* diverged */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_MAXITS</A> = -2,
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_NAN</A> = -4,
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_MAXFCN</A> = -5,
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_LS_FAILURE</A> = -6,
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_TR_REDUCTION</A> = -7,
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_DIVERGED_USER</A> = -8, /* User defined */
/* keep going */
<A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TAO_CONTINUE_ITERATING</A> = 0} <A HREF="../Tao/TaoConvergedReason.html#TaoConvergedReason">TaoConvergedReason</A>;
</PRE>
<P>
The two most common reasons for divergence are
<pre>
1) an incorrectly coded or computed gradient or Hessian
</pre>
<pre>
2) failure or lack of convergence in the linear system (in this case we recommend
</pre>
<pre>
testing with -pc_type lu to eliminate the linear solver as the cause of the problem).
</pre>
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
this must match petsc/finclude/petsctao.h
<P>
The string versions of these are in TAOConvergedReasons, if you change any value here you must
also adjust that array.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
TAOSolve(), <A HREF="../Tao/TaoGetConvergedReason.html#TaoGetConvergedReason">TaoGetConvergedReason</A>(), <A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSPConvergedReason</A>, <A HREF="../SNES/SNESConvergedReason.html#SNESConvergedReason">SNESConvergedReason</A>, <A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSConvergedReason</A>
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/tao/../../include/petsctao.h.html#TaoConvergedReason">src/tao/../../include/petsctao.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<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>
<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>
|
