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
82
83
84
85
86
|
<!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/DMCoarsenHookAdd.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMCoarsenHookAdd</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/DM/DMCoarsenHookAdd.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMCoarsenHookAdd"><H1>DMCoarsenHookAdd</H1></A>
adds a callback to be run when restricting a nonlinear problem to the coarse grid
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdm.h"
#include "petscdmlabel.h"
#include "petscds.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DM/DMCoarsenHookAdd.html#DMCoarsenHookAdd">DMCoarsenHookAdd</A>(<A HREF="../DM/DM.html#DM">DM</A> fine,<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*coarsenhook)(<A HREF="../DM/DM.html#DM">DM</A>,<A HREF="../DM/DM.html#DM">DM</A>,void*),<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*restricthook)(<A HREF="../DM/DM.html#DM">DM</A>,<A HREF="../Mat/Mat.html#Mat">Mat</A>,<A HREF="../Vec/Vec.html#Vec">Vec</A>,<A HREF="../Mat/Mat.html#Mat">Mat</A>,<A HREF="../DM/DM.html#DM">DM</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>fine </B></TD><TD>- nonlinear solver context on which to run a hook when restricting to a coarser level
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coarsenhook </B></TD><TD>- function to run when setting up a coarser level
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>restricthook </B></TD><TD>- function to run to update data on coarser levels (once per <A HREF="../SNES/SNESSolve.html#SNESSolve">SNESSolve</A>())
</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>
<H3><FONT COLOR="#CC3333">Calling sequence of coarsenhook</FONT></H3>
<pre>
coarsenhook(<A HREF="../DM/DM.html#DM">DM</A> fine,<A HREF="../DM/DM.html#DM">DM</A> coarse,void *ctx);
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fine </B></TD><TD>- fine level <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coarse </B></TD><TD>- coarse level <A HREF="../DM/DM.html#DM">DM</A> to restrict problem to
</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> fine,<A HREF="../Mat/Mat.html#Mat">Mat</A> mrestrict,<A HREF="../Vec/Vec.html#Vec">Vec</A> rscale,<A HREF="../Mat/Mat.html#Mat">Mat</A> inject,<A HREF="../DM/DM.html#DM">DM</A> coarse,void *ctx)
</pre>
<P>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>fine </B></TD><TD>- fine level <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mrestrict </B></TD><TD>- matrix restricting a fine-level solution to the coarse grid
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>rscale </B></TD><TD>- scaling vector for restriction
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>inject </B></TD><TD>- matrix restricting by injection
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>coarse </B></TD><TD>- coarse level <A HREF="../DM/DM.html#DM">DM</A> to update
</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 coarse grids.
<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 finest level 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/DMCoarsenHookRemove.html#DMCoarsenHookRemove">DMCoarsenHookRemove</A>(), <A HREF="../DM/DMRefineHookAdd.html#DMRefineHookAdd">DMRefineHookAdd</A>(), <A HREF="../SNESFAS/SNESFASGetInterpolation.html#SNESFASGetInterpolation">SNESFASGetInterpolation</A>(), <A HREF="../SNESFAS/SNESFASGetInjection.html#SNESFASGetInjection">SNESFASGetInjection</A>(), <A HREF="../Sys/PetscObjectCompose.html#PetscObjectCompose">PetscObjectCompose</A>(), <A HREF="../Sys/PetscContainerCreate.html#PetscContainerCreate">PetscContainerCreate</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/dm/interface/dm.c.html#DMCoarsenHookAdd">src/dm/interface/dm.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/snes/tutorials/ex48.c.html">src/snes/tutorials/ex48.c.html</A><BR>
<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>
|
