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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>EPSGetConvergedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1>EPSGetConvergedReason</H1>
Gets the reason why the <A HREF="../EPS/EPSSolve.html#EPSSolve">EPSSolve</A>() iteration was stopped.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepceps.h"
PetscErrorCode EPSGetConvergedReason(EPS eps,EPSConvergedReason *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<DT><B>eps </B> - the eigensolver context
<br>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<DT><B>reason </B> - negative value indicates diverged, positive value converged
<br>
<P>
<H3><FONT COLOR="#883300">Possible values for reason</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_CONVERGED_TOL </B></TD><TD> - converged up to tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_DIVERGED_ITS </B></TD><TD> - required more than its to reach convergence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_DIVERGED_BREAKDOWN </B></TD><TD> - generic breakdown in method
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
Can only be called after the call to <A HREF="../EPS/EPSSolve.html#EPSSolve">EPSSolve</A>() is complete.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../EPS/EPSSetTolerances.html#EPSSetTolerances">EPSSetTolerances</A>(), <A HREF="../EPS/EPSSolve.html#EPSSolve">EPSSolve</A>(), <A HREF="../EPS/EPSConvergedReason.html#EPSConvergedReason">EPSConvergedReason</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/eps/interface/solve.c.html#EPSGetConvergedReason">src/eps/interface/solve.c</A>
<BR><A HREF="./index.html">Index of all EPS 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>
|
