-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplanets_8h_source.html
299 lines (297 loc) · 31.5 KB
/
planets_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
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
<!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/planets.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">planets.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 AETHER_INCLUDE_PLANETS_H_</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define AETHER_INCLUDE_PLANETS_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"> * A class for keeping track of all of the planetary characteristics</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"> *</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>  </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#include <string></span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#include <vector></span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  </div>
<div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="classPlanets.html"> 16</a></span> <span class="keyword">class </span><a class="code" href="classPlanets.html">Planets</a> {</div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">// Public functions and variables</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  <span class="comment">// --------------------------------------------------------------------</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <span class="comment">// Functions:</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> \brief Initialize the Planet class</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> \param args info about how user has configured things</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> \param report allow reporting to occur</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>  <a class="code" href="classPlanets.html">Planets</a>(<a class="code" href="classInputs.html">Inputs</a> args, <a class="code" href="classReport.html">Report</a> report);</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="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> \brief Returns the distance from the star to the planet being modeled</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> \param time needed for getting the current time in different formats</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  precision_t get_star_to_planet_dist(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</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> <span class="comment"> \brief Returns the orbit angle of the planet around the star</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> \param time needed for getting the current time in different formats</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>  precision_t get_orbit_angle(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> \brief Returns the declination angle of the planet (zero = equinox)</span></div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> \param time needed for getting the current time in different formats</span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> \param</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  precision_t get_declination(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> \brief Gets mu, which is planet mass times gravitational constant</span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  precision_t get_mu();</div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> \brief Returns radius of the planet, which can be a function of latitude</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"></span> </div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> currently, this ignores the latitude, but should be implemented.</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"> \param latitude the latitude to get the radius at.</span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  precision_t get_radius(precision_t latitude);</div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> \brief Returns the longitude offset to convert from longitude to local time</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"></span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> this function returns a value that when added to the longitude (in</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> radians) will provide the local time (in radians)</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="comment"> \param time needed for getting the current time in different formats</span></div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  precision_t get_longitude_offset(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> \brief Returns the sin of the planet's declination angle</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> \param time needed for getting the current time in different formats</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  precision_t get_sin_dec(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</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="comment"> \brief Returns the cos of the planet's declination angle</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> \param time needed for getting the current time in different formats</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>  precision_t get_cos_dec(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  </div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> \brief Returns the location of the center of the dipole (in meters)</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::vector<float> get_dipole_center();</div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"> \brief Returns the rotation angle of the dipole in longitude (radians)</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  precision_t get_dipole_rotation();</div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  </div>
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> <span class="comment"> \brief Returns the tilt angle of the dipole (co-latitude) (radians)</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>  precision_t get_dipole_tilt();</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 Returns the strength of the dipole at the surface (in nT)</span></div>
<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  precision_t get_dipole_strength();</div>
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  </div>
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment">// Private functions and variables</span></div>
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment">// -----------------------------------------------------------------------</span></div>
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span>  </div>
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  <span class="keyword">private</span>:</div>
<div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  </div>
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  <span class="keyword">struct </span>planet_chars {</div>
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div>
<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment">// ---------------------------------------</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span>  <span class="comment">// These are set by an input file:</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div>
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  std::string name;</div>
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  </div>
<div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  precision_t semimajoraxis;</div>
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  precision_t eccentricity;</div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  precision_t inclination;</div>
<div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  precision_t meanlongitude;</div>
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span>  precision_t perihelionlongitude;</div>
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  precision_t nodelongitude;</div>
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span>  </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>  precision_t rates_semimajoraxis;</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>  precision_t rates_eccentricity;</div>
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  precision_t rates_inclination;</div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  precision_t rates_meanlongitude;</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  precision_t rates_perihelionlongitude;</div>
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  precision_t rates_nodelongitude;</div>
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  </div>
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  precision_t planet_tilt;</div>
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  </div>
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  precision_t rotation_period;</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  precision_t omega;</div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  precision_t length_of_day;</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">double</span> length_of_year;</div>
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  precision_t longitude_jb2000;</div>
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span>  </div>
<div class="line"><a name="l00169"></a><span class="lineno"> 169</span>  precision_t mass;</div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>  precision_t mu;</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  precision_t equator_radius;</div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>  precision_t polar_radius;</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  precision_t radius;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  precision_t dipole_strength;</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>  precision_t dipole_rotation;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  precision_t dipole_tilt;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  std::vector<float> dipole_center{ 0.0, 0.0, 0.0 };</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>  </div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  <span class="comment">// ---------------------------------------</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>  <span class="comment">// These are updated during the run:</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  precision_t declination, sin_dec, cos_dec;</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  precision_t longitude_offset;</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  precision_t star_planet_distance;</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  precision_t orbit_angle;</div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  precision_t ls;</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  </div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  <span class="keywordtype">double</span> update_time;</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  };</div>
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  </div>
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  std::vector<planet_chars> planets;</div>
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  </div>
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  planet_chars planet;</div>
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  </div>
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  <span class="comment">// --------------------------------------------------------------------</span></div>
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="comment">// Functions:</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  </div>
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> \brief Sets the planetary characterists for the chosen planet</span></div>
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"></span> </div>
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="comment"> This function just copies over the chosen planet's characteristics</span></div>
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"> from the vector into the stand-alone structure.</span></div>
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment"></span> </div>
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> \param input info about how user has configured things</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> \param report allow reporting to occur</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  <span class="keywordtype">int</span> set_planet(<a class="code" href="classInputs.html">Inputs</a> args, <a class="code" href="classReport.html">Report</a> report);</div>
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  </div>
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment"> \brief Updates the planetary characteristics that depend on time</span></div>
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"></span> </div>
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> time is needed in a variety of formats, since many of the</span></div>
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> calculations require different time formats.</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"></span> </div>
<div class="line"><a name="l00234"></a><span class="lineno"> 234</span> <span class="comment"> \param time needed for getting the current time in different formats</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span>  <span class="keywordtype">int</span> update(<a class="code" href="classTimes.html">Times</a> time);</div>
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span>  </div>
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> /**********************************************************************</span></div>
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> \brief Reads in the planetary characteristics and stores them</span></div>
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> \param args info about how user has configured things</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"> 241</span> <span class="comment"> \param report allow reporting to occur</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"> **/</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span>  <span class="keywordtype">int</span> read_file(<a class="code" href="classInputs.html">Inputs</a> args, <a class="code" href="classReport.html">Report</a> report);</div>
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> };</div>
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span>  </div>
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="preprocessor">#endif // INCLUDE_PLANETS_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="aclassPlanets_html"><div class="ttname"><a href="classPlanets.html">Planets</a></div><div class="ttdef"><b>Definition:</b> planets.h:16</div></div>
<div class="ttc" id="aclassInputs_html"><div class="ttname"><a href="classInputs.html">Inputs</a></div><div class="ttdef"><b>Definition:</b> inputs.h:10</div></div>
<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>
<div class="ttc" id="aclassTimes_html"><div class="ttname"><a href="classTimes.html">Times</a></div><div class="ttdef"><b>Definition:</b> times.h:21</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>