File: EPSGetIterationNumber.html

package info (click to toggle)
slepc 3.2-p5-1
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 11,356 kB
  • sloc: ansic: 34,162; makefile: 2,041; python: 1,411; fortran: 486; f90: 184; sh: 9
file content (54 lines) | stat: -rw-r--r-- 3,072 bytes parent folder | download
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>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>EPSGetIterationNumber</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">

<H1>EPSGetIterationNumber</H1>
Gets the current iteration number. If the  call to <A HREF="../EPS/EPSSolve.html#EPSSolve">EPSSolve</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 "slepceps.h" 
PetscErrorCode EPSGetIterationNumber(EPS eps,PetscInt *its)
</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>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="../EPS/EPSSolve.html#EPSSolve">EPSSolve</A>() is
complete, then parameter "its" contains either the iteration number at
which convergence was successfully reached, or failure was detected.
Call <A HREF="../EPS/EPSGetConvergedReason.html#EPSGetConvergedReason">EPSGetConvergedReason</A>() to determine if the solver converged or
failed and why.
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../EPS/EPSGetConvergedReason.html#EPSGetConvergedReason">EPSGetConvergedReason</A>(), <A HREF="../EPS/EPSSetTolerances.html#EPSSetTolerances">EPSSetTolerances</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/eps/interface/solve.c.html#EPSGetIterationNumber">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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/eps/examples/tutorials/ex1.c.html">src/eps/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex2.c.html">src/eps/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex3.c.html">src/eps/examples/tutorials/ex3.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex4.c.html">src/eps/examples/tutorials/ex4.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex5.c.html">src/eps/examples/tutorials/ex5.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex7.c.html">src/eps/examples/tutorials/ex7.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex9.c.html">src/eps/examples/tutorials/ex9.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex11.c.html">src/eps/examples/tutorials/ex11.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex12.c.html">src/eps/examples/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex13.c.html">src/eps/examples/tutorials/ex13.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex18.c.html">src/eps/examples/tutorials/ex18.c.html</A><BR>
</BODY></HTML>