File: DMPlexCreateBoxMesh.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 (153 lines) | stat: -rw-r--r-- 7,021 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
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
<!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/DMPlexCreateBoxMesh.html" />
<META NAME="GENERATOR" CONTENT="DOCTEXT">
<TITLE>DMPlexCreateBoxMesh</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/DMPLEX/DMPlexCreateBoxMesh.html "><small>Report Typos and Errors</small></a></div>
<A NAME="DMPlexCreateBoxMesh"><H1>DMPlexCreateBoxMesh</H1></A>
Creates a mesh on the tensor product of unit intervals (box) using simplices or tensor cells (hexahedra). 
<H3><FONT COLOR="#CC3333">Synopsis</FONT></H3>
<PRE>
#include "petscdmplex.h"   
#include "petscdmplex.h"   
<A HREF="../Sys/PetscErrorCode.html#PetscErrorCode">PetscErrorCode</A> <A HREF="../DMPLEX/DMPlexCreateBoxMesh.html#DMPlexCreateBoxMesh">DMPlexCreateBoxMesh</A>(<A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</A> comm, <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> dim, <A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> simplex, const <A HREF="../Sys/PetscInt.html#PetscInt">PetscInt</A> faces[], const <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> lower[], const <A HREF="../Sys/PetscReal.html#PetscReal">PetscReal</A> upper[], const <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DMBoundaryType</A> periodicity[], <A HREF="../Sys/PetscBool.html#PetscBool">PetscBool</A> interpolate, <A HREF="../DM/DM.html#DM">DM</A> *dm)
</PRE>
Collective on <A HREF="../Sys/MPI_Comm.html#MPI_Comm">MPI_Comm</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>comm        </B></TD><TD>- The communicator for the <A HREF="../DM/DM.html#DM">DM</A> object
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>dim         </B></TD><TD>- The spatial dimension
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>simplex     </B></TD><TD>- <A HREF="../Sys/PETSC_TRUE.html#PETSC_TRUE">PETSC_TRUE</A> for simplices, <A HREF="../Sys/PETSC_FALSE.html#PETSC_FALSE">PETSC_FALSE</A> for tensor cells
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>faces       </B></TD><TD>- Number of faces per dimension, or NULL for (1,) in 1D and (2, 2) in 2D and (1, 1, 1) in 3D
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>lower       </B></TD><TD>- The lower left corner, or NULL for (0, 0, 0)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>upper       </B></TD><TD>- The upper right corner, or NULL for (1, 1, 1)
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>periodicity </B></TD><TD>- The boundary type for the X,Y,Z direction, or NULL for <A HREF="../DM/DMBoundaryType.html#DMBoundaryType">DM_BOUNDARY_NONE</A>
</TD></TR>
<TR><TD WIDTH=40></TD><TD ALIGN=LEFT VALIGN=TOP><B>interpolate </B></TD><TD>- Flag to create intermediate mesh pieces (edges, faces)
</TD></TR></TABLE>
<P>
<H3><FONT COLOR="#CC3333">Output Parameter</FONT></H3>
<DT><B>dm  </B> -The <A HREF="../DM/DM.html#DM">DM</A> object
<br>
<P>
<H3><FONT COLOR="#CC3333">Note: Here is the numbering returned for 2 faces in each direction for tensor cells</FONT></H3>
<pre>
10---17---11---18----12
</pre>
<pre>
 |         |         |
</pre>
<pre>
 |         |         |
</pre>
<pre>
20    2   22    3    24
</pre>
<pre>
 |         |         |
</pre>
<pre>
 |         |         |
</pre>
<pre>
 7---15----8---16----9
</pre>
<pre>
 |         |         |
</pre>
<pre>
 |         |         |
</pre>
<pre>
19    0   21    1   23
</pre>
<pre>
 |         |         |
</pre>
<pre>
 |         |         |
</pre>
<pre>
 4---13----5---14----6
</pre>
<P>
and for simplicial cells
<P>
<pre>
14----8---15----9----16
</pre>
<pre>
 |\     5  |\      7 |
</pre>
<pre>
 | \       | \       |
</pre>
<pre>
13   2    14    3    15
</pre>
<pre>
 | 4   \   | 6   \   |
</pre>
<pre>
 |       \ |       \ |
</pre>
<pre>
11----6---12----7----13
</pre>
<pre>
 |\        |\        |
</pre>
<pre>
 | \    1  | \     3 |
</pre>
<pre>
10   0    11    1    12
</pre>
<pre>
 | 0   \   | 2   \   |
</pre>
<pre>
 |       \ |       \ |
</pre>
<pre>
 8----4----9----5----10
</pre>
<P>

<P>
<H3><FONT COLOR="#CC3333">Keywords</FONT></H3>
 <A HREF="../DM/DM.html#DM">DM</A>, create
<BR>
<H3><FONT COLOR="#CC3333">See Also</FONT></H3>
 <A HREF="../DMPLEX/DMPlexCreateFromFile.html#DMPlexCreateFromFile">DMPlexCreateFromFile</A>(), <A HREF="../DMPLEX/DMPlexCreateHexCylinderMesh.html#DMPlexCreateHexCylinderMesh">DMPlexCreateHexCylinderMesh</A>(), <A HREF="../DM/DMSetType.html#DMSetType">DMSetType</A>(), <A HREF="../DM/DMCreate.html#DMCreate">DMCreate</A>()
<BR><P><B></B><H3><FONT COLOR="#CC3333">Level</FONT></H3>beginner<BR>
<H3><FONT COLOR="#CC3333">Location</FONT></H3>
</B><A HREF="../../../src/dm/impls/plex/plexcreate.c.html#DMPlexCreateBoxMesh">src/dm/impls/plex/plexcreate.c</A>
<P><H3><FONT COLOR="#CC3333">Examples</FONT></H3>
<A HREF="../../../src/dm/impls/plex/examples/tutorials/ex1.c.html">src/dm/impls/plex/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/dm/impls/plex/examples/tutorials/ex2.c.html">src/dm/impls/plex/examples/tutorials/ex2.c.html</A><BR>
<A HREF="../../../src/dm/impls/plex/examples/tutorials/ex1f90.F90.html">src/dm/impls/plex/examples/tutorials/ex1f90.F90.html</A><BR>
<A HREF="../../../src/dm/examples/tutorials/ex20.c.html">src/dm/examples/tutorials/ex20.c.html</A><BR>
<A HREF="../../../src/dm/field/examples/tutorials/ex1.c.html">src/dm/field/examples/tutorials/ex1.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex12.c.html">src/snes/examples/tutorials/ex12.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex56.c.html">src/snes/examples/tutorials/ex56.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex62.c.html">src/snes/examples/tutorials/ex62.c.html</A><BR>
<A HREF="../../../src/snes/examples/tutorials/ex77.c.html">src/snes/examples/tutorials/ex77.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex11.c.html">src/ts/examples/tutorials/ex11.c.html</A><BR>
<A HREF="../../../src/ts/examples/tutorials/ex48.c.html">src/ts/examples/tutorials/ex48.c.html</A><BR>
<P><H3><FONT COLOR="CC3333">Implementations</FONT></H3><A HREF="../../../src/dm/impls/plex/plexcreate.c.html#DMPlexCreateBoxMesh_Simplex_Internal">DMPlexCreateBoxMesh_Simplex_Internal in src/dm/impls/plex/plexcreate.c</A><BR>
<A HREF="../../../src/dm/impls/plex/plexcreate.c.html#DMPlexCreateBoxMesh_Tensor_Internal">DMPlexCreateBoxMesh_Tensor_Internal in src/dm/impls/plex/plexcreate.c</A><BR>
<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>