Files
EPANET/doc/html/_ctrls_page.html
Demetrios G. Eliades c16c861789 HTML Users Guide
2019-11-21 16:58:18 +02:00

123 lines
5.3 KiB
HTML

<!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: [CONTROLS]</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> </ul>
</div>
</div><!-- top -->
<div class="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">[CONTROLS] </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Purpose:</b></p>
<p>Defines simple controls that modify links based on a single condition.<br />
</p>
<p><b>Format:</b></p>
<p>One line for each control which can be of the form:</p>
<p><b>&#160;&#160; LINK </b> <em>linkID</em> &#160;<em>status</em> &#160;<b>IF NODE &#160;</b> <em>nodeID</em> &#160;<b>ABOVE / BELOW </b>&#160; <em>value</em></p>
<p><b>&#160;&#160; LINK</b> <em>linkID</em> &#160; <em>status</em> &#160;<b> AT TIME&#160;</b> <em>time</em></p>
<p><b>&#160;&#160; LINK</b> <em>linkID</em> &#160; <em>status</em> &#160;<b> AT CLOCKTIME</b> <em>clocktime</em> &#160;<b> AM / PM</b></p>
<p>where: </p><table style="border: 0px solid black">
<tr>
<td><em>linkID</em></td><td>= </td><td>&#160;a link ID label </td></tr>
<tr>
<td><em>status</em></td><td>= </td><td>&#160;<b> OPEN / CLOSED</b>, a pump speed setting, or a control valve setting <br />
</td></tr>
<tr>
<td><em>nodeID</em></td><td>= </td><td>&#160;a node ID label </td></tr>
<tr>
<td><em>value</em></td><td>= </td><td>&#160;a pressure for a junction or a water level for a tank </td></tr>
<tr>
<td><em>time</em></td><td>= </td><td>&#160;a time since the start of the simulation in hours </td></tr>
<tr>
<td><em>clocktime</em></td><td>= </td><td>&#160;a 24-hour clock time (hrs:min) </td></tr>
</table>
<p><b>Remarks:</b></p><ol type="1">
<li>Simple controls are used to change link status or settings based on tank water level, junction pressure, time into the simulation or time of day. <br />
</li>
<li>See the notes for the <a class="el" href="_status_page.html">[STATUS]</a> section for conventions used in specifying link status and setting, particularly for control valves. <br />
</li>
</ol>
<p><b>Examples:</b></p>
<p><code>[CONTROLS]<br />
;Close Link 12 if the level in Tank 23 exceeds 20 ft.<br />
LINK 12 CLOSED IF NODE 23 ABOVE 20</code></p>
<p><code>;Open Link 12 if the pressure at Node 130 is under 30 psi<br />
LINK 12 OPEN IF NODE 130 BELOW 30</code></p>
<p><code>;Pump PUMP02's speed is set to 1.5 at 16 hours into the simulation<br />
LINK PUMP02 1.5 AT TIME 16</code></p>
<p><code>;Link 12 is closed at 10 am and opened at 8 pm throughout the simulation<br />
LINK 12 CLOSED AT CLOCKTIME 10 AM<br />
LINK 12 OPEN AT CLOCKTIME 8 PM </code> </p>
</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>