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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/SNESDefaultMatrixFreeSetParameters2.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>SNESDefaultMatrixFreeSetParameters2</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.10.3 2018-12-18</b></div>
<div id="bugreport" align=right><a href="mailto:petsc-maint@mcs.anl.gov?subject=Typo or Error in Documentation &body=Please describe the typo or error in the documentation: petsc-3.10.3 v3.10.3 docs/manualpages/SNES/SNESDefaultMatrixFreeSetParameters2.html "><small>Report Typos and Errors</small></a></div>
<A NAME="SNESDefaultMatrixFreeSetParameters2"><H1>SNESDefaultMatrixFreeSetParameters2</H1></A>
Sets the parameters for the approximation of matrix-vector products using finite differences.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/SNESDefaultMatrixFreeSetParameters2.html#SNESDefaultMatrixFreeSetParameters2">SNESDefaultMatrixFreeSetParameters2</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> mat,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> error,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> umin,<A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> h)
</PRE>
<pre>
J(u)*a = [J(u+h*a) - J(u)]/h where
</pre>
<P>
either the user sets h directly here, or this parameter is computed via
<P>
<pre>
h = error_rel*u'a/||a||^2 if |u'a| > umin*||a||_{1}
</pre>
<pre>
= error_rel*umin*sign(u'a)*||a||_{1}/||a||^2 else
</pre>
<pre>
</pre>
<P>
<H3><FONT COLOR="#CC3333">Input Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mat </B></TD><TD>- the matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>error_rel </B></TD><TD>- relative error (should be set to the square root of
the relative error in the function evaluations)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>umin </B></TD><TD>- minimum allowable u-value
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>h </B></TD><TD>- differencing parameter
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
If the user sets the parameter h directly, then this value will be used
instead of the default computation indicated above.
<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
<A HREF="../SNES/SNES.html#SNES">SNES</A>, matrix-free, parameters
<BR>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/MatCreateSNESMF.html#MatCreateSNESMF">MatCreateSNESMF</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>advanced<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/interface/noise/snesmfj2.c.html#SNESDefaultMatrixFreeSetParameters2">src/snes/interface/noise/snesmfj2.c</A>
<BR><A HREF="./index.html">Index of all SNES 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>
|
