File: DMForestGetAdaptivityLabel.html

package info (click to toggle)
petsc 3.10.3%2Bdfsg1-5
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 209,064 kB
  • sloc: ansic: 587,333; python: 29,696; makefile: 12,445; fortran: 11,626; f90: 9,677; cpp: 8,768; sh: 1,027; xml: 621; objc: 445; csh: 194; java: 13
file content (39 lines) | stat: -rw-r--r-- 2,715 bytes parent folder | download
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/DMForestGetAdaptivityLabel.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMForestGetAdaptivityLabel</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/DMForestGetAdaptivityLabel.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMForestGetAdaptivityLabel"><H1>DMForestGetAdaptivityLabel</H1></A>
Get the label of the pre-adaptation forest (see <A HREF="../DMFOREST/DMForestGetAdaptivityForest.html#DMForestGetAdaptivityForest">DMForestGetAdaptivityForest</A>()) that holds the adaptation flags (refinement, coarsening, or some combination).  The interpretation of the label values is up to the subtype of DMForest, but <A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_DETERMINE</A>, <A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_KEEP</A>, <A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_REFINE</A>, and <A HREF="../DM/DMAdaptFlag.html#DMAdaptFlag">DM_ADAPT_COARSEN</A> have been reserved as choices that should be accepted by all subtypes. 
<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/DMForestGetAdaptivityLabel.html#DMForestGetAdaptivityLabel">DMForestGetAdaptivityLabel</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../DM/DMLabel.html#DMLabel">DMLabel</A> *adaptLabel)
</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>adaptLabel </B> -the name of the label in the pre-adaptation forest
<br>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
<A HREF="../DMFOREST/DMForestSetAdaptivityLabel.html#DMForestSetAdaptivityLabel">DMForestSetAdaptivityLabel</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/impls/forest/forest.c.html#DMForestGetAdaptivityLabel">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>