Scripting > Math Functions


Muskingum Hydrologic Routing Function

muskingumRouting( integer numberSubreaches,

      floating-point muskingumK,

      floating-point muskingumX)

 

Route the current regular interval time series data set by the Muskingum Routing method.  The current data set must be a regular interval time series data set.  muskingumK is the Muskingum “K” parameter, in hours, and muskingumX is the Muskingum “x” parameter.  muskingumX cannot be less than 0.0 or greater than 0.5. 

 

The set of Muskingum routing parameters may potentially produce numerical instabilities in the routed time series.  Use the function isMuskingumRoutingStable() to test if the Muskingum routing parameters may potentially have instabilities.

 

See also:  isMuskingumRoutingStable()

Parameters:

numberSubreaches – An integer specifying the number of routing subreaches.

muskingumK – A floating-point number specifying the Muskingum "K" parameter in hours.

muskingumX – A floating-point number specifying the Muskingum "x" parameter, between 0.0 and 0.5

Example:

routedFlows = tsFlows.muskingumRouting(reachCount, K, x)

Returns: A new TimeSeriesMath object.

Generated Exceptions:  Throws a hec.hecmath.HecMathException if the current time series is not a regular interval time series; if muskingumX is less than 0.0 or greater than 0.5.