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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DM/DMSubDomainHookAdd.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMSubDomainHookAdd</TITLE>
</HEAD>
<BODY BGCOLOR="FFFFFF">
<div id="version" align=right><b>petsc-3.7.5 2017-01-01</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.7.5 v3.7.5 docs/manualpages/DM/DMSubDomainHookAdd.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMSubDomainHookAdd"><H1>DMSubDomainHookAdd</H1></A>
adds a callback to be run when restricting a problem to the coarse grid
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdm.h"
#include "petscdmlabel.h"
PetscErrorCode DMSubDomainHookAdd(DM global,PetscErrorCode (*ddhook)(DM,DM,void*),PetscErrorCode (*restricthook)(DM,VecScatter,VecScatter,DM,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>global </B></TD><TD>- global <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ddhook </B></TD><TD>- function to run to pass data to the decomposition <A HREF="../DM/DM.html#DM">DM</A> upon its creation
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>restricthook </B></TD><TD>- function to run to update data on block solve (at the beginning of the block solve)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- [optional] user-defined context for provide data for the hooks (may be NULL)
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence for ddhook</FONT></H3>
<pre>
ddhook(<A HREF="../DM/DM.html#DM">DM</A> global,<A HREF="../DM/DM.html#DM">DM</A> block,void *ctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>global </B></TD><TD>- global <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>block </B></TD><TD>- block <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- optional user-defined function context
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Calling sequence for restricthook</FONT></H3>
<pre>
restricthook(<A HREF="../DM/DM.html#DM">DM</A> global,<A HREF="../Vec/VecScatter.html#VecScatter">VecScatter</A> out,<A HREF="../Vec/VecScatter.html#VecScatter">VecScatter</A> in,<A HREF="../DM/DM.html#DM">DM</A> block,void *ctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>global </B></TD><TD>- global <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>out </B></TD><TD>- scatter to the outer (with ghost and overlap points) block vector
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>in </B></TD><TD>- scatter to block vector values only owned locally
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>block </B></TD><TD>- block <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>ctx </B></TD><TD>- optional user-defined function context
</TD></TR></TABLE>
<P>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
This function is only needed if auxiliary data needs to be set up on subdomain DMs.
<P>
If this function is called multiple times, the hooks will be run in the order they are added.
<P>
In order to compose with nonlinear preconditioning without duplicating storage, the hook should be implemented to
extract the global information from its context (instead of from the <A HREF="../SNES/SNES.html#SNES">SNES</A>).
<P>
This function is currently not available from Fortran.
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DM/DMRefineHookAdd.html#DMRefineHookAdd">DMRefineHookAdd</A>(), <A HREF="../SNES/SNESFASGetInterpolation.html#SNESFASGetInterpolation">SNESFASGetInterpolation</A>(), <A HREF="../SNES/SNESFASGetInjection.html#SNESFASGetInjection">SNESFASGetInjection</A>(), <A HREF="../Sys/PetscObjectCompose.html#PetscObjectCompose">PetscObjectCompose</A>(), <A HREF="../Sys/PetscContainerCreate.html#PetscContainerCreate">PetscContainerCreate</A>()
<BR><P><B><P><B><FONT COLOR="#CC3333">Level:</FONT></B>advanced
<BR><FONT COLOR="#CC3333">Location:</FONT></B><A HREF="../../../src/dm/interface/dm.c.html#DMSubDomainHookAdd">src/dm/interface/dm.c</A>
<BR><A HREF="./index.html">Index of all DM 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>
|
