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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPStoppingBasic.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPStoppingBasic</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/PEPStoppingBasic.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPStoppingBasic</H1>
Default routine to determine whether the outer eigensolver iteration must be stopped.
<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/PEPStoppingBasic.html#PEPStoppingBasic">PEPStoppingBasic</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<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="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEPConvergedReason</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>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>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
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nev </B></TD><TD> - number of requested eigenpairs
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - context (not used here)
</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="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_CONVERGED_ITERATING</A>
(zero).
<P>
<A HREF="../PEP/PEPStoppingBasic.html#PEPStoppingBasic">PEPStoppingBasic</A>() will stop if all requested eigenvalues are converged, or if
the maximum number of iterations has been reached.
<P>
Use <A HREF="../PEP/PEPSetStoppingTest.html#PEPSetStoppingTest">PEPSetStoppingTest</A>() to provide your own test instead of using this one.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPSetStoppingTest.html#PEPSetStoppingTest">PEPSetStoppingTest</A>(), <A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEPConvergedReason</A>, <A HREF="../PEP/PEPGetConvergedReason.html#PEPGetConvergedReason">PEPGetConvergedReason</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/pep/interface/pepdefault.c.html#PEPStoppingBasic">src/pep/interface/pepdefault.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>
|
