aethermodel.github.io/grid_8h_source.html at main · AetherModel/aethermodel.github.io · GitHub

History

209 lines (207 loc) · 18.9 KB

Raw

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

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<head>

<title>Aether: include/grid.h Source File</title>

MathJax.Hub.Config({

extensions: ["tex2jax.js"],

jax: ["input/TeX","output/HTML-CSS"],

});

</script>

</head>

<body>

<tbody>

<div id="projectname">Aether

</div>

<div id="projectbrief">Ionosphere-Thermosphere model</div>

</td>

</tr>

</tbody>

</table>

</div>

/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */

var searchBox = new SearchBox("searchBox", "search",false,'Search');

/* @license-end */

</script>

/* @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="MSearchSelectWindow"

onmouseover="return searchBox.OnSearchSelectShow()"

onmouseout="return searchBox.OnSearchSelectHide()"

onkeydown="return searchBox.OnSearchSelectKey(event)">

</div>

name="MSearchResults" id="MSearchResults">

</iframe>

</div>

<ul>

<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>

</div>

</div>

</div>

<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="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#ifndef INCLUDE_GRID_H_</span></div>

<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define INCLUDE_GRID_H_</span></div>

<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">// Grid class</span></div>

<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="keyword">class </span><a class="code" href="classGrid.html">Grid</a> {</div>

<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="keyword">public</span>:</div>

<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keywordtype">int</span> get_IsGeoGrid();</div>

<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  <span class="keywordtype">bool</span> get_HasBField();</div>

<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">void</span> set_IsGeoGrid(<span class="keywordtype">int</span> value);</div>

<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  int64_t get_nPointsInGrid();</div>

<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  int64_t get_nLons();</div>

<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  int64_t get_nLats();</div>

<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  int64_t get_nAlts();</div>

<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  <span class="comment">// Armidillo Cube Versions:</span></div>

<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  arma_cube geoLon_scgc, geoX_scgc;</div>

<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  arma_cube geoLat_scgc, geoY_scgc;</div>

<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  arma_cube geoAlt_scgc, geoZ_scgc;</div>

<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  arma_cube geoLocalTime_scgc;</div>

<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// These define the magnetic grid:</span></div>

<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="comment">// Armidillo Cube Versions:</span></div>

<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  arma_cube magLon_scgc, magX_scgc;</div>

<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  arma_cube magLat_scgc, magY_scgc;</div>

<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  arma_cube magAlt_scgc, magZ_scgc;</div>

<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  arma_cube magLocalTime_scgc;</div>

<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="comment">// These are the locations of the magnetic poles:</span></div>

<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="comment">// ll -> lat, lon, radius independent</span></div>

<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  arma_vec mag_pole_north_ll;</div>

<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  arma_vec mag_pole_south_ll;</div>

<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="comment">// pole gse -> needs to be for each altitude, so we can compute</span></div>

<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  <span class="comment">// magnetic local time. We want to use some GSE conversion function,</span></div>

<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <span class="comment">// so this type has to a vector of arma_cubes:</span></div>

<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  std::vector<arma_cube> mag_pole_north_gse;</div>

<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  std::vector<arma_cube> mag_pole_south_gse;</div>

<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  std::vector<arma_cube> GSE_XYZ_vcgc;</div>

<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  std::string altitude_name = <span class="stringliteral">"Altitude"</span>;</div>

<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  std::string altitude_unit = <span class="stringliteral">"meters"</span>;</div>

<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  std::string longitude_name = <span class="stringliteral">"Longitude"</span>;</div>

<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  std::string longitude_unit = <span class="stringliteral">"radians"</span>;</div>

<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::string latitude_name = <span class="stringliteral">"Latitude"</span>;</div>

<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::string latitude_unit = <span class="stringliteral">"radians"</span>;</div>

<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  <span class="comment">// These are derived variables from the grid:</span></div>

<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="comment">// Switch to armadillo variables (precision_t cubes):</span></div>

<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  arma_cube radius_scgc;</div>

<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  arma_cube radius2_scgc;</div>

<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  arma_cube radius2i_scgc;</div>

<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  arma_cube gravity_scgc;</div>

<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  arma_cube dalt_center_scgc;</div>

<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  arma_cube dalt_lower_scgc;</div>

<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  arma_cube dalt_ratio_scgc;</div>

<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  arma_cube dalt_ratio_sq_scgc;</div>

<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  arma_cube dlon_center_scgc;</div>

<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  arma_cube dlon_center_dist_scgc;</div>

<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  arma_cube dlat_center_scgc;</div>

<div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  arma_cube dlat_center_dist_scgc;</div>

<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  std::vector<arma_cube> bfield_vcgc;</div>

<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  arma_cube bfield_mag_scgc;</div>

<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  std::vector<arma_cube> bfield_unit_vcgc;</div>

<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  <span class="keywordtype">void</span> calc_sza(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classTimes.html">Times</a> time, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  <span class="keywordtype">void</span> calc_gse(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classTimes.html">Times</a> time, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  <span class="keywordtype">void</span> calc_mlt(<a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordtype">void</span> fill_grid(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordtype">void</span> fill_grid_radius(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordtype">void</span> init_geo_grid(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classInputs.html">Inputs</a> input, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  <span class="keywordtype">void</span> fill_grid_bfield(<a class="code" href="classPlanets.html">Planets</a> planet, <a class="code" href="classInputs.html">Inputs</a> input, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keyword">private</span>:</div>

<div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  <span class="keywordtype">int</span> IsGeoGrid;</div>

<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordtype">bool</span> HasBField;</div>

<div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  int64_t nX, nLons;</div>

<div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  int64_t nY, nLats;</div>

<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  int64_t nZ, nAlts;</div>

<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="keywordtype">int</span> nGCs; <span class="comment">// number of ghostcells</span></div>

<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif // INCLUDE_GRID_H_</span></div>

</div></div>

<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>

<div class="ttc" id="aclassGrid_html"><div class="ttname"><a href="classGrid.html">Grid</a></div><div class="ttdef"><b>Definition:</b> arm_vars.h:11</div></div>

Generated by  <a href="http://www.doxygen.org/index.html">

</a> 1.8.17

</small></address>

</body>

</html>

aethermodel.github.io/grid_8h_source.html at main · AetherModel/aethermodel.github.io · GitHub

Uh oh!

Expand file tree

Breadcrumbs

grid_8h_source.html

Latest commit

History

Breadcrumbs

grid_8h_source.html

File metadata and controls