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="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPGetConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPGetConvergedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/PEP/PEPGetConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPGetConvergedReason</H1>
Gets the reason why the <A HREF="../PEP/PEPSolve.html#PEPSolve">PEPSolve</A>() iteration was stopped.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcpep.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PEP/PEPGetConvergedReason.html#PEPGetConvergedReason">PEPGetConvergedReason</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEPConvergedReason</A> *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>pep </B></TD><TD> - the polynomial 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">Options Database Key</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_converged_reason </B></TD><TD> - print the reason to a viewer
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
Possible values for reason are
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_CONVERGED_TOL</A> </B></TD><TD> - converged up to tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_CONVERGED_USER</A> </B></TD><TD> - converged due to a user-defined condition
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_DIVERGED_ITS</A> </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><A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_DIVERGED_BREAKDOWN</A> </B></TD><TD> - generic breakdown in method
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_DIVERGED_SYMMETRY_LOST</A> </B></TD><TD> - pseudo-Lanczos was not able to keep symmetry
</TD></TR></TABLE>
<P>
Can only be called after the call to <A HREF="../PEP/PEPSolve.html#PEPSolve">PEPSolve</A>() is complete.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPSetTolerances.html#PEPSetTolerances">PEPSetTolerances</A>(), <A HREF="../PEP/PEPSolve.html#PEPSolve">PEPSolve</A>(), <A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEPConvergedReason</A>
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/pep/interface/pepsolve.c.html#PEPGetConvergedReason">src/pep/interface/pepsolve.c</A>
<BR><BR><A HREF="./index.html">Index of all PEP routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
