HTML Users Guide
This commit is contained in:
105
doc/html/_status_page.html
Normal file
105
doc/html/_status_page.html
Normal file
@@ -0,0 +1,105 @@
|
||||
<!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.16"/>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||||
<title>EPANET: [STATUS]</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>
|
||||
<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">EPANET
|
||||
 <span id="projectnumber">2.2.0</span>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!-- end header part -->
|
||||
<!-- Generated by Doxygen 1.8.16 -->
|
||||
<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="_files.html">Toolkit Files</a></li><li class="navelem"><a class="el" href="_inp_file.html">Input File</a></li> </ul>
|
||||
</div>
|
||||
</div><!-- top -->
|
||||
<div class="PageDoc"><div class="header">
|
||||
<div class="headertitle">
|
||||
<div class="title">[STATUS] </div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><p><b>Purpose:</b></p>
|
||||
<p>Defines initial status of selected links at the start of a simulation.</p>
|
||||
<p><b>Format:</b></p>
|
||||
<p>One line per link being controlled containing:</p><ul>
|
||||
<li>Link ID label</li>
|
||||
<li>Status or setting</li>
|
||||
</ul>
|
||||
<p><b>Remarks:</b></p><ol type="1">
|
||||
<li>Links not listed in this section have a default status of <b>OPEN</b> (for pipes and pumps) or <b>ACTIVE</b> (for valves).</li>
|
||||
<li>The Status value assigned in this section can be <b>OPEN</b> or <b>CLOSED</b>. For control valves (e.g., PRVs, FCVs, etc.) this means that the valve is either fully opened or closed, not active at its control setting.</li>
|
||||
<li>The Setting value can be a speed setting for pumps or valve setting for valves.</li>
|
||||
<li>The initial status of pipes can also be set in the <a class="el" href="_pipes_page.html">[PIPES]</a> section.</li>
|
||||
<li>Check valves cannot have their status be preset.</li>
|
||||
<li>Use <a class="el" href="_ctrls_page.html">[CONTROLS]</a> or <a class="el" href="_rules_page.html">[RULES]</a> to change status or setting at some future point in the simulation.</li>
|
||||
<li>If a <b>CLOSED</b> or <b>OPEN</b> control valve is to become <b>ACTIVE</b> again, then its pressure or flow setting must be specified in the control or rule that reactivates it.</li>
|
||||
</ol>
|
||||
<p><b>Example:</b> </p><div class="fragment"><div class="line">[STATUS] </div>
|
||||
<div class="line">; Link Status/Setting </div>
|
||||
<div class="line">;---------------------- </div>
|
||||
<div class="line"> L22 CLOSED ;Link L22 is closed </div>
|
||||
<div class="line"> P14 1.5 ;Speed <span class="keywordflow">for</span> pump P14 </div>
|
||||
<div class="line"> PRV1 OPEN ;PRV1 forced open </div>
|
||||
<div class="line"> ;(overrides normal operation)</div>
|
||||
</div><!-- fragment --> </div></div><!-- contents -->
|
||||
</div><!-- PageDoc -->
|
||||
<!-- 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.16
|
||||
</small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user