JIANG/EPANET
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity

HTML Users Guide

Browse Source
This commit is contained in:
Demetrios G. Eliades
2019-11-21 16:58:18 +02:00
parent 3259a8c1e1
commit c16c861789
183 changed files with 11796 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

146
doc/html/_condition_clauses.html Normal file
View File

@@ -0,0 +1,146 @@
<!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: Condition Clauses</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
&#160;<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&amp;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&amp;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><li class="navelem"><a class="el" href="_rules_page.html">[RULES]</a></li> </ul>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">Condition Clauses </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>A condition clause in a <a class="el" href="_rules_page.html">Rule-Based Control</a> takes the form of:</p>
<p>&#160;&#160;<em>object &#160;id &#160;attribute &#160;relation &#160;value</em> <br />
</p>
<p>where </p><table style="border: 0px solid black">
<tr>
<td><em>object &#160; &#160;</em> </td><td>= </td><td>&#160; a category of network object </td></tr>
<tr>
<td><em>id &#160; &#160;</em> </td><td>= </td><td>&#160; the object's ID label </td></tr>
<tr>
<td><em>attribute &#160;</em> </td><td>= </td><td>&#160; an attribute or property of the object </td></tr>
<tr>
<td><em>relation &#160;&#160;</em> </td><td>= </td><td>&#160; a relational operator </td></tr>
<tr>
<td><em>value &#160; &#160;</em> </td><td>= </td><td>&#160; an attribute value </td></tr>
</table>
<p>Some example conditional clauses are:<br />
<code>&#160;&#160;JUNCTION 23 PRESSURE &gt; 20</code> <br />
<code>&#160;&#160;TANK T200 FILLTIME BELOW 3.5</code> <br />
<code>&#160;&#160;LINK 44 STATUS IS OPEN</code> <br />
<code>&#160;&#160;SYSTEM CLOCKTIME = 7:30 AM</code> <br />
<code>&#160;&#160;SYSTEM DEMAND &gt;= 1500</code> <br />
</p>
<p>Objects can be any of the following keywords:<br />
<b>&#160;&#160;NODE&#160;&#160;JUNCTION&#160;&#160;TANK&#160;&#160;RESERVOIR</b><br />
<b>&#160;&#160;LINK&#160;&#160;PIPE&#160;&#160;PUMP&#160;&#160;VALVE</b><br />
<b>&#160;&#160;SYSTEM</b></p>
<p>When <b>SYSTEM</b> is used in a condition no ID is supplied.</p>
<p>The following attributes can be used with Node-type objects: <br />
<b>&#160;&#160; DEMAND</b><br />
<b>&#160;&#160; HEAD</b><br />
<b>&#160;&#160; PRESSURE</b></p>
<p>The following attributes can be used with Tanks: <br />
<b>&#160;&#160; LEVEL</b><br />
<b>&#160;&#160; FILLTIME&#160;</b> (hours needed to fill a tank) <br />
<b>&#160;&#160; DRAINTIME</b> (hours needed to empty a tank)</p>
<p>These attributes can be used with Link-Type objects: <br />
<b>&#160;&#160; FLOW</b><br />
<b>&#160;&#160; STATUS&#160; (OPEN, CLOSED, or ACTIVE)</b> <br />
<b>&#160;&#160; SETTING&#160;</b> (pump speed or valve setting)</p>
<p>The <b>SYSTEM</b> object can use the following attributes: </p><table style="border: 0px solid black">
<tr>
<td><b>&#160;&#160; DEMAND</b></td><td>(total system demand) </td></tr>
<tr>
<td><b>&#160;&#160; TIME</b></td><td>(hours from the start of the simulation expressed </td></tr>
<tr>
<td><b>&#160;&#160; </b></td><td>either as a decimal number or in hours:minutes format) </td></tr>
<tr>
<td><b>&#160;&#160; CLOCKTIME</b></td><td>&#160;(24-hour clock time with <b>AM</b> or <b>PM</b> appended) </td></tr>
</table>
<p>Relation operators consist of the following: <br />
</p><table style="border: 0px solid black">
<tr>
<td>&#160;&#160;<b>=</b> </td><td><b>IS</b> </td></tr>
<tr>
<td>&#160;&#160;<b>&lt;&gt;</b> </td><td><b>NOT</b> </td></tr>
<tr>
<td>&#160;&#160;<b>&lt;</b> </td><td><b>BELOW</b> </td></tr>
<tr>
<td>&#160;&#160;<b>&gt;</b> </td><td><b>ABOVE</b> </td></tr>
<tr>
<td>&#160;&#160;<b>&lt;=</b> </td></tr>
<tr>
<td>&#160;&#160;<b>&gt;=</b> </td></tr>
</table>
</div></div><!-- contents -->
</div><!-- PageDoc -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.16
</small></address>
</body>
</html>