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
|
<!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/DMMonitorSet.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMMonitorSet</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/DMMonitorSet.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMMonitorSet"><H1>DMMonitorSet</H1></A>
Sets an ADDITIONAL function that is to be used after a solve to monitor discretization performance.
<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/DMMonitorSet.html#DMMonitorSet">DMMonitorSet</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*f)(<A HREF="../DM/DM.html#DM">DM</A>, void *), void *mctx, <A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> (*monitordestroy)(void**))
</PRE>
Logically Collective on <A HREF="../DM/DM.html#DM">DM</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><A HREF="../DM/DM.html#DM">DM</A> </B></TD><TD>- the <A HREF="../DM/DM.html#DM">DM</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>f </B></TD><TD>- the monitor function
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>mctx </B></TD><TD>- [optional] user-defined context for private data for the monitor routine (use NULL if no context is desired)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>monitordestroy </B></TD><TD>- [optional] routine that frees monitor context (may be NULL)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Options Database Keys</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>-dm_monitor_cancel </B></TD><TD>- cancels all monitors that have been hardwired into a code by calls to <A HREF="../DM/DMMonitorSet.html#DMMonitorSet">DMMonitorSet</A>(), but
does not cancel those set via the options database.
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Notes</FONT></H3>
Several different monitoring routines may be set by calling
<A HREF="../DM/DMMonitorSet.html#DMMonitorSet">DMMonitorSet</A>() multiple times; all will be called in the
order in which they were set.
<P>
<H3><FONT COLOR="#CC3333">Fortran Notes</FONT></H3>
Only a single monitor function can be set for each <A HREF="../DM/DM.html#DM">DM</A> object
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DM/DMMonitorCancel.html#DMMonitorCancel">DMMonitorCancel</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>intermediate<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/interface/dm.c.html#DMMonitorSet">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>
|
