File: EPSSetConvergenceTest.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 (55 lines) | stat: -rw-r--r-- 2,966 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
55
<!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>EPSSetConvergenceTest</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">

<H1>EPSSetConvergenceTest</H1>
Specifies how to compute the error estimate used in the convergence test. 
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepceps.h" 
PetscErrorCode EPSSetConvergenceTest(EPS eps,EPSConv conv)
</PRE>
Logically Collective on <A HREF="../EPS/EPS.html#EPS">EPS</A>
<P>
<H3><FONT COLOR="#883300">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eps   </B></TD><TD> - eigensolver context obtained from <A HREF="../EPS/EPSCreate.html#EPSCreate">EPSCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>conv  </B></TD><TD> - the type of convergence test
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-eps_conv_abs </B></TD><TD> - Sets the absolute convergence test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-eps_conv_eig </B></TD><TD> - Sets the convergence test relative to the eigenvalue
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-eps_conv_norm </B></TD><TD> - Sets the convergence test relative to the matrix norms
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
The parameter 'conv' can have one of these values
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_CONV_ABS </B></TD><TD> - absolute error ||r||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_CONV_EIG </B></TD><TD> - error relative to the eigenvalue l, ||r||/|l|
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_CONV_NORM </B></TD><TD> - error relative to the matrix norms, ||r||/(||A||+|l|*||B||)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>EPS_CONV_USER </B></TD><TD> - function set by <A HREF="../EPS/EPSSetConvergenceTestFunction.html#EPSSetConvergenceTestFunction">EPSSetConvergenceTestFunction</A>() 
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
 <A HREF="../EPS/EPSGetConvergenceTest.html#EPSGetConvergenceTest">EPSGetConvergenceTest</A>(), <A HREF="../EPS/EPSSetConvergenceTestFunction.html#EPSSetConvergenceTestFunction">EPSSetConvergenceTestFunction</A>(), <A HREF="../EPS/EPSConv.html#EPSConv">EPSConv</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/eps/interface/opts.c.html#EPSSetConvergenceTest">src/eps/interface/opts.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>
</BODY></HTML>