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> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/SNES/DMDASNESSetPicardLocal.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMDASNESSetPicardLocal</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/DMDASNESSetPicardLocal.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMDASNESSetPicardLocal"><H1>DMDASNESSetPicardLocal</H1></A>
set a local right hand side and matrix evaluation function for Picard iteration
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmda.h"
#include "petscsnes.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../SNES/DMDASNESSetPicardLocal.html#DMDASNESSetPicardLocal">DMDASNESSetPicardLocal</A>(<A HREF="../DM/DM.html#DM">DM</A> dm,<A HREF="../Sys/InsertMode.html#InsertMode">InsertMode</A> imode,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*func)(<A HREF="../DMDA/DMDALocalInfo.html#DMDALocalInfo">DMDALocalInfo</A>*,void*,void*,void*),
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*jac)(<A HREF="../DMDA/DMDALocalInfo.html#DMDALocalInfo">DMDALocalInfo</A>*,void*,<A HREF="../Mat/Mat.html#Mat">Mat</A>,<A HREF="../Mat/Mat.html#Mat">Mat</A>,void*),void *ctx)
</PRE>
Logically Collective
<P>
<H3><FONT COLOR="#CC3333">Input Arguments</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dm </B></TD><TD>- <A HREF="../DM/DM.html#DM">DM</A> to associate callback with
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>imode </B></TD><TD>- <A HREF="../Sys/INSERT_VALUES.html#INSERT_VALUES">INSERT_VALUES</A> if local function computes owned part, <A HREF="../Sys/ADD_VALUES.html#ADD_VALUES">ADD_VALUES</A> if it contributes to ghosted part
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>func </B></TD><TD>- local residual evaluation
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- optional context for local residual evaluation
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence for func</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>info </B></TD><TD>- <A HREF="../DMDA/DMDALocalInfo.html#DMDALocalInfo">DMDALocalInfo</A> defining the subdomain to evaluate the residual on
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>x </B></TD><TD>- dimensional pointer to state at which to evaluate residual
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- dimensional pointer to residual, write the residual here
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- optional context passed above
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
The user must use
ierr = <A HREF="../SNES/SNESSetFunction.html#SNESSetFunction">SNESSetFunction</A>(snes,NULL,SNESPicardComputeFunction,&user);<A HREF="../Sys/CHKERRQ.html#CHKERRQ">CHKERRQ</A>(ierr);
in their code before calling this routine.
<P>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../SNES/DMSNESSetFunction.html#DMSNESSetFunction">DMSNESSetFunction</A>(), DMDASNESSetJacobian(), <A HREF="../DMDA/DMDACreate1d.html#DMDACreate1d">DMDACreate1d</A>(), <A HREF="../DMDA/DMDACreate2d.html#DMDACreate2d">DMDACreate2d</A>(), <A HREF="../DMDA/DMDACreate3d.html#DMDACreate3d">DMDACreate3d</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/snes/utils/dmdasnes.c.html#DMDASNESSetPicardLocal">src/snes/utils/dmdasnes.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/examples/tutorials/ex15.c.html">src/snes/examples/tutorials/ex15.c.html</A><BR>
<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>
|
