-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathread__indices__files_8h_source.html
157 lines (155 loc) · 13.7 KB
/
read__indices__files_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
<!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/read_indices_files.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">read_indices_files.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_READ_INDICES_H_</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#define INCLUDE_READ_INDICES_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 set of routines to read in a number of different indices</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * files, including the NGDC F10.7 files, and OMNIWeb files.</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>  </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#include <vector></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>  </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#include "aether.h"</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</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"> \brief Reads in all of the indices files and stores them in Indices</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"> This function goes through all of the input indices files and </span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> reads in the files, then stores the values into the Indices class.</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> At this point, it can read in the following file types:</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> 1. NGDC F10.7 files.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> 2. OMNIWeb files that include IMF, Solar Wind, and/or AE/AU/AL.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"></span> </div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> \param indices the indices class</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> \param args info about how user has configured things</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> \param report allow reporting to occur</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">**/</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="keywordtype">int</span> read_and_store_indices(<a class="code" href="classIndices.html">Indices</a> &indices, <a class="code" href="classInputs.html">Inputs</a> args, <a class="code" href="classReport.html">Report</a> &report);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</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> <span class="comment"> \brief Read the NGDC F10.7 file format and store in the index_file struct</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> \param f107_file the f10.7 file to read in</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> \param report allow reporting to occur</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">**/</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <a class="code" href="structindex__file__output__struct.html">index_file_output_struct</a> read_f107_file(std::string f107_file,</div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classIndices.html">Indices</a> indices,</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <a class="code" href="classReport.html">Report</a> &report);</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/**********************************************************************</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> \brief Read the OMNIWeb file format and store in the index_file struct</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> \param omni_file the onmiweb file to read</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> \param indices needed to get the indices index for each variable</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"> \param report allow reporting to occur</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> <a class="code" href="structindex__file__output__struct.html">index_file_output_struct</a> read_omni_file(std::string omni_file,</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classIndices.html">Indices</a> indices,</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <a class="code" href="classReport.html">Report</a> &report);</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment">/**********************************************************************</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"> \brief This code compares a string to return the variable index</span></div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="comment"> \param variable_name the name of the variable to match with for OMNIWeb files</span></div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> \param indices needed to get the indices index for each variable</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> <span class="keywordtype">int</span> pair_omniweb_index(std::string, <a class="code" href="classIndices.html">Indices</a> index);</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 This code returns the missing value for a given OMNIWeb variable</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> \param variable_name the name of the variable to get the OMNIWeb missing value</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">**/</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> precision_t get_omniweb_missing_value(std::string);</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#endif // INCLUDE_READ_INDICES_H_</span></div>
</div><!-- fragment --></div><!-- contents -->
<div class="ttc" id="astructindex__file__output__struct_html"><div class="ttname"><a href="structindex__file__output__struct.html">index_file_output_struct</a></div><div class="ttdef"><b>Definition:</b> indices.h:33</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="aclassIndices_html"><div class="ttname"><a href="classIndices.html">Indices</a></div><div class="ttdef"><b>Definition:</b> indices.h:63</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>