-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathalgebra__misc_8h_source.html
177 lines (175 loc) · 16.1 KB
/
algebra__misc_8h_source.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
<!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>ug4: ugbase/lib_algebra/cpu_algebra/algebra_misc.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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" />
<link href="extra_stylesheet.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">ug4
</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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('algebra__misc_8h_source.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="headertitle">
<div class="title">algebra_misc.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="algebra__misc_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2010-2013: G-CSC, Goethe University Frankfurt</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Author: Martin Rupp</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of UG4.</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * UG4 is free software: you can redistribute it and/or modify it under the</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * terms of the GNU Lesser General Public License version 3 (as published by the</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Free Software Foundation) with the following additional attribution</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * requirements (according to LGPL/GPL v3 §7):</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * (1) The following notice must be displayed in the Appropriate Legal Notices</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * of covered and combined works: "Based on UG4 (www.ug4.org/license)".</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * (2) The following notice must be displayed at a prominent place in the</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * (3) The following bibliography is recommended for citation and must be</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * preserved in all covered files:</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * parallel geometric multigrid solver on hierarchically distributed grids.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Computing and visualization in science 16, 4 (2013), 151-164"</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * flexible software system for simulating pde based models on high performance</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * computers. Computing and visualization in science 16, 4 (2013), 165-179"</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * </span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#ifndef __H__UG__CPU_ALGEBRA__ALGEBRA_MISC__</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define __H__UG__CPU_ALGEBRA__ALGEBRA_MISC__</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">namespace </span><a class="code" href="namespaceug.html">ug</a></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> {</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  </div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  </div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="group__lib__algebra.html#ga4526bb543d3223ad7d3b5425283c875c"> 46</a></span> <span class="preprocessor">#define FORCE_CREATION volatile size_t ___never_happens___ = 0; if(___never_happens___)</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#else</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define FORCE_CREATION if(0)</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="group__lib__algebra.html#gadf7f98346f6aa16fc71901289cab8412"> 52</a></span> <span class="preprocessor">#define UNUSED_VARIABLE(var) ((void) var);</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="keyword">template</span><<span class="keyword">typename</span> T></div>
<div class="line"><a name="l00059"></a><span class="lineno"><a class="line" href="structug_1_1sort_struct.html"> 59</a></span> <span class="keyword">struct </span><a class="code" href="structug_1_1sort_struct.html">sortStruct</a></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> {</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="line" href="structug_1_1sort_struct.html#a3e1ffa3b79ddd00b0cdc82ca7be0650a"> 61</a></span>  <span class="keywordtype">size_t</span> <a class="code" href="structug_1_1sort_struct.html#a3e1ffa3b79ddd00b0cdc82ca7be0650a">index</a>; <span class="comment">// for example "original" position.</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="structug_1_1sort_struct.html#acec2a176b6979047755a39fcff2dba05"> 62</a></span>  T <a class="code" href="structug_1_1sort_struct.html#acec2a176b6979047755a39fcff2dba05">sortValue</a>;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="structug_1_1sort_struct.html#a10ca9b65f2783a964c6a9afd734833db"> 64</a></span>  <span class="keywordtype">bool</span> <a class="code" href="structug_1_1sort_struct.html#a10ca9b65f2783a964c6a9afd734833db">operator < </a>(<span class="keyword">const</span> <a class="code" href="structug_1_1sort_struct.html">sortStruct<T></a> &other)<span class="keyword"> const</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword"> </span>{</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordflow">return</span> <a class="code" href="structug_1_1sort_struct.html#acec2a176b6979047755a39fcff2dba05">sortValue</a> < other.<a class="code" href="structug_1_1sort_struct.html#acec2a176b6979047755a39fcff2dba05">sortValue</a>;</div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> };</div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment">// end group lib_algebra</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> }</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif </span><span class="comment">// __H__UG__CPU_ALGEBRA__ALGEBRA_MISC__</span></div>
<div class="ttc" id="anamespaceug_html"><div class="ttname"><a href="namespaceug.html">ug</a></div><div class="ttdoc">the ug namespace</div></div>
<div class="ttc" id="astructug_1_1sort_struct_html"><div class="ttname"><a href="structug_1_1sort_struct.html">ug::sortStruct</a></div><div class="ttdef"><b>Definition:</b> algebra_misc.h:60</div></div>
<div class="ttc" id="astructug_1_1sort_struct_html_a10ca9b65f2783a964c6a9afd734833db"><div class="ttname"><a href="structug_1_1sort_struct.html#a10ca9b65f2783a964c6a9afd734833db">ug::sortStruct::operator<</a></div><div class="ttdeci">bool operator<(const sortStruct< T > &other) const</div><div class="ttdef"><b>Definition:</b> algebra_misc.h:64</div></div>
<div class="ttc" id="astructug_1_1sort_struct_html_a3e1ffa3b79ddd00b0cdc82ca7be0650a"><div class="ttname"><a href="structug_1_1sort_struct.html#a3e1ffa3b79ddd00b0cdc82ca7be0650a">ug::sortStruct::index</a></div><div class="ttdeci">size_t index</div><div class="ttdef"><b>Definition:</b> algebra_misc.h:61</div></div>
<div class="ttc" id="astructug_1_1sort_struct_html_acec2a176b6979047755a39fcff2dba05"><div class="ttname"><a href="structug_1_1sort_struct.html#acec2a176b6979047755a39fcff2dba05">ug::sortStruct::sortValue</a></div><div class="ttdeci">T sortValue</div><div class="ttdef"><b>Definition:</b> algebra_misc.h:62</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_80abd05104fe5ed4636c8ba64911e654.html">ugbase</a></li><li class="navelem"><a class="el" href="dir_2e5eee3e6a2607df2611cb3dc665a6d5.html">lib_algebra</a></li><li class="navelem"><a class="el" href="dir_9fdf4f342cc07025dbdfefd76744846a.html">cpu_algebra</a></li><li class="navelem"><a class="el" href="algebra__misc_8h.html">algebra_misc.h</a></li>
<li class="footer">Generated on Mon Jan 6 2025 01:15:08 for ug4 by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>