forked from DLR-SC/tigl-website
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathclasst8__default__scheme__common.html
484 lines (458 loc) · 31.2 KB
/
classt8__default__scheme__common.html
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
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>t8: t8_default_scheme_common< TUnderlyingEclassScheme > Class Template Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">t8
 <span id="projectnumber">4.0.0-RC1.588-22cbd</span>
</div>
<div id="projectbrief">t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">t8_default_scheme_common< TUnderlyingEclassScheme > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Inheritance diagram for t8_default_scheme_common< TUnderlyingEclassScheme >:</div>
<div class="dyncontent">
<div class="center">
<img src="classt8__default__scheme__common.png" usemap="#t8_5Fdefault_5Fscheme_5Fcommon_3C_20TUnderlyingEclassScheme_20_3E_map" alt=""/>
<map id="t8_5Fdefault_5Fscheme_5Fcommon_3C_20TUnderlyingEclassScheme_20_3E_map" name="t8_5Fdefault_5Fscheme_5Fcommon_3C_20TUnderlyingEclassScheme_20_3E_map">
<area href="structt8__crtp__operator.html" alt="t8_crtp_operator< TUnderlyingEclassScheme, t8_default_scheme_common >" shape="rect" coords="0,0,447,24"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a40923bd55b6656b84a90469fd0de9b8a"><td class="memItemLeft" align="right" valign="top"><a id="a40923bd55b6656b84a90469fd0de9b8a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a40923bd55b6656b84a90469fd0de9b8a">~t8_default_scheme_common</a> ()</td></tr>
<tr class="memdesc:a40923bd55b6656b84a90469fd0de9b8a"><td class="mdescLeft"> </td><td class="mdescRight">Destructor for all default schemes. <br /></td></tr>
<tr class="separator:a40923bd55b6656b84a90469fd0de9b8a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b5a90da2b2f16ac12b7b606b670255a"><td class="memItemLeft" align="right" valign="top"><a id="a5b5a90da2b2f16ac12b7b606b670255a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a5b5a90da2b2f16ac12b7b606b670255a">t8_default_scheme_common</a> (<a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> &&other) noexcept</td></tr>
<tr class="memdesc:a5b5a90da2b2f16ac12b7b606b670255a"><td class="mdescLeft"> </td><td class="mdescRight">Move constructor. <br /></td></tr>
<tr class="separator:a5b5a90da2b2f16ac12b7b606b670255a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0c1f5ae3062d1df8a4680cc1dd09f7c"><td class="memItemLeft" align="right" valign="top"><a id="ac0c1f5ae3062d1df8a4680cc1dd09f7c"></a>
<a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#ac0c1f5ae3062d1df8a4680cc1dd09f7c">operator=</a> (<a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> &&other) noexcept</td></tr>
<tr class="memdesc:ac0c1f5ae3062d1df8a4680cc1dd09f7c"><td class="mdescLeft"> </td><td class="mdescRight">Move assignment operator. <br /></td></tr>
<tr class="separator:ac0c1f5ae3062d1df8a4680cc1dd09f7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8e457b2ea6395f9424f8b870ea8d5ebb"><td class="memItemLeft" align="right" valign="top"><a id="a8e457b2ea6395f9424f8b870ea8d5ebb"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a8e457b2ea6395f9424f8b870ea8d5ebb">t8_default_scheme_common</a> (const <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> &other)</td></tr>
<tr class="memdesc:a8e457b2ea6395f9424f8b870ea8d5ebb"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <br /></td></tr>
<tr class="separator:a8e457b2ea6395f9424f8b870ea8d5ebb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6adfdf73c09f637afaf18e6f4477c5e"><td class="memItemLeft" align="right" valign="top"><a id="ac6adfdf73c09f637afaf18e6f4477c5e"></a>
<a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#ac6adfdf73c09f637afaf18e6f4477c5e">operator=</a> (const <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a> &other)</td></tr>
<tr class="memdesc:ac6adfdf73c09f637afaf18e6f4477c5e"><td class="mdescLeft"> </td><td class="mdescRight">Copy assignment operator. <br /></td></tr>
<tr class="separator:ac6adfdf73c09f637afaf18e6f4477c5e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1eac2ada93152f6f0d14ca7d0a106060"><td class="memItemLeft" align="right" valign="top"><a class="el" href="t8__eclass_8h.html#a343c2af26e5b41822905b164cab176ec">t8_eclass_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a1eac2ada93152f6f0d14ca7d0a106060">get_eclass</a> (void) const</td></tr>
<tr class="memdesc:a1eac2ada93152f6f0d14ca7d0a106060"><td class="mdescLeft"> </td><td class="mdescRight">Return the tree class of this scheme. <a href="classt8__default__scheme__common.html#a1eac2ada93152f6f0d14ca7d0a106060">More...</a><br /></td></tr>
<tr class="separator:a1eac2ada93152f6f0d14ca7d0a106060"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e35bfebec7f93ac7819fecf4439a45e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a1e35bfebec7f93ac7819fecf4439a45e">get_element_size</a> (void) const</td></tr>
<tr class="memdesc:a1e35bfebec7f93ac7819fecf4439a45e"><td class="mdescLeft"> </td><td class="mdescRight">Return the size of any element of a given class. <a href="classt8__default__scheme__common.html#a1e35bfebec7f93ac7819fecf4439a45e">More...</a><br /></td></tr>
<tr class="separator:a1e35bfebec7f93ac7819fecf4439a45e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad2b78b757d8b1b363ad4dbce2417f3c0"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#ad2b78b757d8b1b363ad4dbce2417f3c0">element_get_num_corners</a> (const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *elem) const</td></tr>
<tr class="memdesc:ad2b78b757d8b1b363ad4dbce2417f3c0"><td class="mdescLeft"> </td><td class="mdescRight">Compute the number of corners of a given element. <a href="classt8__default__scheme__common.html#ad2b78b757d8b1b363ad4dbce2417f3c0">More...</a><br /></td></tr>
<tr class="separator:ad2b78b757d8b1b363ad4dbce2417f3c0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3c9445f7a80b2443e24e259f3bff7cc5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a3c9445f7a80b2443e24e259f3bff7cc5">element_new</a> (const int length, <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> **elem) const</td></tr>
<tr class="memdesc:a3c9445f7a80b2443e24e259f3bff7cc5"><td class="mdescLeft"> </td><td class="mdescRight">Allocate space for a bunch of elements. <a href="classt8__default__scheme__common.html#a3c9445f7a80b2443e24e259f3bff7cc5">More...</a><br /></td></tr>
<tr class="separator:a3c9445f7a80b2443e24e259f3bff7cc5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac77acfc5336aa93ae86b8bfaae5dcfac"><td class="memItemLeft" align="right" valign="top"><a id="ac77acfc5336aa93ae86b8bfaae5dcfac"></a>
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#ac77acfc5336aa93ae86b8bfaae5dcfac">element_destroy</a> (const int length, <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> **elem) const</td></tr>
<tr class="memdesc:ac77acfc5336aa93ae86b8bfaae5dcfac"><td class="mdescLeft"> </td><td class="mdescRight">Deallocate space for a bunch of elements. <br /></td></tr>
<tr class="separator:ac77acfc5336aa93ae86b8bfaae5dcfac"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab94c66fe8db6ec438b9d775bba510d6d"><td class="memItemLeft" align="right" valign="top"><a id="ab94c66fe8db6ec438b9d775bba510d6d"></a>
void </td><td class="memItemRight" valign="bottom"><b>element_deinit</b> (int length, <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *elem) const</td></tr>
<tr class="separator:ab94c66fe8db6ec438b9d775bba510d6d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2f534239240c26909905acb33ecb7e67"><td class="memItemLeft" align="right" valign="top"><a class="el" href="t8__element__shape_8h.html#aab8844a13783f0c1ab05e1d027fd545a">t8_element_shape_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a2f534239240c26909905acb33ecb7e67">element_get_shape</a> (const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *elem) const</td></tr>
<tr class="memdesc:a2f534239240c26909905acb33ecb7e67"><td class="mdescLeft"> </td><td class="mdescRight">Return the shape of an element. <a href="classt8__default__scheme__common.html#a2f534239240c26909905acb33ecb7e67">More...</a><br /></td></tr>
<tr class="separator:a2f534239240c26909905acb33ecb7e67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adcf1e870b3f28bb5398488c70af57a49"><td class="memItemLeft" align="right" valign="top"><a class="el" href="t8_8h.html#a03692467b9ffc84d4d0c37e042679225">t8_gloidx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#adcf1e870b3f28bb5398488c70af57a49">element_count_leaves</a> (const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *t, int level) const</td></tr>
<tr class="memdesc:adcf1e870b3f28bb5398488c70af57a49"><td class="mdescLeft"> </td><td class="mdescRight">Count how many leaf descendants of a given uniform level an element would produce. <a href="classt8__default__scheme__common.html#adcf1e870b3f28bb5398488c70af57a49">More...</a><br /></td></tr>
<tr class="separator:adcf1e870b3f28bb5398488c70af57a49"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeec0b9b1bf0438d04ccef204c44f0659"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#aeec0b9b1bf0438d04ccef204c44f0659">element_get_num_siblings</a> (const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *elem) const</td></tr>
<tr class="memdesc:aeec0b9b1bf0438d04ccef204c44f0659"><td class="mdescLeft"> </td><td class="mdescRight">Compute the number of siblings of an element. <a href="classt8__default__scheme__common.html#aeec0b9b1bf0438d04ccef204c44f0659">More...</a><br /></td></tr>
<tr class="separator:aeec0b9b1bf0438d04ccef204c44f0659"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aade1abc806eafb74d8e3c6c36a002a0b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="t8_8h.html#a03692467b9ffc84d4d0c37e042679225">t8_gloidx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#aade1abc806eafb74d8e3c6c36a002a0b">count_leaves_from_root</a> (const int level) const</td></tr>
<tr class="memdesc:aade1abc806eafb74d8e3c6c36a002a0b"><td class="mdescLeft"> </td><td class="mdescRight">Count how many leaf descendants of a given uniform level the root element will produce. <a href="classt8__default__scheme__common.html#aade1abc806eafb74d8e3c6c36a002a0b">More...</a><br /></td></tr>
<tr class="separator:aade1abc806eafb74d8e3c6c36a002a0b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab8d1caf4533912c18f66c5bb0cf76c85"><td class="memItemLeft" align="right" valign="top"><a id="ab8d1caf4533912c18f66c5bb0cf76c85"></a>
void </td><td class="memItemRight" valign="bottom"><b>element_debug_print</b> (const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> *elem) const</td></tr>
<tr class="separator:ab8d1caf4533912c18f66c5bb0cf76c85"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_structt8__crtp__operator"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_structt8__crtp__operator')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="structt8__crtp__operator.html">t8_crtp_operator< TUnderlyingEclassScheme, t8_default_scheme_common ></a></td></tr>
<tr class="memitem:a6e33d283003d5653456196f7dfe1568a inherit pub_methods_structt8__crtp__operator"><td class="memItemLeft" align="right" valign="top"><a id="a6e33d283003d5653456196f7dfe1568a"></a>
constexpr TUnderlyingEclassScheme & </td><td class="memItemRight" valign="bottom"><b>underlying</b> () noexcept</td></tr>
<tr class="separator:a6e33d283003d5653456196f7dfe1568a inherit pub_methods_structt8__crtp__operator"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abba1bcc85b8fb7b29cfdb0e60d225774 inherit pub_methods_structt8__crtp__operator"><td class="memItemLeft" align="right" valign="top"><a id="abba1bcc85b8fb7b29cfdb0e60d225774"></a>
constexpr const TUnderlyingEclassScheme & </td><td class="memItemRight" valign="bottom"><b>underlying</b> () const noexcept</td></tr>
<tr class="separator:abba1bcc85b8fb7b29cfdb0e60d225774 inherit pub_methods_structt8__crtp__operator"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a1e844a8f053755b5022e812deeb0f849"><td class="memItemLeft" align="right" valign="top"><a id="a1e844a8f053755b5022e812deeb0f849"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a1e844a8f053755b5022e812deeb0f849">element_size</a></td></tr>
<tr class="memdesc:a1e844a8f053755b5022e812deeb0f849"><td class="mdescLeft"> </td><td class="mdescRight">The size in bytes of an element of class <em>eclass</em>. <br /></td></tr>
<tr class="separator:a1e844a8f053755b5022e812deeb0f849"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a57cfb71df5691e5b67a888d6d76f3edd"><td class="memItemLeft" align="right" valign="top"><a id="a57cfb71df5691e5b67a888d6d76f3edd"></a>
void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a57cfb71df5691e5b67a888d6d76f3edd">ts_context</a></td></tr>
<tr class="memdesc:a57cfb71df5691e5b67a888d6d76f3edd"><td class="mdescLeft"> </td><td class="mdescRight">Anonymous implementation context. <br /></td></tr>
<tr class="separator:a57cfb71df5691e5b67a888d6d76f3edd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0bc4c33e0df7b207b03726c33ed737f8"><td class="memItemLeft" align="right" valign="top"><a id="a0bc4c33e0df7b207b03726c33ed737f8"></a>
<a class="el" href="t8__eclass_8h.html#a343c2af26e5b41822905b164cab176ec">t8_eclass_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classt8__default__scheme__common.html#a0bc4c33e0df7b207b03726c33ed737f8">eclass</a></td></tr>
<tr class="memdesc:a0bc4c33e0df7b207b03726c33ed737f8"><td class="mdescLeft"> </td><td class="mdescRight">The tree class. <br /></td></tr>
<tr class="separator:a0bc4c33e0df7b207b03726c33ed737f8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aade1abc806eafb74d8e3c6c36a002a0b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aade1abc806eafb74d8e3c6c36a002a0b">◆ </a></span>count_leaves_from_root()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="t8_8h.html#a03692467b9ffc84d4d0c37e042679225">t8_gloidx_t</a> <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::count_leaves_from_root </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>level</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Count how many leaf descendants of a given uniform level the root element will produce. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>A refinement level. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of <a class="el" href="t8__scheme_8h.html#a8e292133f473afd79d35e070bc258abd">t8_element_count_leaves</a> if the input element is the root (level 0) element. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is overwritten by the pyramid implementation. </dd></dl>
</div>
</div>
<a id="adcf1e870b3f28bb5398488c70af57a49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adcf1e870b3f28bb5398488c70af57a49">◆ </a></span>element_count_leaves()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="t8_8h.html#a03692467b9ffc84d4d0c37e042679225">t8_gloidx_t</a> <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::element_count_leaves </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> * </td>
<td class="paramname"><em>t</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>level</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Count how many leaf descendants of a given uniform level an element would produce. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">t</td><td>The element to be checked. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>A refinement level. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Suppose <em>t</em> is uniformly refined up to level <em>level</em>. The return value is the resulting number of elements (of the given level). Each default element (except pyramids) refines into 2^{dim * (level - level(t))} children. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is overwritten by the pyramid implementation. </dd></dl>
</div>
</div>
<a id="ad2b78b757d8b1b363ad4dbce2417f3c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad2b78b757d8b1b363ad4dbce2417f3c0">◆ </a></span>element_get_num_corners()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::element_get_num_corners </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> * </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the number of corners of a given element. </p>
<dl class="section return"><dt>Returns</dt><dd>The number of corners of the element. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is overwritten by the pyramid implementation. </dd></dl>
</div>
</div>
<a id="aeec0b9b1bf0438d04ccef204c44f0659"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeec0b9b1bf0438d04ccef204c44f0659">◆ </a></span>element_get_num_siblings()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">int <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::element_get_num_siblings </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> * </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Compute the number of siblings of an element. </p>
<p>That is the number of Children of its parent. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">elem</td><td>The element. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of siblings of <em>element</em>. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is overwritten by the pyramid implementation. </dd>
<dd>
that this number is >= 1, since we count the element itself as a sibling. </dd></dl>
</div>
</div>
<a id="a2f534239240c26909905acb33ecb7e67"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2f534239240c26909905acb33ecb7e67">◆ </a></span>element_get_shape()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="t8__element__shape_8h.html#aab8844a13783f0c1ab05e1d027fd545a">t8_element_shape_t</a> <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::element_get_shape </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> * </td>
<td class="paramname"><em>elem</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the shape of an element. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">elem</td><td>The element. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The shape of the element. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is overwritten by the pyramid implementation. </dd></dl>
</div>
</div>
<a id="a3c9445f7a80b2443e24e259f3bff7cc5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c9445f7a80b2443e24e259f3bff7cc5">◆ </a></span>element_new()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::element_new </td>
<td>(</td>
<td class="paramtype">const int </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="t8__element_8h.html#ac4c605cddc1aad4d36398a773768f738">t8_element_t</a> ** </td>
<td class="paramname"><em>elem</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate space for a bunch of elements. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>The number of elements to allocate. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">elem</td><td>The elements to allocate. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a1eac2ada93152f6f0d14ca7d0a106060"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1eac2ada93152f6f0d14ca7d0a106060">◆ </a></span>get_eclass()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="t8__eclass_8h.html#a343c2af26e5b41822905b164cab176ec">t8_eclass_t</a> <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::get_eclass </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the tree class of this scheme. </p>
<dl class="section return"><dt>Returns</dt><dd>The tree class of this scheme. </dd></dl>
</div>
</div>
<a id="a1e35bfebec7f93ac7819fecf4439a45e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1e35bfebec7f93ac7819fecf4439a45e">◆ </a></span>get_element_size()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TUnderlyingEclassScheme > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classt8__default__scheme__common.html">t8_default_scheme_common</a>< TUnderlyingEclassScheme >::get_element_size </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the size of any element of a given class. </p>
<dl class="section return"><dt>Returns</dt><dd>The size of an element of class <b>ts</b>. We provide a default implementation of this routine that should suffice for most use cases. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/t8_schemes/t8_default/t8_default_common/<a class="el" href="t8__default__common_8hxx_source.html">t8_default_common.hxx</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.13-->
<!-- start footer part -->
<hr class="footer"/>
</body>
</html>