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
58
59
60
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPSetConvergenceTest.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPSetConvergenceTest</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.22.2 2024-12-02</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.22.2 v3.22.2 docs/manualpages/PEP/PEPSetConvergenceTest.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPSetConvergenceTest</H1>
Specifies how to compute the error estimate used in the convergence test.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcpep.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../PEP/PEPSetConvergenceTest.html#PEPSetConvergenceTest">PEPSetConvergenceTest</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="../PEP/PEPConv.html#PEPConv">PEPConv</A> conv)
</PRE>
Logically Collective
<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>pep </B></TD><TD> - eigensolver context obtained from <A HREF="../PEP/PEPCreate.html#PEPCreate">PEPCreate</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>-pep_conv_abs </B></TD><TD> - Sets the absolute convergence test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_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>-pep_conv_norm </B></TD><TD> - Sets the convergence test relative to the matrix norms
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-pep_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><A HREF="../PEP/PEPConv.html#PEPConv">PEP_CONV_ABS</A> </B></TD><TD> - absolute error ||r||
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConv.html#PEPConv">PEP_CONV_REL</A> </B></TD><TD> - error relative to the eigenvalue l, ||r||/|l|
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConv.html#PEPConv">PEP_CONV_NORM</A> </B></TD><TD> - error relative matrix norms, ||r||/sum_i(l^i*||A_i||)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B><A HREF="../PEP/PEPConv.html#PEPConv">PEP_CONV_USER</A> </B></TD><TD> - function set by <A HREF="../PEP/PEPSetConvergenceTestFunction.html#PEPSetConvergenceTestFunction">PEPSetConvergenceTestFunction</A>()
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPGetConvergenceTest.html#PEPGetConvergenceTest">PEPGetConvergenceTest</A>(), <A HREF="../PEP/PEPSetConvergenceTestFunction.html#PEPSetConvergenceTestFunction">PEPSetConvergenceTestFunction</A>(), <A HREF="../PEP/PEPSetStoppingTest.html#PEPSetStoppingTest">PEPSetStoppingTest</A>(), <A HREF="../PEP/PEPConv.html#PEPConv">PEPConv</A>
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/pep/interface/pepopts.c.html#PEPSetConvergenceTest">src/pep/interface/pepopts.c</A>
<BR><BR><A HREF="./index.html">Index of all PEP routines</A>
<BR><A HREF="../../../docs/manual.html">Table of Contents for all manual pages</A>
<BR><A HREF="../singleindex.html">Index of all manual pages</A>
</BODY></HTML>
|
