JIANG/EPANET
1
0
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases Wiki Activity
Files
c16c861789f2aa93b7446d08b7a365916c479d2f
EPANET/doc/html/_options_page.html
Demetrios G. Eliades c16c861789 HTML Users Guide
2019-11-21 16:58:18 +02:00

185 lines
12 KiB
HTML
Raw Blame History

<!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: [OPTIONS]</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">[OPTIONS] </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p><b>Purpose:</b></p>
<p>Defines various simulation options.</p>
<p><b>Formats:</b> </p><table style="border: 0px solid black">
<tr>
<td><b>UNITS</b></td><td><b>CFS / GPM / MGD / IMGD / AFD /</b> </td></tr>
<tr>
<td></td><td><b>LPS / LPM / MLD / CMH / CMD</b> </td></tr>
<tr>
<td><b>HEADLOSS</b></td><td><b>H-W / D-W / C-M</b> </td></tr>
<tr>
<td><b>HYDRAULICS</b></td><td><b>USE / SAVE </b><em>&#160;filename</em> </td></tr>
<tr>
<td><b>VISCOSITY</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>SPECIFIC GRAVITY</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>TRIALS</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>ACCURACY</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>FLOWCHANGE</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>HEADERROR</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>CHECKFREQ</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>MAXCHECK</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>DAMPLIMIT</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>UNBALANCED</b></td><td><b>STOP / CONTINUE / CONTINUE </b><em>n</em> </td></tr>
<tr>
<td><b>DEMAND MODEL</b></td><td><b>DDA / PDA</b> </td></tr>
<tr>
<td><b>MINIMUM PRESSURE</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>REQUIRED PRESSURE</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>PRESSURE EXPONENT</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>PATTERN</b></td><td><em>id</em> </td></tr>
<tr>
<td><b>DEMAND MULTIPLIER</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>EMITTER EXPONENT</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>QUALITY</b></td><td><b>NONE / CHEMICAL / AGE / TRACE&#160;&#160; </b><em>nodeID</em> </td></tr>
<tr>
<td><b>DIFFUSIVITY</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>TOLERANCE</b></td><td><em>value</em> </td></tr>
<tr>
<td><b>MAP</b></td><td><em>filename</em> </td></tr>
</table>
<p><b>Definitions:</b></p>
<p><b>UNITS</b> sets the units in which flow rates are expressed where:</p><ul>
<li><b>CFS</b> = cubic feet per second</li>
<li><b>GPM</b> = gallons per minute</li>
<li><b>MGD</b> = million gallons per day</li>
<li><b>IMGD</b> = Imperial MGD</li>
<li><b>AFD</b> = acre-feet per day</li>
<li><b>LPS</b> = liters per second</li>
<li><b>LPM</b> = liters per minute</li>
<li><b>MLD</b> = million liters per day</li>
<li><b>CMH</b> = cubic meters per hour</li>
<li><b>CMD</b> = cubic meters per day</li>
</ul>
<p>For <b>CFS, GPM, MGD, IMGD</b>, and <b>AFD</b> other input quantities are expressed in US Customary Units. If flow units are in liters or cubic meters then Metric Units must be used for all other input quantities as well. (See the <a class="el" href="_units.html">Measurement Units</a> topic). The default flow units are <b>GPM</b>.</p>
<p><b>HEADLOSS</b> selects a formula to use for computing head loss for flow through a pipe. The choices are the Hazen-Williams (<b>H-W</b> ), Darcy-Weisbach (<b>D-W</b> ), or Chezy-Manning (<b>C-M</b> ) formulas. The default is <b>H-W</b>.</p>
<p>The <b>HYDRAULICS</b> option allows you to either <b>SAVE</b> the current hydraulics solution to a file or <b>USE</b> a previously saved hydraulics solution. This is useful when studying factors that only affect water quality behavior.</p>
<p><b>VISCOSITY</b> is the kinematic viscosity of the fluid being modeled relative to that of water at 20 deg. C (1.0 centistoke). The default value is 1.0.</p>
<p><b>SPECIFIC</b> GRAVITY is the ratio of the density of the fluid being modeled to that of water at 4 deg. C (unitless). The default value is 1.0.</p>
<p><b>TRIALS</b> are the maximum number of trials used to solve network hydraulics at each hydraulic time step of a simulation. The default is 40.</p>
<p><b>ACCURACY</b> prescribes the convergence criterion that determines when a hydraulic solution has been reached. The trials end when the sum of all flow changes from the previous solution divided by the total flow in all links is less than this number. The default is 0.001.</p>
<p><b>FLOWCHANGE</b> is a similar convergence criterion requiring that the largest absolute flow change between the current and previous solutions be less than the specified value (in flow units). The default is 0 which means that this criterion is not used.</p>
<p><b>HEADERROR</b> is yet another convergence criterion requiring that the head loss computed by the head loss formula compared to the difference in nodal heads across each link be less than the specified value (in ft or m). The default is 0 which means that this criterion is not used.</p>
<p><b>CHECKFREQ</b> sets the number of solution trials that pass during hydraulic balancing before the status of pumps, check valves, flow control valves and pipes connected to tanks are once again updated. The default value is 2, meaning that status checks are made every other trial.</p>
<p><b>MAXCHECK</b> is the number of solution trials after which periodic status checks are discontinued. Instead, a status check is made only after convergence is achieved. The default value is 10, meaning that after 10 trials, instead of checking status every <b>CHECKFREQ</b> trials, status is checked only at convergence.</p>
<p><b>DAMPLIMIT</b> is the accuracy value at which solution damping and status checks on PRVs and PSVs should begin. Damping limits all flow changes to 60% of what they would otherwise be as future trials unfold. The default is 0 which indicates that no damping should be used and that status checks on control valves are made at every iteration.</p>
<p><b>UNBALANCED</b> determines what happens if a hydraulic solution cannot be reached within the prescribed number of <b>TRIALS</b> at some hydraulic time step into the simulation. <b>STOP</b> will halt the entire analysis at that point. <b>CONTINUE</b> will continue the analysis with a warning message issued. <b>CONTINUE n</b> will continue the search for a solution for another <b>n</b> trials with the status of all links held fixed at their current settings. The simulation will be continued at this point with a message issued about whether convergence was achieved or not. The default choice is <b>STOP</b>.</p>
<p><b>DEMAND</b> MODEL specifies whether a demand driven analysis ( <b>DDA</b> ) or a pressure driven analysis ( <b>PDA</b> ) should be made. Under <b>DDA</b> full nodal demands are always met even if negative pressures result. <b>PDA</b> assumes that demand varies between 0 and its full value as a power function of nodal pressure. The default demand model is <b>DDA</b>.</p>
<p><b>MINIMUM</b> PRESSURE is the pressure below which no demand can be delivered under a pressure driven analysis. It has no effect on a demand driven analysis. Its default value is 0.</p>
<p><b>REQUIRED</b> PRESSURE is the pressure required to supply a node's full demand under a pressure driven analysis. It has no effect on a demand driven analysis. It must be at least 0.1 psi or m higher than the MINIMUM PRESSURE, which is also its default value.</p>
<p><b>PRESSURE</b> EXPONENT is the power to which pressure is raised when computing the demand delivered to a node under a pressure driven analysis. It has no effect on a demand driven analysis. Its default value is 0.5.</p>
<p><b>PATTERN</b> provides the ID label of a default demand pattern to be applied to all junctions where no demand pattern was specified. If no such pattern exists in the <b></b>[PATTERNS] section then by default the pattern consists of a single multiplier equal to 1.0. If this option is not used, then the global default demand pattern has a label of "1".</p>
<p>The <b>DEMAND MULTIPLIER</b> is used to adjust the values of baseline demands for all junctions and all demand categories. For example, a value of 2 doubles all baseline demands, while a value of 0.5 would halve them. The default value is 1.0.</p>
<p><b>EMITTER EXPONENT</b> specifies the power to which the pressure at a junction is raised when computing the flow issuing from an emitter. The default is 0.5.</p>
<p><b>QUALITY</b> selects the type of water quality analysis to perform. The choices are <b>NONE, CHEMICAL, AGE</b>, and <b>TRACE</b>. In place of <b>CHEMICAL</b> the actual name of the chemical can be used followed by its concentration units (e.g., <b>CHLORINE mg/L</b>). If <b>TRACE</b> is selected it must be followed by the ID label of the node being traced. The default selection is <b>NONE</b> (no water quality analysis).</p>
<p><b>DIFFUSIVITY</b> is the molecular diffusivity of the chemical being analyzed relative to that of chlorine in water. The default value is 1.0. Diffusivity is only used when mass transfer limitations are considered in pipe wall reactions. A value of 0 will cause EPANET to ignore mass transfer limitations.</p>
<p><b>TOLERANCE</b> is the difference in water quality level below which one can say that one parcel of water is essentially the same as another. The default is 0.01 for all types of quality analyses (chemical, age (measured in hours), or source tracing (measured in percent)).</p>
<p><b>MAP</b> is used to supply the name of a file containing coordinates of the network's nodes so that a map of the network can be drawn. It is not used for any hydraulic or water quality computations.</p>
<p><b>Remarks:</b></p><ol type="1">
<li>All options assume their default values if not explicitly specified in this section.</li>
<li>Items offset by slashes (/) indicate allowable choices.</li>
</ol>
<p><b>Example:</b> </p><div class="fragment"><div class="line">[OPTIONS]</div>
<div class="line">UNITS CFS</div>
<div class="line">HEADLOSS D-W</div>
<div class="line">DEMAND MODEL PDA</div>
<div class="line">REQUIRED PRESSURE 40</div>
<div class="line">QUALITY TRACE Tank23</div>
<div class="line">UNBALANCED CONTINUE 10</div>
</div><!-- fragment --> </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>
Reference in New Issue View Git Blame Copy Permalink