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
|
<!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>SVDGetConvergedReason</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1>SVDGetConvergedReason</H1>
Gets the reason why the <A HREF="../SVD/SVDSolve.html#SVDSolve">SVDSolve</A>() iteration was stopped.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcsvd.h"
PetscErrorCode SVDGetConvergedReason(SVD svd,SVDConvergedReason *reason)
</PRE>
Not Collective
<P>
<H3><FONT COLOR="#883300">Input Parameter</FONT></H3>
<DT><B>svd </B> - the singular value solver context
<br>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<DT><B>reason </B> - negative value indicates diverged, positive value converged
(see <A HREF="../SVD/SVDConvergedReason.html#SVDConvergedReason">SVDConvergedReason</A>)
<br>
<P>
<H3><FONT COLOR="#883300">Possible values for reason</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SVD_CONVERGED_TOL </B></TD><TD> - converged up to tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SVD_DIVERGED_ITS </B></TD><TD> - required more than its to reach convergence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>SVD_DIVERGED_BREAKDOWN </B></TD><TD> - generic breakdown in method
</TD></TR></TABLE>
<P>
<P>
Notes: Can only be called after the call to <A HREF="../SVD/SVDSolve.html#SVDSolve">SVDSolve</A>() is complete.
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../SVD/SVDSetTolerances.html#SVDSetTolerances">SVDSetTolerances</A>(), <A HREF="../SVD/SVDSolve.html#SVDSolve">SVDSolve</A>(), <A HREF="../SVD/SVDConvergedReason.html#SVDConvergedReason">SVDConvergedReason</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/svd/interface/svdsolve.c.html#SVDGetConvergedReason">src/svd/interface/svdsolve.c</A>
<BR><A HREF="./index.html">Index of all SVD 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>
|
