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
61
62
63
64
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current//Users/jroman/tmp/slepc-3.23.1/docs/manualpages/EPS/EPSStoppingThreshold.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>EPSStoppingThreshold</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>slepc-3.23.1 2025-05-01</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.23.1 v3.23.1 /Users/jroman/tmp/slepc-3.23.1/docs/manualpages/EPS/EPSStoppingThreshold.html "><small>Report Typos and Errors</small></a></div>
<H1>EPSStoppingThreshold</H1>
Routine to determine whether the outer eigenvalue solver iteration must be stopped, according to some threshold for the computed values.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepceps.h"
<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../EPS/EPSStoppingThreshold.html#EPSStoppingThreshold">EPSStoppingThreshold</A>(<A HREF="../EPS/EPS.html#EPS">EPS</A> eps,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> its,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> max_it,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> nconv,<A HREF="https://petsc.org/release/manualpages/Sys/PetscInt.html#PetscInt">PetscInt</A> nev,<A HREF="../EPS/EPSConvergedReason.html#EPSConvergedReason">EPSConvergedReason</A> *reason,void *ctx)
</PRE>
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>eps </B></TD><TD> - eigenvalue solver context obtained from <A HREF="../EPS/EPSCreate.html#EPSCreate">EPSCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>its </B></TD><TD> - current number of iterations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>max_it </B></TD><TD> - maximum number of iterations
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nconv </B></TD><TD> - number of currently converged eigenpairs (ignored here)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nev </B></TD><TD> - number of requested eigenpairs (ignored here)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - context containing additional data (<A HREF="../EPS/EPSStoppingCtx.html#EPSStoppingCtx">EPSStoppingCtx</A>)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Output Parameter</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD> - result of the stopping test
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
A positive value of reason indicates that the iteration has finished successfully
(converged), and a negative value indicates an error condition (diverged). If
the iteration needs to be continued, reason must be set to <A HREF="../EPS/EPSConvergedReason.html#EPSConvergedReason">EPS_CONVERGED_ITERATING</A>
(zero).
<P>
<A HREF="../EPS/EPSStoppingThreshold.html#EPSStoppingThreshold">EPSStoppingThreshold</A>() will stop when one of the computed eigenvalues is not
above/below the threshold given at <A HREF="../EPS/EPSSetThreshold.html#EPSSetThreshold">EPSSetThreshold</A>(). If a number of wanted
eigenvalues has been specified via <A HREF="../EPS/EPSSetDimensions.html#EPSSetDimensions">EPSSetDimensions</A>() then it is also taken into
account, and the solver will stop when one of the two conditions (threshold or
number of converged values) is met.
<P>
Use <A HREF="../EPS/EPSSetStoppingTest.html#EPSSetStoppingTest">EPSSetStoppingTest</A>() to provide your own test instead of using this one.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../EPS/EPSSetStoppingTest.html#EPSSetStoppingTest">EPSSetStoppingTest</A>(), <A HREF="../EPS/EPSStoppingBasic.html#EPSStoppingBasic">EPSStoppingBasic</A>(), <A HREF="../EPS/EPSSetThreshold.html#EPSSetThreshold">EPSSetThreshold</A>(), <A HREF="../EPS/EPSSetDimensions.html#EPSSetDimensions">EPSSetDimensions</A>(), <A HREF="../EPS/EPSConvergedReason.html#EPSConvergedReason">EPSConvergedReason</A>, <A HREF="../EPS/EPSGetConvergedReason.html#EPSGetConvergedReason">EPSGetConvergedReason</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../src/eps/interface/epsdefault.c.html#EPSStoppingThreshold">src/eps/interface/epsdefault.c</A>
<BR><BR><A HREF="./index.html">Index of all EPS 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>
|
