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>
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<link rel="stylesheet" href="/slepc/slepc.css" type="text/css">
<TITLE>NEPSetConvergenceTest</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1>NEPSetConvergenceTest</H1>
Sets the function to be used to test convergence of the nonlinear iterative solution.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcnep.h"
PetscErrorCode NEPSetConvergenceTest(NEP nep,PetscErrorCode (*func)(NEP,PetscInt,PetscReal,PetscReal,PetscReal,NEPConvergedReason*,void*),void* ctx,PetscErrorCode (*destroy)(void*))
</PRE>
Logically Collective on <A HREF="../NEP/NEP.html#NEP">NEP</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>nep </B></TD><TD> - the <A HREF="../NEP/NEP.html#NEP">NEP</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD> - a pointer to the convergence test function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD> - [optional] context for private data for the convergence routine
(may be NULL)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>destroy </B></TD><TD> - [optional] destructor for the context (may be NULL;
PETSC_NULL_FUNCTION in Fortran)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Calling Sequence of func</FONT></H3>
<pre>
func(<A HREF="../NEP/NEP.html#NEP">NEP</A> nep,PetscInt it,PetscReal xnorm,PetscReal snorm,PetscReal fnorm,<A HREF="../NEP/NEPConvergedReason.html#NEPConvergedReason">NEPConvergedReason</A> reason*,void *fctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>nep </B></TD><TD> - the <A HREF="../NEP/NEP.html#NEP">NEP</A> context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>it </B></TD><TD> - iteration number
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>xnorm </B></TD><TD> - norm of the current solution
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>snorm </B></TD><TD> - norm of the step (difference between two consecutive solutions)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fnorm </B></TD><TD> - norm of the function (residual)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>reason </B></TD><TD> - (output) result of the convergence test
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fctx </B></TD><TD> - optional context, as set by <A HREF="../NEP/NEPSetConvergenceTest.html#NEPSetConvergenceTest">NEPSetConvergenceTest</A>()
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../NEP/NEPSetTolerances.html#NEPSetTolerances">NEPSetTolerances</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/nep/interface/nepopts.c.html#NEPSetConvergenceTest">src/nep/interface/nepopts.c</A>
<BR><A HREF="./index.html">Index of all NEP 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>
</BODY></HTML>
|
