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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="https://slepc.upv.es/documentation/current/docs/manualpages/PEP/PEPConvergenceTestFn.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc.css" type="text/css">
<TITLE>PEPConvergenceTestFn</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/PEPConvergenceTestFn.html "><small>Report Typos and Errors</small></a></div>
<H1>PEPConvergenceTestFn</H1>
A prototype of a <A HREF="../PEP/PEP.html#PEP">PEP</A> convergence test function that would be passed to <A HREF="../PEP/PEPSetConvergenceTestFunction.html#PEPSetConvergenceTestFunction">PEPSetConvergenceTestFunction</A>()
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
PETSC_EXTERN_TYPEDEF typedef <A HREF="https://petsc.org/release/manualpages/Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A>(<A HREF="../PEP/PEPConvergenceTestFn.html#PEPConvergenceTestFn">PEPConvergenceTestFn</A>)(<A HREF="../PEP/PEP.html#PEP">PEP</A> pep,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> eigr,<A HREF="https://petsc.org/release/manualpages/Sys/PetscScalar.html#PetscScalar">PetscScalar</A> eigi,<A HREF="https://petsc.org/release/manualpages/Sys/PetscReal.html#PetscReal">PetscReal</A> res,<A HREF="https://petsc.org/release/manualpages/Sys/PetscReal.html#PetscReal">PetscReal</A> *errest,void *ctx);
</PRE>
<H3><FONT COLOR="#883300">Calling Sequence</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>eigr </B></TD><TD> - real part of the eigenvalue
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>eigi </B></TD><TD> - imaginary part of the eigenvalue
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>res </B></TD><TD> - residual norm associated to the eigenpair
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>errest </B></TD><TD> - [output] computed error estimate
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - [optional] user-defined context for private data for the
convergence test routine (may be NULL)
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../PEP/PEPSetConvergenceTestFunction.html#PEPSetConvergenceTestFunction">PEPSetConvergenceTestFunction</A>()
<BR><P><B></B><H3><FONT COLOR="#883300">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#883300">Location</FONT></H3>
</B><A HREF="../../../include/slepcpep.h.html#PEPConvergenceTestFn">include/slepcpep.h</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>
|
