-
Notifications
You must be signed in to change notification settings - Fork 0
/
group___hydraulic_functions.html
266 lines (254 loc) · 14.1 KB
/
group___hydraulic_functions.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
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.8"/>
<title>EPANET: Hydraulic Analysis</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="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</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 style="padding-left: 0.5em;">
<div id="projectname">EPANET
 <span id="projectnumber">2.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</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">
$(document).ready(function(){initNavTree('group___hydraulic_functions.html','');});
</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)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Modules</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Pages</a></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">Hydraulic Analysis</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gace66aad32f79c40b0da459d60ab4ef4a"><td class="memItemLeft" align="right" valign="top">int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#gace66aad32f79c40b0da459d60ab4ef4a">ENsolveH</a> ()</td></tr>
<tr class="memdesc:gace66aad32f79c40b0da459d60ab4ef4a"><td class="mdescLeft"> </td><td class="mdescRight">Solves the network hydraulics for all time periods. <a href="#gace66aad32f79c40b0da459d60ab4ef4a">More...</a><br /></td></tr>
<tr class="separator:gace66aad32f79c40b0da459d60ab4ef4a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga52c012b09cd536f46eea0d6903e16747"><td class="memItemLeft" align="right" valign="top">int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#ga52c012b09cd536f46eea0d6903e16747">ENsaveH</a> ()</td></tr>
<tr class="memdesc:ga52c012b09cd536f46eea0d6903e16747"><td class="mdescLeft"> </td><td class="mdescRight">Saves hydraulic results to binary file. <a href="#ga52c012b09cd536f46eea0d6903e16747">More...</a><br /></td></tr>
<tr class="separator:ga52c012b09cd536f46eea0d6903e16747"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaac0286dd4bbd7f4183f94bfed25f3b45"><td class="memItemLeft" align="right" valign="top">int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#gaac0286dd4bbd7f4183f94bfed25f3b45">ENopenH</a> ()</td></tr>
<tr class="memdesc:gaac0286dd4bbd7f4183f94bfed25f3b45"><td class="mdescLeft"> </td><td class="mdescRight">Sets up data structures for hydraulic analysis. <a href="#gaac0286dd4bbd7f4183f94bfed25f3b45">More...</a><br /></td></tr>
<tr class="separator:gaac0286dd4bbd7f4183f94bfed25f3b45"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gace15165dac61f3180e770cf406281b61"><td class="memItemLeft" align="right" valign="top">int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#gace15165dac61f3180e770cf406281b61">ENinitH</a> (int initFlag)</td></tr>
<tr class="memdesc:gace15165dac61f3180e770cf406281b61"><td class="mdescLeft"> </td><td class="mdescRight">Initializes hydraulic analysis. <a href="#gace15165dac61f3180e770cf406281b61">More...</a><br /></td></tr>
<tr class="separator:gace15165dac61f3180e770cf406281b61"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad45bda3e7bbdfc54160847bf4c8c72e5"><td class="memItemLeft" align="right" valign="top">int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#gad45bda3e7bbdfc54160847bf4c8c72e5">ENrunH</a> (long *currentTime)</td></tr>
<tr class="memdesc:gad45bda3e7bbdfc54160847bf4c8c72e5"><td class="mdescLeft"> </td><td class="mdescRight">Run a hydraulic solution period. <a href="#gad45bda3e7bbdfc54160847bf4c8c72e5">More...</a><br /></td></tr>
<tr class="separator:gad45bda3e7bbdfc54160847bf4c8c72e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ac0044292927b47c6c4aa4bfa0f7b23"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ac0044292927b47c6c4aa4bfa0f7b23"></a>
int DLLEXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="group___hydraulic_functions.html#ga5ac0044292927b47c6c4aa4bfa0f7b23">ENnextH</a> (long *tStep)</td></tr>
<tr class="memdesc:ga5ac0044292927b47c6c4aa4bfa0f7b23"><td class="mdescLeft"> </td><td class="mdescRight">Determine time (in seconds) until next hydraulic event. <br /></td></tr>
<tr class="separator:ga5ac0044292927b47c6c4aa4bfa0f7b23"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="fragment"><div class="line"><span class="keywordtype">int</span> errcode;</div>
<div class="line"><span class="keywordtype">long</span> t, tstep;</div>
<div class="line"></div>
<div class="line">errcode = <a class="code" href="group___hydraulic_functions.html#gaac0286dd4bbd7f4183f94bfed25f3b45">ENopenH</a>();</div>
<div class="line"><span class="keywordflow">if</span> (!errcode)</div>
<div class="line">{</div>
<div class="line"> errcode = <a class="code" href="group___hydraulic_functions.html#gace15165dac61f3180e770cf406281b61">ENinitH</a>(EN_SAVE);</div>
<div class="line"> <span class="keywordflow">if</span> (!errcode) <span class="keywordflow">do</span></div>
<div class="line"> {</div>
<div class="line"> tstep = 0;</div>
<div class="line"> ERRCODE(<a class="code" href="group___hydraulic_functions.html#gad45bda3e7bbdfc54160847bf4c8c72e5">ENrunH</a>(&t));</div>
<div class="line"> ERRCODE(<a class="code" href="group___hydraulic_functions.html#ga5ac0044292927b47c6c4aa4bfa0f7b23">ENnextH</a>(&tstep));</div>
<div class="line"> }</div>
<div class="line"> <span class="keywordflow">while</span> (tstep > 0);</div>
<div class="line">}</div>
<div class="line"></div>
<div class="line">ENcloseH();</div>
</div><!-- fragment --> <h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gace15165dac61f3180e770cf406281b61"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DLLEXPORT ENinitH </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>initFlag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initializes hydraulic analysis. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>2-digit flag where 1st (left) digit indicates if link flows should be re-initialized (1) or not (0), and 2nd digit indicates if hydraulic results should be saved to file (1) or not (0). </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Error code </dd></dl>
</div>
</div>
<a class="anchor" id="gaac0286dd4bbd7f4183f94bfed25f3b45"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DLLEXPORT ENopenH </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets up data structures for hydraulic analysis. </p>
<dl class="section return"><dt>Returns</dt><dd>Error code </dd></dl>
</div>
</div>
<a class="anchor" id="gad45bda3e7bbdfc54160847bf4c8c72e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DLLEXPORT ENrunH </td>
<td>(</td>
<td class="paramtype">long * </td>
<td class="paramname"><em>currentTime</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run a hydraulic solution period. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">currentTime</td><td>The current simulation time in seconds </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Error or warning code</dd></dl>
<p>This function is used in a loop with <a class="el" href="group___hydraulic_functions.html#ga5ac0044292927b47c6c4aa4bfa0f7b23" title="Determine time (in seconds) until next hydraulic event. ">ENnextH()</a> to run an extended period hydraulic simulation. See <a class="el" href="group___hydraulic_functions.html#gace66aad32f79c40b0da459d60ab4ef4a" title="Solves the network hydraulics for all time periods. ">ENsolveH()</a> for an example.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group___hydraulic_functions.html#gace66aad32f79c40b0da459d60ab4ef4a" title="Solves the network hydraulics for all time periods. ">ENsolveH</a> </dd></dl>
</div>
</div>
<a class="anchor" id="ga52c012b09cd536f46eea0d6903e16747"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DLLEXPORT ENsaveH </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Saves hydraulic results to binary file. </p>
<dl class="section return"><dt>Returns</dt><dd>Error code</dd></dl>
<p>Must be called before ENreport() if no WQ simulation has been made. Should not be called if ENsolveQ() will be used. </p>
</div>
</div>
<a class="anchor" id="gace66aad32f79c40b0da459d60ab4ef4a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int DLLEXPORT ENsolveH </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Solves the network hydraulics for all time periods. </p>
<dl class="section return"><dt>Returns</dt><dd>Error code </dd></dl>
</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="footer">Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>