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/KSP/KSPConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>KSPConvergedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/KSP/KSPConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="KSPConvergedReason"><H1>KSPConvergedReason</H1></A>
reason a Krylov method was said to have converged or diverged
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef enum {/* converged */
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_RTOL_NORMAL</A> = 1,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_ATOL_NORMAL</A> = 9,
<A HREF="../KSP/KSP_CONVERGED_RTOL.html#KSP_CONVERGED_RTOL">KSP_CONVERGED_RTOL</A> = 2,
<A HREF="../KSP/KSP_CONVERGED_ATOL.html#KSP_CONVERGED_ATOL">KSP_CONVERGED_ATOL</A> = 3,
<A HREF="../KSP/KSP_CONVERGED_ITS.html#KSP_CONVERGED_ITS">KSP_CONVERGED_ITS</A> = 4,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_CG_NEG_CURVE</A> = 5,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_CG_CONSTRAINED</A> = 6,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_STEP_LENGTH</A> = 7,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_CONVERGED_HAPPY_BREAKDOWN</A> = 8,
/* diverged */
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_DIVERGED_NULL</A> = -2,
<A HREF="../KSP/KSP_DIVERGED_ITS.html#KSP_DIVERGED_ITS">KSP_DIVERGED_ITS</A> = -3,
<A HREF="../KSP/KSP_DIVERGED_DTOL.html#KSP_DIVERGED_DTOL">KSP_DIVERGED_DTOL</A> = -4,
<A HREF="../KSP/KSP_DIVERGED_BREAKDOWN.html#KSP_DIVERGED_BREAKDOWN">KSP_DIVERGED_BREAKDOWN</A> = -5,
<A HREF="../KSP/KSP_DIVERGED_BREAKDOWN_BICG.html#KSP_DIVERGED_BREAKDOWN_BICG">KSP_DIVERGED_BREAKDOWN_BICG</A> = -6,
<A HREF="../KSP/KSP_DIVERGED_NONSYMMETRIC.html#KSP_DIVERGED_NONSYMMETRIC">KSP_DIVERGED_NONSYMMETRIC</A> = -7,
<A HREF="../KSP/KSP_DIVERGED_INDEFINITE_PC.html#KSP_DIVERGED_INDEFINITE_PC">KSP_DIVERGED_INDEFINITE_PC</A> = -8,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_DIVERGED_NANORINF</A> = -9,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_DIVERGED_INDEFINITE_MAT</A> = -10,
<A HREF="../KSP/KSP_DIVERGED_PC_FAILED.html#KSP_DIVERGED_PC_FAILED">KSP_DIVERGED_PC_FAILED</A> = -11,
<A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSP_DIVERGED_PCSETUP_FAILED_DEPRECATED</A> = -11,
<A HREF="../KSP/KSP_CONVERGED_ITERATING.html#KSP_CONVERGED_ITERATING">KSP_CONVERGED_ITERATING</A> = 0} <A HREF="../KSP/KSPConvergedReason.html#KSPConvergedReason">KSPConvergedReason</A>;
</PRE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
See <A HREF="../KSP/KSPGetConvergedReason.html#KSPGetConvergedReason">KSPGetConvergedReason</A>() for explanation of each value
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
this must match petsc/finclude/petscksp.h
<P>
The string versions of these are KSPConvergedReasons; if you change
any of the values here also change them that array of names.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../KSP/KSPSolve.html#KSPSolve">KSPSolve</A>(), <A HREF="../KSP/KSPGetConvergedReason.html#KSPGetConvergedReason">KSPGetConvergedReason</A>(), <A HREF="../KSP/KSPSetTolerances.html#KSPSetTolerances">KSPSetTolerances</A>(), <A HREF="../KSP/KSPConvergedReasonView.html#KSPConvergedReasonView">KSPConvergedReasonView</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/ksp/ksp/guess/../../../../include/petscksp.h.html#KSPConvergedReason">src/ksp/ksp/guess/../../../../include/petscksp.h</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ksp/ksp/tutorials/ex72.c.html">src/ksp/ksp/tutorials/ex72.c.html</A><BR>
<A HREF="../../../src/ksp/ksp/tutorials/ex77.c.html">src/ksp/ksp/tutorials/ex77.c.html</A><BR>
<BR><A HREF="./index.html">Index of all KSP 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>
|
