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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/NEP/NEPSetConvergenceTest.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>NEPSetConvergenceTest</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.7.3 2016-09-29</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.7.3 v3.7.3 docs/manualpages/NEP/NEPSetConvergenceTest.html "><small>Report Typos and Errors</small></a></div>
<H1>NEPSetConvergenceTest</H1>
Specifies how to compute the error estimate used in the convergence test.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h"
PetscErrorCode NEPSetConvergenceTest(NEP nep,NEPConv conv)
</PRE>
Logically Collective on <A HREF="../NEP/NEP.html#NEP">NEP</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>nep </B></TD><TD> - nonlinear eigensolver context obtained from <A HREF="../NEP/NEPCreate.html#NEPCreate">NEPCreate</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>-nep_conv_abs </B></TD><TD> - Sets the absolute convergence test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-nep_conv_rel </B></TD><TD> - Sets the convergence test relative to the eigenvalue
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-nep_conv_user </B></TD><TD> - Selects the user-defined convergence test
</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>NEP_CONV_ABS </B></TD><TD> - absolute error ||r||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_CONV_REL </B></TD><TD> - error relative to the eigenvalue l, ||r||/|l|
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_CONV_NORM </B></TD><TD> - error relative matrix norms, ||r||/sum_i(|f_i(l)|*||A_i||)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>NEP_CONV_USER </B></TD><TD> - function set by <A HREF="../NEP/NEPSetConvergenceTestFunction.html#NEPSetConvergenceTestFunction">NEPSetConvergenceTestFunction</A>()
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../NEP/NEPGetConvergenceTest.html#NEPGetConvergenceTest">NEPGetConvergenceTest</A>(), <A HREF="../NEP/NEPSetConvergenceTestFunction.html#NEPSetConvergenceTestFunction">NEPSetConvergenceTestFunction</A>(), <A HREF="../NEP/NEPSetStoppingTest.html#NEPSetStoppingTest">NEPSetStoppingTest</A>(), <A HREF="../NEP/NEPConv.html#NEPConv">NEPConv</A>
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/nep/interface/nepopts.c.html#NEPSetConvergenceTest">src/nep/interface/nepopts.c</A>
<BR><A HREF="./index.html">Index of all NEP 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>
|
