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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<center><a href="https://gitlab.com/petsc/petsc/-/blob/966382dc56242773704ef5f5cee7aa2db3ebc577/include/petscdmtypes.h">Actual source code: petscdmtypes.h</a></center><br>
<html>
<head>
<title></title>
<meta name="generator" content="c2html 0.9.6">
<meta name="date" content="2025-04-30T18:14:50+00:00">
</head>
<body bgcolor="#FFFFFF">
<pre width=80>
<a name="line1"> 1: </a><font color="#A020F0">#pragma once</font>
<a name="line3"> 3: </a><font color="#B22222">/* SUBMANSEC = <a href="../manualpages/DM/DM.html">DM</a> */</font>
<a name="line5"> 5: </a><font color="#B22222">/*S</font>
<a name="line6"> 6: </a><font color="#B22222"> <a href="../manualpages/DM/DM.html">DM</a> - Abstract PETSc object that manages an abstract grid-like object and its interactions with the algebraic solvers</font>
<a name="line8"> 8: </a><font color="#B22222"> Level: intermediate</font>
<a name="line10"> 10: </a><font color="#B22222"> Note:</font>
<a name="line11"> 11: </a><font color="#B22222"> `<a href="../manualpages/DM/DM.html">DM</a>` is an orphan initialism or orphan acronym, the letters have no meaning and never did.</font>
<a name="line13"> 13: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DMType.html">DMType</a>`, `<a href="../manualpages/DM/DMGetType.html">DMGetType</a>()`, `<a href="../manualpages/DMComposite/DMCompositeCreate.html">DMCompositeCreate</a>()`, `<a href="../manualpages/DMDA/DMDACreate.html">DMDACreate</a>()`, `<a href="../manualpages/DM/DMSetType.html">DMSetType</a>()`, `<a href="../manualpages/DM/DMType.html">DMType</a>`, `<a href="../manualpages/DMDA/DMDA.html">DMDA</a>`, `<a href="../manualpages/DMPlex/DMPLEX.html">DMPLEX</a>`</font>
<a name="line14"> 14: </a><font color="#B22222">S*/</font>
<a name="line15"> 15: </a><font color="#4169E1">typedef struct _p_DM *<a href="../manualpages/DM/DM.html">DM</a>;</font>
<a name="line17"> 17: </a><font color="#B22222">/*E</font>
<a name="line18"> 18: </a><font color="#B22222"> <a href="../manualpages/DM/DMBoundaryType.html">DMBoundaryType</a> - Describes the choice for the filling of ghost cells on physical domain boundaries.</font>
<a name="line20"> 20: </a><font color="#B22222"> Values:</font>
<a name="line21"> 21: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_NONE</a>` - no ghost nodes</font>
<a name="line22"> 22: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_GHOSTED</a>` - ghost vertices/cells exist but aren't filled; you can put values into them and then apply a stencil that uses those ghost locations</font>
<a name="line23"> 23: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_MIRROR</a>` - the ghost value is the same as the value 1 grid point in; that is, the 0th grid point in the real mesh acts like a mirror to define</font>
<a name="line24"> 24: </a><font color="#B22222"> the ghost point value; not yet implemented for 3d</font>
<a name="line25"> 25: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_PERIODIC</a>` - ghost vertices/cells filled by the opposite edge of the domain</font>
<a name="line26"> 26: </a><font color="#B22222">- `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_TWIST</a>` - like periodic, only glued backwards like a Mobius strip</font>
<a name="line28"> 28: </a><font color="#B22222"> Level: beginner</font>
<a name="line30"> 30: </a><font color="#B22222"> Notes:</font>
<a name="line31"> 31: </a><font color="#B22222"> This is information for the boundary of the __PHYSICAL__ domain. It has nothing to do with boundaries between</font>
<a name="line32"> 32: </a><font color="#B22222"> processes. That width is always determined by the stencil width; see `<a href="../manualpages/DMDA/DMDASetStencilWidth.html">DMDASetStencilWidth</a>()`.</font>
<a name="line34"> 34: </a><font color="#B22222"> If the physical grid points have values 0 1 2 3 with `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_MIRROR</a>` then the local vector with ghost points has the values 1 0 1 2 3 2.</font>
<a name="line36"> 36: </a><font color="#B22222"> See <https://scicomp.stackexchange.com/questions/5355/writing-the-poisson-equation-finite-difference-matrix-with-neumann-boundary-cond></font>
<a name="line38"> 38: </a><font color="#B22222"> Developer Note:</font>
<a name="line39"> 39: </a><font color="#B22222"> Should `<a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_MIRROR</a>` have the same meaning with `<a href="../manualpages/DMDA/DMDAInterpolationType.html">DMDA_Q0</a>`, that is a staggered grid? In that case should the ghost point have the same value</font>
<a name="line40"> 40: </a><font color="#B22222"> as the 0th grid point where the physical boundary serves as the mirror?</font>
<a name="line42"> 42: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DMDA/DMDA.html">DMDA</a>`, `<a href="../manualpages/DMDA/DMDASetBoundaryType.html">DMDASetBoundaryType</a>()`, `<a href="../manualpages/DMDA/DMDACreate1d.html">DMDACreate1d</a>()`, `<a href="../manualpages/DMDA/DMDACreate2d.html">DMDACreate2d</a>()`, `<a href="../manualpages/DMDA/DMDACreate3d.html">DMDACreate3d</a>()`, `<a href="../manualpages/DMDA/DMDACreate.html">DMDACreate</a>()`</font>
<a name="line43"> 43: </a><font color="#B22222">E*/</font>
<a name="line44"> 44: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line45"> 45: </a> <a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_NONE</a>,
<a name="line46"> 46: </a> <a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_GHOSTED</a>,
<a name="line47"> 47: </a> <a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_MIRROR</a>,
<a name="line48"> 48: </a> <a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_PERIODIC</a>,
<a name="line49"> 49: </a> <a href="../manualpages/DM/DMBoundaryType.html">DM_BOUNDARY_TWIST</a>
<a name="line50"> 50: </a>} <a href="../manualpages/DM/DMBoundaryType.html">DMBoundaryType</a>;
<a name="line52"> 52: </a><font color="#B22222">/*E</font>
<a name="line53"> 53: </a><font color="#B22222"> <a href="../manualpages/DM/DMBoundaryConditionType.html">DMBoundaryConditionType</a> - indicates what type of boundary condition is to be imposed</font>
<a name="line55"> 55: </a><font color="#B22222"> Values:</font>
<a name="line56"> 56: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL</a>` - A Dirichlet condition using a function of the coordinates</font>
<a name="line57"> 57: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL_FIELD</a>` - A Dirichlet condition using a function of the coordinates and auxiliary field data</font>
<a name="line58"> 58: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL_BD_FIELD</a>` - A Dirichlet condition using a function of the coordinates, facet normal, and auxiliary field data</font>
<a name="line59"> 59: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL</a>` - A Neumann condition using a function of the coordinates</font>
<a name="line60"> 60: </a><font color="#B22222">. `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL_FIELD</a>` - A Neumann condition using a function of the coordinates and auxiliary field data</font>
<a name="line61"> 61: </a><font color="#B22222">- `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL_RIEMANN</a>` - A flux condition which determines the state in ghost cells</font>
<a name="line63"> 63: </a><font color="#B22222"> Level: beginner</font>
<a name="line65"> 65: </a><font color="#B22222"> Note:</font>
<a name="line66"> 66: </a><font color="#B22222"> The user can check whether a boundary condition is essential using (type & `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL</a>`), and similarly for</font>
<a name="line67"> 67: </a><font color="#B22222"> natural conditions (type & `<a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL</a>`)</font>
<a name="line69"> 69: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMAddBoundary.html">DMAddBoundary</a>()`, `DSAddBoundary()`, `DSGetBoundary()`</font>
<a name="line70"> 70: </a><font color="#B22222">E*/</font>
<a name="line71"> 71: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line72"> 72: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL</a> = 1,
<a name="line73"> 73: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL_FIELD</a> = 5,
<a name="line74"> 74: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL</a> = 2,
<a name="line75"> 75: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL_FIELD</a> = 6,
<a name="line76"> 76: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_ESSENTIAL_BD_FIELD</a> = 9,
<a name="line77"> 77: </a> <a href="../manualpages/DM/DMBoundaryConditionType.html">DM_BC_NATURAL_RIEMANN</a> = 10
<a name="line78"> 78: </a>} <a href="../manualpages/DM/DMBoundaryConditionType.html">DMBoundaryConditionType</a>;
<a name="line80"> 80: </a><font color="#B22222">/*E</font>
<a name="line81"> 81: </a><font color="#B22222"> <a href="../manualpages/DM/DMPointLocationType.html">DMPointLocationType</a> - Describes the method to handle point location failure</font>
<a name="line83"> 83: </a><font color="#B22222"> Values:</font>
<a name="line84"> 84: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_NONE</a>` - return a negative cell number</font>
<a name="line85"> 85: </a><font color="#B22222">. `<a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_NEAREST</a>` - the (approximate) nearest point in the mesh is used</font>
<a name="line86"> 86: </a><font color="#B22222">- `<a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_REMOVE</a>` - returns values only for points which were located</font>
<a name="line88"> 88: </a><font color="#B22222"> Level: intermediate</font>
<a name="line90"> 90: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMLocatePoints.html">DMLocatePoints</a>()`</font>
<a name="line91"> 91: </a><font color="#B22222">E*/</font>
<a name="line92"> 92: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line93"> 93: </a> <a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_NONE</a>,
<a name="line94"> 94: </a> <a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_NEAREST</a>,
<a name="line95"> 95: </a> <a href="../manualpages/DM/DMPointLocationType.html">DM_POINTLOCATION_REMOVE</a>
<a name="line96"> 96: </a>} <a href="../manualpages/DM/DMPointLocationType.html">DMPointLocationType</a>;
<a name="line98"> 98: </a><font color="#B22222">/*E</font>
<a name="line99"> 99: </a><font color="#B22222"> <a href="../manualpages/DM/DMBlockingType.html">DMBlockingType</a> - Describes how to choose variable block sizes</font>
<a name="line101">101: </a><font color="#B22222"> Values:</font>
<a name="line102">102: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMBlockingType.html">DM_BLOCKING_TOPOLOGICAL_POINT</a>` - select all fields at a topological point (cell center, at a face, etc)</font>
<a name="line103">103: </a><font color="#B22222">- `<a href="../manualpages/DM/DMBlockingType.html">DM_BLOCKING_FIELD_NODE</a>` - using a separate block for each field at a topological point</font>
<a name="line105">105: </a><font color="#B22222"> Level: intermediate</font>
<a name="line107">107: </a><font color="#B22222"> Note:</font>
<a name="line108">108: </a><font color="#B22222"> When using `<a href="../manualpages/PC/PCVPBJACOBI.html">PCVPBJACOBI</a>`, one can choose to block by topological point (all fields at a cell center, at a face, etc.)</font>
<a name="line109">109: </a><font color="#B22222"> or by field nodes (using number of components per field to identify "nodes"). Field nodes lead to smaller blocks, but</font>
<a name="line110">110: </a><font color="#B22222"> may converge more slowly. For example, a cubic Lagrange hexahedron will have one node at vertices, two at edges, four</font>
<a name="line111">111: </a><font color="#B22222"> at faces, and eight at cell centers. If using point blocking, the `<a href="../manualpages/PC/PCVPBJACOBI.html">PCVPBJACOBI</a>` preconditioner will work with block</font>
<a name="line112">112: </a><font color="#B22222"> sizes up to 8 Lagrange nodes. For 5-component CFD, this produces matrices up to 40x40, which increases memory</font>
<a name="line113">113: </a><font color="#B22222"> footprint and may harm performance. With field node blocking, the maximum block size will correspond to one Lagrange node,</font>
<a name="line114">114: </a><font color="#B22222"> or 5x5 blocks for the CFD example.</font>
<a name="line116">116: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/PC/PCVPBJACOBI.html">PCVPBJACOBI</a>`, `<a href="../manualpages/Mat/MatSetVariableBlockSizes.html">MatSetVariableBlockSizes</a>()`, `<a href="../manualpages/DM/DMSetBlockingType.html">DMSetBlockingType</a>()`</font>
<a name="line117">117: </a><font color="#B22222">E*/</font>
<a name="line118">118: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line119">119: </a> <a href="../manualpages/DM/DMBlockingType.html">DM_BLOCKING_TOPOLOGICAL_POINT</a>,
<a name="line120">120: </a> <a href="../manualpages/DM/DMBlockingType.html">DM_BLOCKING_FIELD_NODE</a>
<a name="line121">121: </a>} <a href="../manualpages/DM/DMBlockingType.html">DMBlockingType</a>;
<a name="line123">123: </a><font color="#B22222">/*E</font>
<a name="line124">124: </a><font color="#B22222"> <a href="../manualpages/DM/DMAdaptationStrategy.html">DMAdaptationStrategy</a> - Describes the strategy used for adaptive solves</font>
<a name="line126">126: </a><font color="#B22222"> Values:</font>
<a name="line127">127: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_INITIAL</a>` - refine a mesh based on an initial guess</font>
<a name="line128">128: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_SEQUENTIAL</a>` - refine the mesh based on a sequence of solves, much like grid sequencing</font>
<a name="line129">129: </a><font color="#B22222">- `<a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_MULTILEVEL</a>` - use the sequence of constructed meshes in a multilevel solve, much like the Systematic Upscaling of Brandt</font>
<a name="line131">131: </a><font color="#B22222"> Level: beginner</font>
<a name="line133">133: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMAdaptor.html">DMAdaptor</a>`, `<a href="../manualpages/DM/DMAdaptationCriterion.html">DMAdaptationCriterion</a>`, `DMAdaptorSolve()`</font>
<a name="line134">134: </a><font color="#B22222">E*/</font>
<a name="line135">135: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line136">136: </a> <a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_INITIAL</a>,
<a name="line137">137: </a> <a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_SEQUENTIAL</a>,
<a name="line138">138: </a> <a href="../manualpages/DM/DMAdaptationStrategy.html">DM_ADAPTATION_MULTILEVEL</a>
<a name="line139">139: </a>} <a href="../manualpages/DM/DMAdaptationStrategy.html">DMAdaptationStrategy</a>;
<a name="line141">141: </a><font color="#B22222">/*E</font>
<a name="line142">142: </a><font color="#B22222"> <a href="../manualpages/DM/DMAdaptationCriterion.html">DMAdaptationCriterion</a> - Describes the test used to decide whether to coarsen or refine parts of the mesh</font>
<a name="line144">144: </a><font color="#B22222"> Values:</font>
<a name="line145">145: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_REFINE</a>` - uniformly refine a mesh, much like grid sequencing</font>
<a name="line146">146: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_LABEL</a>` - adapt the mesh based upon a label of the cells filled with `<a href="../manualpages/DM/DMAdaptFlag.html">DMAdaptFlag</a>` markers.</font>
<a name="line147">147: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_METRIC</a>` - try to mesh the manifold described by the input metric tensor uniformly. PETSc can also construct such a metric based</font>
<a name="line148">148: </a><font color="#B22222"> upon an input primal or a gradient field.</font>
<a name="line149">149: </a><font color="#B22222">- `<a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_NONE</a>` - do no adaptation</font>
<a name="line151">151: </a><font color="#B22222"> Level: beginner</font>
<a name="line153">153: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMAdaptor.html">DMAdaptor</a>`, `<a href="../manualpages/DM/DMAdaptationStrategy.html">DMAdaptationStrategy</a>`, `DMAdaptorSolve()`</font>
<a name="line154">154: </a><font color="#B22222">E*/</font>
<a name="line155">155: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line156">156: </a> <a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_NONE</a>,
<a name="line157">157: </a> <a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_REFINE</a>,
<a name="line158">158: </a> <a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_LABEL</a>,
<a name="line159">159: </a> <a href="../manualpages/DM/DMAdaptationCriterion.html">DM_ADAPTATION_METRIC</a>
<a name="line160">160: </a>} <a href="../manualpages/DM/DMAdaptationCriterion.html">DMAdaptationCriterion</a>;
<a name="line161">161: </a>PETSC_EXTERN const char *const DMAdaptationCriteria[];
<a name="line163">163: </a><font color="#B22222">/*E</font>
<a name="line164">164: </a><font color="#B22222"> <a href="../manualpages/DM/DMAdaptFlag.html">DMAdaptFlag</a> - Marker in the label prescribing what adaptation to perform</font>
<a name="line166">166: </a><font color="#B22222"> Values:</font>
<a name="line167">167: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_DETERMINE</a>` - undocumented</font>
<a name="line168">168: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_KEEP</a>` - undocumented</font>
<a name="line169">169: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_REFINE</a>` - undocumented</font>
<a name="line170">170: </a><font color="#B22222">. `<a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_COARSEN</a>` - undocumented</font>
<a name="line171">171: </a><font color="#B22222">- `<a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_COARSEN_LAST</a>` - undocumented</font>
<a name="line173">173: </a><font color="#B22222"> Level: beginner</font>
<a name="line175">175: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMAdaptor.html">DMAdaptor</a>`, `<a href="../manualpages/DM/DMAdaptationStrategy.html">DMAdaptationStrategy</a>`, `<a href="../manualpages/DM/DMAdaptationCriterion.html">DMAdaptationCriterion</a>`, `DMAdaptorSolve()`, `<a href="../manualpages/DM/DMAdaptLabel.html">DMAdaptLabel</a>()`</font>
<a name="line176">176: </a><font color="#B22222">E*/</font>
<a name="line177">177: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line178">178: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_DETERMINE</a> = <a href="../manualpages/Sys/PETSC_DETERMINE.html">PETSC_DETERMINE</a>,
<a name="line179">179: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_KEEP</a> = 0,
<a name="line180">180: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_REFINE</a> = 1,
<a name="line181">181: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_COARSEN</a> = 2,
<a name="line182">182: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_COARSEN_LAST</a> = 3,
<a name="line183">183: </a> <a href="../manualpages/DM/DMAdaptFlag.html">DM_ADAPT_RESERVED_COUNT</a> = 4
<a name="line184">184: </a>} <a href="../manualpages/DM/DMAdaptFlag.html">DMAdaptFlag</a>;
<a name="line186">186: </a><font color="#B22222">/*E</font>
<a name="line187">187: </a><font color="#B22222"> <a href="../manualpages/DM/DMDirection.html">DMDirection</a> - Indicates a coordinate direction</font>
<a name="line189">189: </a><font color="#B22222"> Values:</font>
<a name="line190">190: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMDirection.html">DM_X</a>` - the x coordinate direction</font>
<a name="line191">191: </a><font color="#B22222">. `<a href="../manualpages/DM/DMDirection.html">DM_Y</a>` - the y coordinate direction</font>
<a name="line192">192: </a><font color="#B22222">- `<a href="../manualpages/DM/DMDirection.html">DM_Z</a>` - the z coordinate direction</font>
<a name="line194">194: </a><font color="#B22222"> Level: beginner</font>
<a name="line196">196: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DMDA/DMDA.html">DMDA</a>`, `<a href="../manualpages/DMDA/DMDAGetRay.html">DMDAGetRay</a>()`, `<a href="../manualpages/DMDA/DMDAGetProcessorSubset.html">DMDAGetProcessorSubset</a>()`, `<a href="../manualpages/DMPlex/DMPlexShearGeometry.html">DMPlexShearGeometry</a>()`</font>
<a name="line197">197: </a><font color="#B22222">E*/</font>
<a name="line198">198: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line199">199: </a> <a href="../manualpages/DM/DMDirection.html">DM_X</a>,
<a name="line200">200: </a> <a href="../manualpages/DM/DMDirection.html">DM_Y</a>,
<a name="line201">201: </a> <a href="../manualpages/DM/DMDirection.html">DM_Z</a>
<a name="line202">202: </a>} <a href="../manualpages/DM/DMDirection.html">DMDirection</a>;
<a name="line204">204: </a><font color="#B22222">/*E</font>
<a name="line205">205: </a><font color="#B22222"> <a href="../manualpages/DM/DMEnclosureType.html">DMEnclosureType</a> - The type of enclosure relation between one `<a href="../manualpages/DM/DM.html">DM</a>` and another</font>
<a name="line207">207: </a><font color="#B22222"> Values:</font>
<a name="line208">208: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_SUBMESH</a>` - the `<a href="../manualpages/DM/DM.html">DM</a>` is the boundary of another `<a href="../manualpages/DM/DM.html">DM</a>`</font>
<a name="line209">209: </a><font color="#B22222">. `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_SUPERMESH</a>` - the `<a href="../manualpages/DM/DM.html">DM</a>` has the boundary of another `<a href="../manualpages/DM/DM.html">DM</a>` (the reverse situation to `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_SUBMESH</a>`)</font>
<a name="line210">210: </a><font color="#B22222">. `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_EQUALITY</a>` - it is unknown what this means</font>
<a name="line211">211: </a><font color="#B22222">. `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_NONE</a>` - no relationship can be determined</font>
<a name="line212">212: </a><font color="#B22222">- `<a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_UNKNOWN</a>` - the relationship is unknown</font>
<a name="line214">214: </a><font color="#B22222"> Level: beginner</font>
<a name="line216">216: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DMPlex/DMGetEnclosureRelation.html">DMGetEnclosureRelation</a>()`</font>
<a name="line217">217: </a><font color="#B22222">E*/</font>
<a name="line218">218: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line219">219: </a> <a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_EQUALITY</a>,
<a name="line220">220: </a> <a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_SUPERMESH</a>,
<a name="line221">221: </a> <a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_SUBMESH</a>,
<a name="line222">222: </a> <a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_NONE</a>,
<a name="line223">223: </a> <a href="../manualpages/DM/DMEnclosureType.html">DM_ENC_UNKNOWN</a>
<a name="line224">224: </a>} <a href="../manualpages/DM/DMEnclosureType.html">DMEnclosureType</a>;
<a name="line226">226: </a><font color="#B22222">/*E</font>
<a name="line227">227: </a><font color="#B22222"> <a href="../manualpages/DM/DMPolytopeType.html">DMPolytopeType</a> - This describes the polytope represented by each cell.</font>
<a name="line229">229: </a><font color="#B22222"> Level: beginner</font>
<a name="line231">231: </a><font color="#B22222"> While most operations only need the topology information in the `<a href="../manualpages/DMPlex/DMPLEX.html">DMPLEX</a>`, we must sometimes have the</font>
<a name="line232">232: </a><font color="#B22222"> user specify a polytope. For instance, when interpolating from a cell-vertex mesh, the type of</font>
<a name="line233">233: </a><font color="#B22222"> polytope can be ambiguous. Also, `<a href="../manualpages/DMPlex/DMPLEX.html">DMPLEX</a>` allows different symmetries of a prism cell with the same</font>
<a name="line234">234: </a><font color="#B22222"> constituent points. Normally these types are automatically inferred and the user does not specify</font>
<a name="line235">235: </a><font color="#B22222"> them.</font>
<a name="line237">237: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DMPlex/DMPlexComputeCellTypes.html">DMPlexComputeCellTypes</a>()`</font>
<a name="line238">238: </a><font color="#B22222">E*/</font>
<a name="line239">239: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line240">240: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_POINT</a>,
<a name="line241">241: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_SEGMENT</a>,
<a name="line242">242: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_POINT_PRISM_TENSOR</a>,
<a name="line243">243: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_TRIANGLE</a>,
<a name="line244">244: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_QUADRILATERAL</a>,
<a name="line245">245: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_SEG_PRISM_TENSOR</a>,
<a name="line246">246: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_TETRAHEDRON</a>,
<a name="line247">247: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_HEXAHEDRON</a>,
<a name="line248">248: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_TRI_PRISM</a>,
<a name="line249">249: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_TRI_PRISM_TENSOR</a>,
<a name="line250">250: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_QUAD_PRISM_TENSOR</a>,
<a name="line251">251: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_PYRAMID</a>,
<a name="line252">252: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_FV_GHOST</a>,
<a name="line253">253: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_INTERIOR_GHOST</a>,
<a name="line254">254: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_UNKNOWN</a>,
<a name="line255">255: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_UNKNOWN_CELL</a>,
<a name="line256">256: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_POLYTOPE_UNKNOWN_FACE</a>,
<a name="line257">257: </a> <a href="../manualpages/DM/DMPolytopeType.html">DM_NUM_POLYTOPES</a>
<a name="line258">258: </a>} <a href="../manualpages/DM/DMPolytopeType.html">DMPolytopeType</a>;
<a name="line259">259: </a>PETSC_EXTERN const char *const DMPolytopeTypes[];
<a name="line261">261: </a><font color="#B22222">/*E</font>
<a name="line262">262: </a><font color="#B22222"> <a href="../manualpages/DM/PetscUnit.html">PetscUnit</a> - The seven fundamental SI units</font>
<a name="line264">264: </a><font color="#B22222"> Level: beginner</font>
<a name="line266">266: </a><font color="#B22222">.seealso: `<a href="../manualpages/DMPlex/DMPlexGetScale.html">DMPlexGetScale</a>()`, `<a href="../manualpages/DMPlex/DMPlexSetScale.html">DMPlexSetScale</a>()`</font>
<a name="line267">267: </a><font color="#B22222">E*/</font>
<a name="line268">268: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line269">269: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_LENGTH</a>,
<a name="line270">270: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_MASS</a>,
<a name="line271">271: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_TIME</a>,
<a name="line272">272: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_CURRENT</a>,
<a name="line273">273: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_TEMPERATURE</a>,
<a name="line274">274: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_AMOUNT</a>,
<a name="line275">275: </a> <a href="../manualpages/DM/PetscUnit.html">PETSC_UNIT_LUMINOSITY</a>,
<a name="line276">276: </a> <a href="../manualpages/DM/PetscUnit.html">NUM_PETSC_UNITS</a>
<a name="line277">277: </a>} <a href="../manualpages/DM/PetscUnit.html">PetscUnit</a>;
<a name="line279">279: </a><font color="#B22222">/*E</font>
<a name="line280">280: </a><font color="#B22222"> <a href="../manualpages/DM/DMReorderDefaultFlag.html">DMReorderDefaultFlag</a> - Flag indicating whether the `<a href="../manualpages/DM/DM.html">DM</a>` should be reordered by default</font>
<a name="line282">282: </a><font color="#B22222"> Values:</font>
<a name="line283">283: </a><font color="#B22222">+ `<a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_NOTSET</a>` - Flag not set.</font>
<a name="line284">284: </a><font color="#B22222">. `<a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_FALSE</a>` - Do not reorder by default.</font>
<a name="line285">285: </a><font color="#B22222">- `<a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_TRUE</a>` - Reorder by default.</font>
<a name="line287">287: </a><font color="#B22222"> Level: intermediate</font>
<a name="line289">289: </a><font color="#B22222"> Developer Note:</font>
<a name="line290">290: </a><font color="#B22222"> Could be replaced with `PETSC_BOOL3`</font>
<a name="line292">292: </a><font color="#B22222">.seealso: `<a href="../manualpages/DMPlex/DMPlexReorderSetDefault.html">DMPlexReorderSetDefault</a>()`, `<a href="../manualpages/DMPlex/DMPlexReorderGetDefault.html">DMPlexReorderGetDefault</a>()`, `<a href="../manualpages/DMPlex/DMPlexGetOrdering.html">DMPlexGetOrdering</a>()`, `<a href="../manualpages/DMPlex/DMPlexPermute.html">DMPlexPermute</a>()`</font>
<a name="line293">293: </a><font color="#B22222">E*/</font>
<a name="line294">294: </a><font color="#4169E1">typedef</font> <font color="#4169E1">enum</font> {
<a name="line295">295: </a> <a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_NOTSET</a> = -1,
<a name="line296">296: </a> <a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_FALSE</a> = 0,
<a name="line297">297: </a> <a href="../manualpages/DM/DMReorderDefaultFlag.html">DM_REORDER_DEFAULT_TRUE</a> = 1
<a name="line298">298: </a>} <a href="../manualpages/DM/DMReorderDefaultFlag.html">DMReorderDefaultFlag</a>;
<a name="line300">300: </a><font color="#B22222">/*S</font>
<a name="line301">301: </a><font color="#B22222"> <a href="../manualpages/DM/DMField.html">DMField</a> - PETSc object for defining a field on a mesh topology</font>
<a name="line303">303: </a><font color="#B22222"> Level: intermediate</font>
<a name="line305">305: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMUniversalLabel.html">DMUniversalLabel</a>`, `<a href="../manualpages/DMLabel/DMLabelCreate.html">DMLabelCreate</a>()`</font>
<a name="line306">306: </a><font color="#B22222">S*/</font>
<a name="line307">307: </a><font color="#4169E1">typedef struct _p_DMField *<a href="../manualpages/DM/DMField.html">DMField</a>;</font>
<a name="line309">309: </a><font color="#B22222">/*S</font>
<a name="line310">310: </a><font color="#B22222"> <a href="../manualpages/DM/DMUniversalLabel.html">DMUniversalLabel</a> - A label that encodes a set of `<a href="../manualpages/DM/DMLabel.html">DMLabel</a>`s, bijectively</font>
<a name="line312">312: </a><font color="#B22222"> Level: developer</font>
<a name="line314">314: </a><font color="#B22222">.seealso: [](ch_dmbase), `<a href="../manualpages/DM/DM.html">DM</a>`, `<a href="../manualpages/DM/DMLabel.html">DMLabel</a>`, `DMUniversalLabelCreate()`</font>
<a name="line315">315: </a><font color="#B22222">S*/</font>
<a name="line316">316: </a><font color="#4169E1">typedef struct _p_UniversalLabel *<a href="../manualpages/DM/DMUniversalLabel.html">DMUniversalLabel</a>;</font>
<a name="line318">318: </a><font color="#4169E1">typedef struct _PETSc_DMCEED *DMCeed;</font>
<a name="line320">320: </a><font color="#4169E1">typedef struct _n_DMGeneratorFunctionList *DMGeneratorFunctionList;</font>
</pre>
</body>
</html>
|
