HTML Users Guide
This commit is contained in:
Demetrios G. Eliades
127
doc/html/_times_page.html
Normal file
127
doc/html/_times_page.html
Normal file
@@ -0,0 +1,127 @@
|
||||
<!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: [TIMES]</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">[TIMES] </div> </div>
|
||||
</div><!--header-->
|
||||
<div class="contents">
|
||||
<div class="textblock"><p><b>Purpose:</b> Defines various time step parameters used in the simulation.</p>
|
||||
<p><b>Formats:</b> </p><table style="border: 0px solid black">
|
||||
<tr>
|
||||
<td><b>DURATION</b> </td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>HYDRAULIC TIMESTEP</b> </td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>QUALITY TIMESTEP</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>RULE TIMESTEP</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>PATTERN TIMESTEP</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>PATTERN START</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>REPORT TIMESTEP</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>REPORT START</b></td><td><em>value</em> (units) </td></tr>
|
||||
<tr>
|
||||
<td><b>START CLOCKTIME</b></td><td><em>value</em> (<b>AM / PM</b>) </td></tr>
|
||||
<tr>
|
||||
<td><b>STATISTIC</b></td><td><b>NONE / AVERAGED / MINIMUM / MAXIMUM / RANGE</b> </td></tr>
|
||||
</table>
|
||||
<p><b>Definitions:</b></p>
|
||||
<p><b>DURATION</b> is the duration of the simulation. Use 0 to run a single period snapshot analysis. The default is 0.</p>
|
||||
<p><b>HYDRAULIC TIMESTEP</b> determines how often a new hydraulic state of the network is computed. If greater than either the <b>PATTERN</b> or <b>REPORT</b> time step it will be automatically reduced. The default is 1 hour.</p>
|
||||
<p><b>QUALITY TIMESTEP</b> is the time step used to track changes in water quality throughout the network. The default is 1/10 of the hydraulic time step.</p>
|
||||
<p><b>RULE TIMESTEP</b> is the time step used to check for changes in system status due to activation of rule-based controls between hydraulic time steps. The default is 1/10 of the hydraulic time step.</p>
|
||||
<p><b>PATTERN TIMESTEP</b> is the interval between time periods in all time patterns. The default is 1 hour.</p>
|
||||
<p><b>PATTERN START</b> is the time offset at which all patterns will start. For example, a value of 6 hours would start the simulation with each pattern in the time period that corresponds to hour 6. The default is 0.</p>
|
||||
<p><b>REPORT TIMESTEP</b> sets the time interval between which output results are reported. The default is 1 hour.</p>
|
||||
<p><b>REPORT START</b> is the length of time into the simulation at which output results begin to be reported. The default is 0.</p>
|
||||
<p><b>START CLOCKTIME</b> is the time of day (e.g., 3:00 PM) at which the simulation begins. The default is 12:00 AM midnight.</p>
|
||||
<p><b>STATISTIC</b> determines what kind of statistical post-processing should be done on the time series of simulation results generated. <b>AVERAGED</b> reports a set of time-averaged results, <b>MINIMUM</b> reports only the minimum values, <b>MAXIMUM</b> the maximum values, and <b>RANGE</b> reports the difference between the minimum and maximum values. <b>NONE</b> reports the full time series for all quantities for all nodes and links and is the default.</p>
|
||||
<p><b>Remarks:</b></p><ol type="1">
|
||||
<li>Units can be <b>SECONDS (SEC), MINUTES (MIN), HOURS</b>, or <b>DAYS</b>. The default is <b>HOURS</b>.</li>
|
||||
<li>If no units are supplied, then time values can be expressed in either decimal hours or in hours:minutes notation.</li>
|
||||
<li>All entries in the <b></b>[TIMES] section are optional. Items offset by slashes (/) indicate allowable choices.</li>
|
||||
</ol>
|
||||
<p><b>Example:</b> </p><div class="fragment"><div class="line">[TIMES] </div>
|
||||
<div class="line">DURATION 240 HOURS </div>
|
||||
<div class="line">QUALITY TIMESTEP 3 MIN </div>
|
||||
<div class="line">QUALITY TIMESTEP 0:03 </div>
|
||||
<div class="line">REPORT START 120 </div>
|
||||
<div class="line">START CLOCKTIME 6:00 AM </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