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
65
66
67
68
69
70
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://slepc.upv.es/documentation/current/docs/manualpages/EPS/EPSSetStoppingTestFunction.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>EPSSetStoppingTestFunction</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/EPS/EPSSetStoppingTestFunction.html "><small>Report Typos and Errors</small></a></div>
<H1>EPSSetStoppingTestFunction</H1>
Sets a function to decide when to stop the outer iteration of the eigensolver.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepceps.h"
PetscErrorCode EPSSetStoppingTestFunction(EPS eps,PetscErrorCode (*func)(EPS,PetscInt,PetscInt,PetscInt,PetscInt,EPSConvergedReason*,void*),void* ctx,PetscErrorCode (*destroy)(void*))
</PRE>
Logically Collective on <A HREF="../EPS/EPS.html#EPS">EPS</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>eps </B></TD><TD> - eigensolver context obtained from <A HREF="../EPS/EPSCreate.html#EPSCreate">EPSCreate</A>()
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD> - pointer to the stopping test function
</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">Calling Sequence of func</FONT></H3>
<pre>
func(<A HREF="../EPS/EPS.html#EPS">EPS</A> eps,PetscInt its,PetscInt max_it,PetscInt nconv,PetscInt nev,<A HREF="../EPS/EPSConvergedReason.html#EPSConvergedReason">EPSConvergedReason</A> *reason,void *ctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eps </B></TD><TD> - eigensolver 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
</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>reason </B></TD><TD> - (output) result of the stopping test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - optional context, as set by <A HREF="../EPS/EPSSetStoppingTestFunction.html#EPSSetStoppingTestFunction">EPSSetStoppingTestFunction</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Note</FONT></H3>
Normal usage is to first call the default routine <A HREF="../EPS/EPSStoppingBasic.html#EPSStoppingBasic">EPSStoppingBasic</A>() and then
set reason to EPS_CONVERGED_USER if some user-defined conditions have been
met. To let the eigensolver continue iterating, the result must be left as
EPS_CONVERGED_ITERATING.
<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>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/eps/interface/epsopts.c.html#EPSSetStoppingTestFunction">src/eps/interface/epsopts.c</A>
<BR><A HREF="./index.html">Index of all EPS 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>
<P><H3><FONT COLOR="#883300">Examples</FONT></H3>
<A HREF="../../../src/eps/examples/tutorials/ex29.c.html">src/eps/examples/tutorials/ex29.c.html</A><BR>
<A HREF="../../../src/eps/examples/tutorials/ex30.c.html">src/eps/examples/tutorials/ex30.c.html</A><BR>
</BODY></HTML>
|
