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://slepc.upv.es/documentation/current/docs/manualpages/NEP/NEPGetConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>NEPGetConvergedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.7.3 2016-09-29</b></div>
<div id="bugreport" align=right><a href="mailto:slepc-maint@upv.es?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: slepc-3.7.3 v3.7.3 docs/manualpages/NEP/NEPGetConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<H1>NEPGetConvergedReason</H1>
Gets the reason why the <A HREF="../NEP/NEPSolve.html#NEPSolve">NEPSolve</A>() iteration was stopped.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h"
PetscErrorCode NEPGetConvergedReason(NEP nep,NEPConvergedReason *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0"><TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nep </B></TD><TD> - the nonlinear eigensolver context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">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
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
<P>
Possible values for reason are
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_CONVERGED_TOL </B></TD><TD> - converged up to tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_CONVERGED_USER </B></TD><TD> - converged due to a user-defined condition
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_DIVERGED_ITS </B></TD><TD> - required more than max_it iterations to reach convergence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_DIVERGED_BREAKDOWN </B></TD><TD> - generic breakdown in method
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_DIVERGED_LINEAR_SOLVE </B></TD><TD> - inner linear solve failed
</TD></TR></TABLE>
<P>
Can only be called after the call to <A HREF="../NEP/NEPSolve.html#NEPSolve">NEPSolve</A>() is complete.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../NEP/NEPSetTolerances.html#NEPSetTolerances">NEPSetTolerances</A>(), <A HREF="../NEP/NEPSolve.html#NEPSolve">NEPSolve</A>(), <A HREF="../NEP/NEPConvergedReason.html#NEPConvergedReason">NEPConvergedReason</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/nep/interface/nepsolve.c.html#NEPGetConvergedReason">src/nep/interface/nepsolve.c</A>
<BR><A HREF="./index.html">Index of all NEP 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>
|
