-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathNCFile_8cpp.html
197 lines (193 loc) · 10.4 KB
/
NCFile_8cpp.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
<!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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>REMORA: /home/runner/work/REMORA/REMORA/Source/IO/NCFile.cpp File Reference</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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>
<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">REMORA
</div>
<div id="projectbrief">Energy Research and Forecasting: An Atmospheric Modeling Code</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<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','.html');
/* @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>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('NCFile_8cpp.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">NCFile.cpp File Reference</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include <string></code><br />
<code>#include "<a class="el" href="NCFile_8H_source.html">NCFile.H</a>"</code><br />
<code>#include "<a class="el" href="NCInterface_8H_source.html">NCInterface.H</a>"</code><br />
</div><div class="textblock"><div class="dynheader">
Include dependency graph for NCFile.cpp:</div>
<div class="dyncontent">
<div class="center"><img src="NCFile_8cpp__incl.png" border="0" usemap="#a_2home_2runner_2work_2REMORA_2REMORA_2Source_2IO_2NCFile_8cpp" alt=""/></div>
<map name="a_2home_2runner_2work_2REMORA_2REMORA_2Source_2IO_2NCFile_8cpp" id="a_2home_2runner_2work_2REMORA_2REMORA_2Source_2IO_2NCFile_8cpp">
<area shape="rect" title=" " alt="" coords="175,5,398,47"/>
<area shape="rect" title=" " alt="" coords="5,244,64,271"/>
<area shape="rect" href="NCFile_8H.html" title=" " alt="" coords="247,95,326,121"/>
<area shape="rect" href="NCInterface_8H.html" title=" " alt="" coords="705,169,818,196"/>
<area shape="rect" title=" " alt="" coords="72,169,147,196"/>
<area shape="rect" title=" " alt="" coords="171,169,229,196"/>
<area shape="rect" title=" " alt="" coords="253,169,320,196"/>
<area shape="rect" title=" " alt="" coords="345,169,501,196"/>
<area shape="rect" title=" " alt="" coords="525,169,680,196"/>
<area shape="rect" title=" " alt="" coords="535,244,659,271"/>
<area shape="rect" title=" " alt="" coords="683,244,746,271"/>
<area shape="rect" title=" " alt="" coords="771,244,845,271"/>
<area shape="rect" title=" " alt="" coords="870,244,973,271"/>
</map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:af8eb0b5eb41bbbf48a6dbced8cd0d6ea"><td class="memItemLeft" align="right" valign="top">std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="NCFile_8cpp.html#af8eb0b5eb41bbbf48a6dbced8cd0d6ea">ReadNetCDFVarAttrStr</a> (const std::string &fname, const std::string &var_name, const std::string &attr_name)</td></tr>
<tr class="separator:af8eb0b5eb41bbbf48a6dbced8cd0d6ea"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="af8eb0b5eb41bbbf48a6dbced8cd0d6ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af8eb0b5eb41bbbf48a6dbced8cd0d6ea">◆ </a></span>ReadNetCDFVarAttrStr()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::string ReadNetCDFVarAttrStr </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>fname</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>var_name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>attr_name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Helper function for reading a single variable attribute</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fname</td><td>Name of NetCDF file </td></tr>
<tr><td class="paramname">var_name</td><td>Name of variable </td></tr>
<tr><td class="paramname">attr_name</td><td>Name of attribute to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>attribute value </dd></dl>
<div class="fragment"><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> {</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  std::string attr_val;</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>  <span class="keywordflow">if</span> (amrex::ParallelDescriptor::IOProcessor())</div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  {</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  <span class="keyword">auto</span> ncf = <a class="code" href="classncutils_1_1NCFile.html#a2881b70e450e11f01b474c538b8d6885">ncutils::NCFile::open</a>(fname, NC_CLOBBER | NC_NETCDF4);</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>  attr_val = ncf.var(var_name).get_attr(attr_name);</div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  ncf.close();</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="keywordflow">return</span> attr_val;</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> }</div>
<div class="ttc" id="aclassncutils_1_1NCFile_html_a2881b70e450e11f01b474c538b8d6885"><div class="ttname"><a href="classncutils_1_1NCFile.html#a2881b70e450e11f01b474c538b8d6885">ncutils::NCFile::open</a></div><div class="ttdeci">static NCFile open(const std::string &name, const int cmode=NC_NOWRITE)</div><div class="ttdef"><b>Definition:</b> NCInterface.cpp:577</div></div>
</div><!-- fragment --><div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><img src="NCFile_8cpp_af8eb0b5eb41bbbf48a6dbced8cd0d6ea_cgraph.png" border="0" usemap="#aNCFile_8cpp_af8eb0b5eb41bbbf48a6dbced8cd0d6ea_cgraph" alt=""/></div>
<map name="aNCFile_8cpp_af8eb0b5eb41bbbf48a6dbced8cd0d6ea_cgraph" id="aNCFile_8cpp_af8eb0b5eb41bbbf48a6dbced8cd0d6ea_cgraph">
<area shape="rect" title=" " alt="" coords="5,31,173,57"/>
<area shape="rect" href="classncutils_1_1NCFile.html#a2881b70e450e11f01b474c538b8d6885" title=" " alt="" coords="221,31,376,57"/>
<area shape="rect" href="classncutils_1_1NCGroup.html#a3d53c2f625cc6fc286e76c9137b5b1b0" title="Name of this group." alt="" coords="424,5,600,32"/>
<area shape="rect" href="classncutils_1_1NCFile.html#aec0e1a7f0f93f2f806c0a0abaae66423" title=" " alt="" coords="429,56,595,83"/>
</map>
</div>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_74389ed8173ad57b461b9d623a1f3867.html">Source</a></li><li class="navelem"><a class="el" href="dir_4c48f420b74c1f1cc31b316243ca788c.html">IO</a></li><li class="navelem"><a class="el" href="NCFile_8cpp.html">NCFile.cpp</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
</ul>
</div>
</body>
</html>