File: DMPlexGetTree.html

package info (click to toggle)
petsc 3.14.5%2Bdfsg1-4
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 266,472 kB
  • sloc: ansic: 680,898; python: 33,303; cpp: 16,324; makefile: 14,022; f90: 13,731; javascript: 10,713; fortran: 9,581; sh: 1,373; xml: 619; objc: 445; csh: 192; pascal: 148; java: 13
file content (47 lines) | stat: -rw-r--r-- 3,550 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
40
41
42
43
44
45
46
47
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
<HTML>
<HEAD> <link rel="canonical" href="http://www.mcs.anl.gov/petsc/petsc-current/docs/manualpages/DMPLEX/DMPlexGetTree.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMPlexGetTree</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/DMPLEX/DMPlexGetTree.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMPlexGetTree"><H1>DMPlexGetTree</H1></A>
get the tree that describes the hierarchy of non-conforming mesh points. Collective on dm 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmplex.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMPLEX/DMPlexGetTree.html#DMPlexGetTree">DMPlexGetTree</A>(<A HREF="../DM/DM.html#DM">DM</A> dm, <A HREF="../PetscSection/PetscSection.html#PetscSection">PetscSection</A> *parentSection, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *parents[], <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *childIDs[], <A HREF="../PetscSection/PetscSection.html#PetscSection">PetscSection</A> *childSection, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> *children[])
</PRE>
<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>dm </B></TD><TD>- the DMPlex object
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameters</FONT></H3>
<TABLE border="0" cellpadding="0" cellspacing="0">
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>parentSection </B></TD><TD>- a section describing the tree: a point has a parent if it has 1 dof in the section; the section
offset indexes the parent and childID list
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>parents </B></TD><TD>- a list of the point parents
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>childIDs </B></TD><TD>- identifies the relationship of the child point to the parent point; if there is a reference tree, then
the child corresponds to the point in the reference tree with index childID
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>childSection </B></TD><TD>- the inverse of the parent section
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>children </B></TD><TD>- a list of the point children
</TD></TR></TABLE>
<P>

<P>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DMPLEX/DMPlexSetTree.html#DMPlexSetTree">DMPlexSetTree</A>(), <A HREF="../DMPLEX/DMPlexSetReferenceTree.html#DMPlexSetReferenceTree">DMPlexSetReferenceTree</A>(), <A HREF="../DMPLEX/DMPlexSetAnchors.html#DMPlexSetAnchors">DMPlexSetAnchors</A>(), <A HREF="../DMPLEX/DMPlexGetTreeParent.html#DMPlexGetTreeParent">DMPlexGetTreeParent</A>(), <A HREF="../DMPLEX/DMPlexGetTreeChildren.html#DMPlexGetTreeChildren">DMPlexGetTreeChildren</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/plex/plextree.c.html#DMPlexGetTree">src/dm/impls/plex/plextree.c</A>
<BR><A HREF="./index.html">Index of all DMPLEX 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>