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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMFOREST/DMForestGetAdaptivityPurpose.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMForestGetAdaptivityPurpose</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/DMFOREST/DMForestGetAdaptivityPurpose.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMForestGetAdaptivityPurpose"><H1>DMForestGetAdaptivityPurpose</H1></A>
Get whether the current <A HREF="../DM/DM.html#DM">DM</A> is being adapted from its source (set with <A HREF="../DMFOREST/DMForestSetAdaptivityForest.html#DMForestSetAdaptivityForest">DMForestSetAdaptivityForest</A>()) for the purpose of refinement (<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_REFINE</A>), coarsening (<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_COARSEN</A>), or undefined (<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_DETERMINE</A>). This only matters for the purposes of reference counting: during <A HREF="../DM/DMDestroy.html#DMDestroy">DMDestroy</A>(), cyclic references can be found between DMs only if the cyclic reference is due to a fine/coarse relationship (see <A HREF="../DM/DMSetFineDM.html#DMSetFineDM">DMSetFineDM</A>()/<A HREF="../DM/DMSetCoarseDM.html#DMSetCoarseDM">DMSetCoarseDM</A>()). If the purpose is not refinement or coarsening, and the user does not maintain a reference to the post-adaptation forest (i.e., the one created by <A HREF="../DMFOREST/DMForestTemplate.html#DMForestTemplate">DMForestTemplate</A>()), then this can cause a memory leak. This method is used by subtypes of DMForest when automatically constructing mesh hierarchies.
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmforest.h"
#include "petscdm.h"
#include "petscdmlabel.h"
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMFOREST/DMForestGetAdaptivityPurpose.html#DMForestGetAdaptivityPurpose">DMForestGetAdaptivityPurpose</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DMAdaptFlag</A> *purpose)
</PRE>
Not collective
<P>
<H3><FONT COLOR="#CC3333">Input Parameter</FONT></H3>
<DT><B>dm </B> -the forest
<br>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>purpose </B> -the adaptivity purpose (<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_DETERMINE</A>/<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_REFINE</A>/<A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_COARSEN</A>)
<br>
<P>
<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMFOREST/DMForestTemplate.html#DMForestTemplate">DMForestTemplate</A>(), <A HREF="../DMFOREST/DMForestSetAdaptivityForest.html#DMForestSetAdaptivityForest">DMForestSetAdaptivityForest</A>(), <A HREF="../DMFOREST/DMForestGetAdaptivityForest.html#DMForestGetAdaptivityForest">DMForestGetAdaptivityForest</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/impls/forest/forest.c.html#DMForestGetAdaptivityPurpose">src/dm/impls/forest/forest.c</A>
<BR><A HREF="./index.html">Index of all DMFOREST 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>
|
