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
|
<!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/TSGetConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>TSGetConvergedReason</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/TSGetConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<A NAME="TSGetConvergedReason"><H1>TSGetConvergedReason</H1></A>
Gets the reason the <A HREF="../TS/TS.html#TS">TS</A> iteration was stopped.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscts.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../TS/TSGetConvergedReason.html#TSGetConvergedReason">TSGetConvergedReason</A>(<A HREF="../TS/TS.html#TS">TS</A> ts,<A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSConvergedReason</A> *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ts </B></TD><TD>- the <A HREF="../TS/TS.html#TS">TS</A> context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD>- negative value indicates diverged, positive value converged, see <A HREF="../TS/TSConvergedReason.html#TSConvergedReason">TSConvergedReason</A> or the
manual pages for the individual convergence tests for complete lists
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Can only be called after the call to <A HREF="../TS/TSSolve.html#TSSolve">TSSolve</A>() is complete.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
TSSetConvergenceTest(), <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/ts/interface/ts.c.html#TSGetConvergedReason">src/ts/interface/ts.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/ts/tutorials/ex11.c.html">src/ts/tutorials/ex11.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex22.c.html">src/ts/tutorials/ex22.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex25.c.html">src/ts/tutorials/ex25.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex26.c.html">src/ts/tutorials/ex26.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex34.c.html">src/ts/tutorials/ex34.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex35.cxx.html">src/ts/tutorials/ex35.cxx.html</A><BR>
<A HREF="../../../src/ts/tutorials/extchem.c.html">src/ts/tutorials/extchem.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/extchemfield.c.html">src/ts/tutorials/extchemfield.c.html</A><BR>
<A HREF="../../../src/ts/tutorials/ex1f.F.html">src/ts/tutorials/ex1f.F.html</A><BR>
<A HREF="../../../src/ts/utils/dmplexlandau/tutorials/ex2.c.html">src/ts/utils/dmplexlandau/tutorials/ex2.c.html</A><BR>
<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>
|
