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

History

199 lines (197 loc) · 17.8 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

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

<head>

<title>Aether: include/inputs.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 class="title">inputs.h</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_INPUTS_H_</span></div>

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

<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="preprocessor">#include <vector></span></div>

<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include <string></span></div>

<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="classInputs.html"> 10</a></span> <span class="keyword">class </span><a class="code" href="classInputs.html">Inputs</a> {</div>

<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="keyword">public</span>:</div>

<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <a class="code" href="classInputs.html">Inputs</a>(<a class="code" href="classTimes.html">Times</a> &time, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  <span class="keywordtype">int</span> read(<a class="code" href="classTimes.html">Times</a> &time, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  json read_json(std::string json_file);</div>

<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <span class="keywordtype">int</span> read_inputs_json(<a class="code" href="classTimes.html">Times</a> &time, <a class="code" href="classReport.html">Report</a> &report);</div>

<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <span class="keywordtype">int</span> get_verbose();</div>

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

<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>  precision_t get_dt_report();</div>

<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  precision_t get_n_outputs();</div>

<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>  precision_t get_dt_output(<span class="keywordtype">int</span> iOutput);</div>

<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  std::string get_type_output(<span class="keywordtype">int</span> iOutput);</div>

<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  precision_t get_euv_heating_eff_neutrals();</div>

<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  std::string get_euv_model();</div>

<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  std::string get_euv_file();</div>

<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  std::string get_aurora_file();</div>

<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  std::string get_chemistry_file();</div>

<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  std::vector<std::string> get_omniweb_files();</div>

<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>  <span class="keywordtype">int</span> get_number_of_omniweb_files();</div>

<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  std::string get_f107_file();</div>

<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  std::string get_planet();</div>

<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  std::string get_planetary_file();</div>

<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  std::string get_planet_species_file();</div>

<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  std::string get_collision_file();</div>

<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  std::string get_bfield_type();</div>

<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  std::string get_electrodynamics_file();</div>

<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="comment">// Grid inputs:</span></div>

<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structInputs_1_1grid__input__struct.html"> 42</a></span>  <span class="keyword">struct </span><a class="code" href="structInputs_1_1grid__input__struct.html">grid_input_struct</a> {</div>

<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  std::string alt_file;</div>

<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">bool</span> IsUniformAlt;</div>

<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  precision_t alt_min;</div>

<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  precision_t dalt;</div>

<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  precision_t lat_min;</div>

<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  precision_t lat_max;</div>

<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  precision_t lon_min;</div>

<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  precision_t lon_max;</div>

<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="structInputs_1_1grid__input__struct.html">grid_input_struct</a> get_grid_inputs();</div>

<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keywordtype">int</span> get_nLonsGeo();</div>

<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keywordtype">int</span> get_nLatsGeo();</div>

<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  <span class="keywordtype">int</span> get_nAltsGeo();</div>

<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="keywordtype">int</span> iVerbose;</div>

<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keywordtype">int</span> iTimingDepth;</div>

<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  std::string get_settings_str(std::string key1);</div>

<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  std::string get_settings_str(std::string key1, std::string key2);</div>

<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  std::vector<int> get_settings_timearr(std::string key1);</div>

<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  std::vector<int> get_settings_intarr(std::string key1);</div>

<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="keyword">private</span>:</div>

<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  json settings;</div>

<div class="line"><a name="l00071"></a><span class="lineno"> 71</span>  std::string euv_file = <span class="stringliteral">"UA/inputs/euv.csv"</span>;</div>

<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  std::string aurora_file = <span class="stringliteral">"UA/inputs/aurora_earth.csv"</span>;</div>

<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  std::string chemistry_file = <span class="stringliteral">"UA/inputs/chemistry_earth.csv"</span>;</div>

<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  std::string collision_file =</div>

<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="stringliteral">"UA/inputs/ion_neutral_collision_frequencies.csv"</span>;</div>

<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  std::string input_file = <span class="stringliteral">"aether.in"</span>;</div>

<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  std::string euv_model = <span class="stringliteral">"euvac"</span>;</div>

<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  std::string planetary_file = <span class="stringliteral">"UA/inputs/orbits.csv"</span>;</div>

<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  std::vector<std::string> omniweb_files;</div>

<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  std::string planet = <span class="stringliteral">"earth"</span>;</div>

<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  std::string f107_file = <span class="stringliteral">""</span>;</div>

<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  std::string planet_species_file = <span class="stringliteral">""</span>;</div>

<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  std::string electrodynamics_file = <span class="stringliteral">""</span>;</div>

<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  std::string bfield = <span class="stringliteral">"none"</span>;</div>

<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="structInputs_1_1grid__input__struct.html">grid_input_struct</a> geo_grid_input;</div>

<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  precision_t euv_heating_eff_neutrals;</div>

<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  precision_t euv_heating_eff_electrons;</div>

<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  std::vector<float> dt_output;</div>

<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  std::vector<std::string> type_output;</div>

<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  std::string output_directory = <span class="stringliteral">"UA/output"</span>;</div>

<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  std::string restart_out_directory = <span class="stringliteral">"UA/restartOut"</span>;</div>

<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  std::string restart_in_directory = <span class="stringliteral">"UA/restartIn"</span>;</div>

<div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  precision_t dt_euv;</div>

<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  precision_t dt_report;</div>

<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  <span class="keywordtype">int</span> nLonsGeo;</div>

<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  <span class="keywordtype">int</span> nLatsGeo;</div>

<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordtype">int</span> nAltsGeo;</div>

<div class="line"><a name="l00106"></a><span class="lineno"> 106</span> <span class="preprocessor">#endif // INCLUDE_INPUTS_H_</span></div>

</div></div>

<div class="ttc" id="astructInputs_1_1grid__input__struct_html"><div class="ttname"><a href="structInputs_1_1grid__input__struct.html">Inputs::grid_input_struct</a></div><div class="ttdef"><b>Definition:</b> inputs.h:42</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>

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

</a> 1.8.17

</small></address>

</body>

</html>

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

Uh oh!

Expand file tree

Breadcrumbs

inputs_8h_source.html

Latest commit

History

Breadcrumbs

inputs_8h_source.html

File metadata and controls