Scripting > Math Functions


Modified Puls or Working R&D Routing Function

modifiedPulsRouting(TimeSeriesMath tsFlow,

      integer numberSubreaches,

      floating-point muskingumX )

 

The current data set is a paired data set containing the storage-discharge table for Puls routing, where the x-values are storage and the y-values are discharge.  The function derives a new time series data set from the Modified Puls or Working R&D routing of the time series data set tsFlow.  numberSubreaches is the number of routing subreaches.

 

The Working R&D method provides a means of including the effects of inflow on reach storage by use of the Muskingum “x” wedge coefficient.  The Working R&D method is activated in the computation if muskingumX is greater than 0.0.  However, muskingumX cannot be greater that 0.5.

 

Parameters:

tsFlow – A regular interval time series data set for routing.

numberSubreaches – Number of routing subreaches.

muskingumX - Muskingum "X" parameter, between 0.0 and 0.5 (inclusive).  Enter 0.0 to route by the Modified Puls method, or a value greater than 0.0 to apply the Working R&D.

Example:

routedFlow =

storDichareCurve.modifiedPulsRouting(

      tsFlow,

      reachCount,

      coefficient)

Returns:  A new TimeSeriesMath object.

Generated Exceptions: Throws a hec.hecmath.HecMathException if the tsMath is not a regular interval time series; if muskingumX is less than 0.0 or greater than 0.5; if the current paired data set does not have both ascending x and y values.