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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPSetStoppingTestFunction.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPSetStoppingTestFunction</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/PEPSetStoppingTestFunction.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPSetStoppingTestFunction</H1>
Sets a function to decide when to stop the outer iteration of the eigensolver.
<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/PEPSetStoppingTestFunction.html#PEPSetStoppingTestFunction">PEPSetStoppingTestFunction</A>(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="../PEP/PEPStoppingTestFn.html#PEPStoppingTestFn">PEPStoppingTestFn</A> *stop,void* ctx,<A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*destroy)(void*))
</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>stop </B></TD><TD> - stopping test function, see <A HREF="../PEP/PEPStoppingTestFn.html#PEPStoppingTestFn">PEPStoppingTestFn</A> for the calling sequence
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - context for private data for the stopping routine (may be NULL)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>destroy </B></TD><TD> - a routine for destroying the context (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
Normal usage is to first call the default routine <A HREF="../PEP/PEPStoppingBasic.html#PEPStoppingBasic">PEPStoppingBasic</A>() and then
set reason to <A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_CONVERGED_USER</A> if some user-defined conditions have been
met. To let the eigensolver continue iterating, the result must be left as
<A HREF="../PEP/PEPConvergedReason.html#PEPConvergedReason">PEP_CONVERGED_ITERATING</A>.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPSetStoppingTest.html#PEPSetStoppingTest">PEPSetStoppingTest</A>(), <A HREF="../PEP/PEPStoppingBasic.html#PEPStoppingBasic">PEPStoppingBasic</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/pepopts.c.html#PEPSetStoppingTestFunction">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>
|
