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
|
<!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>MFNSetTolerances</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<H1>MFNSetTolerances</H1>
Sets the tolerance and maximum iteration count used by the <A HREF="../MFN/MFN.html#MFN">MFN</A> convergence tests.
<H3><FONT COLOR="#883300">Synopsis</FONT></H3>
<PRE>
#include "slepcmfn.h"
PetscErrorCode MFNSetTolerances(MFN mfn,PetscReal tol,PetscInt maxits)
</PRE>
Logically Collective on <A HREF="../MFN/MFN.html#MFN">MFN</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>mfn </B></TD><TD> - the matrix function context
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>tol </B></TD><TD> - the convergence tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>maxits </B></TD><TD> - maximum number of iterations to use
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_tol <tol> </B></TD><TD> - Sets the convergence tolerance
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-mfn_max_it <maxits> </B></TD><TD> - Sets the maximum number of iterations allowed
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#883300">Notes</FONT></H3>
Pass 0 for an argument that need not be changed.
<P>
Use PETSC_DECIDE for maxits to assign a reasonably good value, which is
dependent on the solution method.
<P>
<P>
<H3><FONT COLOR="#883300">See Also</FONT></H3>
<A HREF="../MFN/MFNGetTolerances.html#MFNGetTolerances">MFNGetTolerances</A>()
<BR><P><B><FONT COLOR="#883300">Location: </FONT></B><A HREF="../../../src/mfn/interface/mfnopts.c.html#MFNSetTolerances">src/mfn/interface/mfnopts.c</A>
<BR><A HREF="./index.html">Index of all MFN 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/mfn/examples/tutorials/ex23.c.html">src/mfn/examples/tutorials/ex23.c.html</A><BR>
</BODY></HTML>
|
