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
62
63
64
65
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/MFN/MFNGetConvergedReason.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>MFNGetConvergedReason</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/MFN/MFNGetConvergedReason.html "><small>Report Typos and Errors</small></a></div>
<H1>MFNGetConvergedReason</H1>
Gets the reason why the <A HREF="../MFN/MFNSolve.html#MFNSolve">MFNSolve</A>() iteration was stopped.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcmfn.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../MFN/MFNGetConvergedReason.html#MFNGetConvergedReason">MFNGetConvergedReason</A>(<A HREF="../MFN/MFN.html#MFN">MFN</A> mfn,<A HREF="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFNConvergedReason</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>mfn </B></TD><TD> - the matrix function 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><A HREF="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFN_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="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFN_CONVERGED_ITS</A> </B></TD><TD> - solver completed the requested number of steps
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFN_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="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFN_DIVERGED_BREAKDOWN</A> </B></TD><TD> - generic breakdown in method
</TD></TR></TABLE>
<P>
Can only be called after the call to <A HREF="../MFN/MFNSolve.html#MFNSolve">MFNSolve</A>() is complete.
<P>
Basic solvers (e.g. unrestarted Krylov iterations) cannot determine if the
computation is accurate up to the requested tolerance. In that case, the
converged reason is set to <A HREF="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFN_CONVERGED_ITS</A> if the requested number of steps
(for instance, the ncv value in unrestarted Krylov methods) have been
completed successfully.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../MFN/MFNSetTolerances.html#MFNSetTolerances">MFNSetTolerances</A>(), <A HREF="../MFN/MFNSolve.html#MFNSolve">MFNSolve</A>(), <A HREF="../MFN/MFNConvergedReason.html#MFNConvergedReason">MFNConvergedReason</A>, <A HREF="../MFN/MFNSetErrorIfNotConverged.html#MFNSetErrorIfNotConverged">MFNSetErrorIfNotConverged</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/mfn/interface/mfnsolve.c.html#MFNGetConvergedReason">src/mfn/interface/mfnsolve.c</A>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/mfn/tutorials/ex23.c.html">src/mfn/tutorials/ex23.c</A><BR>
<A HREF="../../../src/mfn/tutorials/ex23f.F90.html">src/mfn/tutorials/ex23f.F90</A><BR>
<A HREF="../../../src/mfn/tutorials/ex37.c.html">src/mfn/tutorials/ex37.c</A><BR>
<BR><BR><A HREF="./index.html">Index of all MFN 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>
|
