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
|
<!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>MFNGetIterationNumber</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1>MFNGetIterationNumber</H1>
Gets the current iteration number. If the call to <A HREF="../MFN/MFNSolve.html#MFNSolve">MFNSolve</A>() is complete, then it returns the number of iterations carried out by the solution method.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcmfn.h"
PetscErrorCode MFNGetIterationNumber(MFN mfn,PetscInt *its)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<DT><B>mfn </B> - the matrix function context
<br>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<DT><B>its </B> - number of iterations
<br>
<P>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
During the i-th iteration this call returns i-1. If <A HREF="../MFN/MFNSolve.html#MFNSolve">MFNSolve</A>() is
complete, then parameter "its" contains either the iteration number at
which convergence was successfully reached, or failure was detected.
Call <A HREF="../MFN/MFNGetConvergedReason.html#MFNGetConvergedReason">MFNGetConvergedReason</A>() to determine if the solver converged or
failed and why.
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../MFN/MFNGetConvergedReason.html#MFNGetConvergedReason">MFNGetConvergedReason</A>(), <A HREF="../MFN/MFNSetTolerances.html#MFNSetTolerances">MFNSetTolerances</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/mfn/interface/mfnsolve.c.html#MFNGetIterationNumber">src/mfn/interface/mfnsolve.c</A>
<BR><A HREF="./index.html">Index of all MFN 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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/mfn/examples/tutorials/ex23.c.html">src/mfn/examples/tutorials/ex23.c.html</A><BR>
</BODY></HTML>
|
