File: TSConvergedReason.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (43 lines) | stat: -rw-r--r-- 2,838 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/TS/TSConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSConvergedReason</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/TS/TSConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSConvergedReason"><H1>TSConvergedReason</H1></A>
reason a <A HREF="../TS/TS.html#TS">TS</A> method has converged or not 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
typedef enum {
  <A HREF="../TS/TS_CONVERGED_ITERATING.html#TS_CONVERGED_ITERATING">TS_CONVERGED_ITERATING</A>          = 0,
  <A HREF="../TS/TS_CONVERGED_TIME.html#TS_CONVERGED_TIME">TS_CONVERGED_TIME</A>               = 1,
  <A HREF="../TS/TS_CONVERGED_ITS.html#TS_CONVERGED_ITS">TS_CONVERGED_ITS</A>                = 2,
  <A HREF="../TS/TS_CONVERGED_USER.html#TS_CONVERGED_USER">TS_CONVERGED_USER</A>               = 3,
  <A HREF="../TS/TS_CONVERGED_EVENT.html#TS_CONVERGED_EVENT">TS_CONVERGED_EVENT</A>              = 4,
  <A HREF="../TS/TS_CONVERGED_PSEUDO_FATOL.html#TS_CONVERGED_PSEUDO_FATOL">TS_CONVERGED_PSEUDO_FATOL</A>       = 5,
  <A HREF="../TS/TS_CONVERGED_PSEUDO_FRTOL.html#TS_CONVERGED_PSEUDO_FRTOL">TS_CONVERGED_PSEUDO_FRTOL</A>       = 6,
  <A HREF="../TS/TS_DIVERGED_NONLINEAR_SOLVE.html#TS_DIVERGED_NONLINEAR_SOLVE">TS_DIVERGED_NONLINEAR_SOLVE</A>     = -1,
  <A HREF="../TS/TS_DIVERGED_STEP_REJECTED.html#TS_DIVERGED_STEP_REJECTED">TS_DIVERGED_STEP_REJECTED</A>       = -2,
  <A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSFORWARD_DIVERGED_LINEAR_SOLVE</A> = -3,
  <A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSADJOINT_DIVERGED_LINEAR_SOLVE</A> = -4
} <A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSConvergedReason</A>;
</PRE>

<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
this must match petsc/finclude/petscts.h
<P>
Each reason has its own manual page.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../TS/TSGetConvergedReason.html#TSGetConvergedReason">TSGetConvergedReason</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/ts/../../include/petscts.h.html#TSConvergedReason">src/ts/../../include/petscts.h</A>
<BR><A HREF="./index.html">Index of all TS 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>