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
|
<!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/MatSNESMFSetReuseBase.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>MatSNESMFSetReuseBase</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.14.5 2021-03-03</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.14.5 v3.14.5 docs/manualpages/SNES/MatSNESMFSetReuseBase.html "><small>Report Typos and Errors</small></a></div>
<A NAME="MatSNESMFSetReuseBase"><H1>MatSNESMFSetReuseBase</H1></A>
Causes the base vector to be used for differencing even if the function provided to <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>() is not the same as that provided to <A HREF="../Mat/MatMFFDSetFunction.html#MatMFFDSetFunction">MatMFFDSetFunction</A>().
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscsnes.h"
#include "petscdm.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/MatSNESMFSetReuseBase.html#MatSNESMFSetReuseBase">MatSNESMFSetReuseBase</A>(<A HREF="../Mat/Mat.html#Mat">Mat</A> J,<A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> use)
</PRE>
Logically Collective on <A HREF="../Mat/Mat.html#Mat">Mat</A>
<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>J </B></TD><TD>- the <A HREF="../Mat/MatMFFD.html#MatMFFD">MatMFFD</A> matrix
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>use </B></TD><TD>- if true always reuse the base vector instead of recomputing f(u) even if the function in the MatSNESMF is
not <A HREF="../SNES/SNESComputeFunction.html#SNESComputeFunction">SNESComputeFunction</A>()
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Care must be taken when using this routine to insure that the function provided to <A HREF="../Mat/MatMFFDSetFunction.html#MatMFFDSetFunction">MatMFFDSetFunction</A>(), call it F_MF() is compatible with
with that provided to <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>(), call it F_SNES(). That is, (F_MF(u + h*d) - F_SNES(u))/h has to approximate the derivative
<P>
<H3><FONT COLOR="#CC3333">Developer Notes</FONT></H3>
This was provided for the MOOSE team who desired to have a <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>() function that could change configurations due
to contacts while the function provided to <A HREF="../Mat/MatMFFDSetFunction.html#MatMFFDSetFunction">MatMFFDSetFunction</A>() cannot. Except for the possibility of changing the configuration
both functions compute the same mathematical function so the differencing makes sense.
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/MatCreateSNESMF.html#MatCreateSNESMF">MatCreateSNESMF</A>(), <A HREF="../SNES/MatSNESMFGetReuseBase.html#MatSNESMFGetReuseBase">MatSNESMFGetReuseBase</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/mf/snesmfj.c.html#MatSNESMFSetReuseBase">src/snes/mf/snesmfj.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>
|
