-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreport_8h_source.html
236 lines (234 loc) · 23.9 KB
/
report_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
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
<!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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Aether: include/report.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="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="https://cdn.jsdelivr.net/npm/mathjax@2/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">Aether
 <span id="projectnumber">0.0</span>
</div>
<div id="projectbrief">Ionosphere-Thermosphere model</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">report.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">// Copyright 2020, the Aether Development Team (see doc/dev_team.md for members)</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">// Full license can be found in License.md</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#ifndef INCLUDE_REPORT_H_</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define INCLUDE_REPORT_H_</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">/**************************************************************</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * \class Report </span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * \brief A system for reporting within the program</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"> This class allows users to manage reporting information to the</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> user, including debugging information (through a verbose level) and</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> timing information for parts of the code. There are functions for</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> capturing when the code goes into and out of a function to allow</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> for code tracing and timing.</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"> * \author Aaron Ridley</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * \date 2021/04/16 </span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> **************************************************************/</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include "aether.h"</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="classReport.html"> 28</a></span> <span class="keyword">class </span><a class="code" href="classReport.html">Report</a> {</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment">// Public functions and variables</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  </div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment">// Functions:</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> \brief Initialize all of the internal variables.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <a class="code" href="classReport.html">Report</a>();</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="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> \brief This sets the global verbose level of the code</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> The verbose level sets the amount of information presented to the</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> user of the code. Some thoughts on levels:</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> 0 - essentially only report timing information</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> 1 - report only broadest level of detail</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> 2 - report going in and out of functions, and maybe things that are </span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> done once per iteration</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> 3-4 - Once per iteration types of outputs. More details at higher levels</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> 5+ - get into grid iterations. Produces a HUGE amount of info.</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span> </div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> This verbose level should be set only on one processor. All other</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> processors should be set to -1.</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"></span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> \param input global verbose level to set the code.</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">void</span> set_verbose(<span class="keywordtype">int</span> input);</div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  </div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> \brief How deep to go in the timing report at the end of the run</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> \param input the timing depth to be set for the code</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="keywordtype">void</span> set_timing_depth(<span class="keywordtype">int</span> input);</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> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> \brief Print message if iLevel <= verbose level of code</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> \param iLevel test against verbose level of the code</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> \param output_string string to output if iLevel <= verbose level</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>  <span class="keywordtype">void</span> print(<span class="keywordtype">int</span> iLevel, std::string output_string);</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> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> \brief Returns 1 if iLevel <= verbose level of code, 0 otherwise</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> \param iLevel test against verbose level of the code</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">int</span> test_verbose(<span class="keywordtype">int</span> iLevel);</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  </div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> \brief Returns the global verbosity of the code</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">int</span> get_verbose();</div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment"> \brief Starts timer and reports when entering a function, if applicable</span></div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"></span> </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> This is typically placed at the start of a function. This function</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> does the following:</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> - Figures out the depth of the function (which is compared to verbose level)</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"> - Reports that it has entered function if the verbose level is high enough</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment"> - Starts a timer</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> - Records the name of the function and number of the function for exit.</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> </div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> \param function_name The name of the function that is being entered</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> \param iFunction first time entered, this should be -1 or something, </span></div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> then this is altered to be the number of the function. </span></div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> when the function is called again, this number saves </span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> a string compare</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">void</span> enter(std::string function_name, <span class="keywordtype">int</span> &iFunction);</div>
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> \brief End the timer and reports exiting the function, see enter above</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> \param function_name The name of the function that is being exited</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  <span class="keywordtype">void</span> exit(std::string function_name);</div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> /**************************************************************</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> \brief Loop through all reported functions and report their run times</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keywordtype">void</span> times();</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">// Private functions and variables</span></div>
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="keywordtype">int</span> iVerbose;</div>
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  <span class="keywordtype">int</span> iTimingDepth;</div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div>
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  <span class="keyword">struct </span>item_struct {</div>
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  std::string entry;</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  <span class="keywordtype">int</span> nTimes;</div>
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  precision_t timing_total;</div>
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> timing_start;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  <span class="keywordtype">int</span> iLevel;</div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  <span class="keywordtype">int</span> iStringPosBefore;</div>
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  <span class="keywordtype">int</span> iLastEntry;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  };</div>
<div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  std::vector<item_struct> entries;</div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">int</span> nEntries;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  std::string current_entry;</div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordtype">int</span> iCurrentFunction = -1;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  std::string divider;</div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  <span class="keywordtype">int</span> divider_length;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  </div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  <span class="keywordtype">int</span> iLevel;</div>
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  </div>
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  <span class="keywordtype">bool</span> DoReportOnExit = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> };</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="preprocessor">#endif // INCLUDE_REPORT_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassReport_html"><div class="ttname"><a href="classReport.html">Report</a></div><div class="ttdef"><b>Definition:</b> report.h:28</div></div>
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>