WMS:Repeated Use of an Equation: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
If your local hydrology manual requires the use of an equation not currently supported by WMS and you must repeatedly use this equation for projects, you can set up the equation in a text file in the same directory as WMS and it will be read in and set up as the User Defined equation automatically. To do this you must create a file named "wmstc.equ" and define one or more equation groups (a group may be used because sometimes your equation to compute a travel time may be a function of another equation). The following is an example wmstc.equ file.
If the local hydrology manual requires the use of an equation not currently supported by WMS and this equation must be repeatedly used for projects, set up the equation in a text file in the same directory as WMS. It will be read in and set up as the user defined equation automatically. To do this, create a file named "wmstc.equ" and define one or more equation groups (a group may be used because sometimes the equation to compute a travel time may be a function of another equation). The following is an example wmstc.equ file.
 


<pre>
<pre>
Line 27: Line 26:
The following describes the keywords used in the file as well as the possible values that can be entered following each keyword.
The following describes the keywords used in the file as well as the possible values that can be entered following each keyword.


Each equation group begins with the '''EQGROUP''' card. The rest of the line is interpreted as a character string and used as the name of the equation group in the drop-down combo box allowing you to select an equation.
Each equation group begins with the '''EQGROUP''' card. The rest of the line is interpreted as a character string and used as the name of the equation group in the drop-down combo box allowing selection an equation.


Each equation is defined using the following three cards with their associated inputs:
Each equation is defined using the following three cards with their associated inputs:
Line 37: Line 36:
'''UNITS''' &ndash; Units of the computed result. Possible values for units include: laghour, lagmin, tchour, tcmin, clarkr, tp. The first four identify whether the equation is intended for use in computing lag time or time of concentration (a conversion to the other is done using this equation) and whether the result is in minutes or hours. The last three are used if the equation is used to compute the Clark storage coefficient or one of the peaking parameters used in HEC-1.
'''UNITS''' &ndash; Units of the computed result. Possible values for units include: laghour, lagmin, tchour, tcmin, clarkr, tp. The first four identify whether the equation is intended for use in computing lag time or time of concentration (a conversion to the other is done using this equation) and whether the result is in minutes or hours. The last three are used if the equation is used to compute the Clark storage coefficient or one of the peaking parameters used in HEC-1.


If one of the WMS recognized variables are used (A, Lca, etc.) then you do not need to include a VAR record as it will automatically map the WMS variable for use in the equation. For variables not recognized as something WMS computes you should include a VAR line that uses the following keywords:
If one of the WMS recognized variables are used (A, Lca, etc.) then it is not necessary to include a VAR record as it will automatically map the WMS variable for use in the equation. For variables not recognized as something WMS computes, include a VAR line that uses the following keywords:


'''VAR''' - Name of the variable
'''VAR''' &ndash; Name of the variable


'''DEF''' - Variable definition or description
'''DEF''' &ndash; Variable definition or description


'''VAL''' - The initial default value (should be 0.0 if this will be entered separately for each basin)
'''VAL''' &ndash; The initial default value (should be 0.0 if this will be entered separately for each basin)


'''UNITS''' - The units of the variable. The following list of keywords are recognized for units. If you use a variable with units not in this list you should enter "none" and then make sure that the equation is dimensionally consistent with the units defined for the equation on the EQ line.
'''UNITS''' &ndash; The units of the variable. The following list of keywords are recognized for units. If using a variable with units not in this list, enter "none" and then make sure that the equation is dimensionally consistent with the units defined for the equation on the EQ line.


<div style="margin-left:25px">
<div style="margin-left:25px">
Line 91: Line 90:




'''WHICH''' - If a variable represents another equation that is part of the equation group then you should follow the WHICH keyword with the equation number. If it does not represent another equation then you should follow it with a -1. See the example above where the hydraulic radius variable R represents the second equation in the group (XA/Pw).
'''WHICH''' &ndash; If a variable represents another equation that is part of the equation group then the variable should follow the WHICH keyword with the equation number. If it does not represent another equation then the variable should be followed with a -1. See the example above where the hydraulic radius variable R represents the second equation in the group (XA/Pw).


You may define as many equations as you want in the file and each time WMS is started the equations will be read and become members in the list of equations you can select from when defining travel times from basin data.
A user may define as many equations as desired in the file and each time WMS is started the equations will be read and become members in the list of equations that can be selected when defining travel times from basin data.


==Related Topics==
==Related Topics==
Line 101: Line 100:


{{WMSMain}}
{{WMSMain}}
[[Category:Equations|Repeated]]

Latest revision as of 15:07, 29 September 2017

If the local hydrology manual requires the use of an equation not currently supported by WMS and this equation must be repeatedly used for projects, set up the equation in a text file in the same directory as WMS. It will be read in and set up as the user defined equation automatically. To do this, create a file named "wmstc.equ" and define one or more equation groups (a group may be used because sometimes the equation to compute a travel time may be a function of another equation). The following is an example wmstc.equ file.

EQGROUP Myeq1

EQ 1.49 / n * R * Sc DEF Manning's equation UNITS laghour

VAR n DEF Manning's roughness coefficient VAL .002 UNITS none WHICH -1

VAR R DEF Hydraulic Radius VAL 0.0 UNITS ft WHICH 2

EQ XA / Pw DEF Hydraulic Radius UNITS ft

VAR XA DEF Cross section area VAL 0.0 UNITS sqft WHICH -1

VAR Pw DEF Wetted Perimeter VAL 0.0 UNITS ft WHICH -1

EQGROUP Myequ2

EQ Lc / V DEF Time of travel UNITS lagmin

VAR V DEF Velocity VAL 2.5 UNITS none WHICH -1


The following describes the keywords used in the file as well as the possible values that can be entered following each keyword.

Each equation group begins with the EQGROUP card. The rest of the line is interpreted as a character string and used as the name of the equation group in the drop-down combo box allowing selection an equation.

Each equation is defined using the following three cards with their associated inputs:

EQ – The equation

DEF – A character string definition for the equation

UNITS – Units of the computed result. Possible values for units include: laghour, lagmin, tchour, tcmin, clarkr, tp. The first four identify whether the equation is intended for use in computing lag time or time of concentration (a conversion to the other is done using this equation) and whether the result is in minutes or hours. The last three are used if the equation is used to compute the Clark storage coefficient or one of the peaking parameters used in HEC-1.

If one of the WMS recognized variables are used (A, Lca, etc.) then it is not necessary to include a VAR record as it will automatically map the WMS variable for use in the equation. For variables not recognized as something WMS computes, include a VAR line that uses the following keywords:

VAR – Name of the variable

DEF – Variable definition or description

VAL – The initial default value (should be 0.0 if this will be entered separately for each basin)

UNITS – The units of the variable. The following list of keywords are recognized for units. If using a variable with units not in this list, enter "none" and then make sure that the equation is dimensionally consistent with the units defined for the equation on the EQ line.

laghour  
tcmin  
tchour  
lagmin  
mi mile
m meter
ft feet
km kilometer
hr hour
sec second
none none
acre acre
sqkm square kilometer
sqmi square mile
sqft square feet
sqm square meter
in inch
mm millimeter
hect hectare


WHICH – If a variable represents another equation that is part of the equation group then the variable should follow the WHICH keyword with the equation number. If it does not represent another equation then the variable should be followed with a -1. See the example above where the hydraulic radius variable R represents the second equation in the group (XA/Pw).

A user may define as many equations as desired in the file and each time WMS is started the equations will be read and become members in the list of equations that can be selected when defining travel times from basin data.

Related Topics