Description

Sum of a timeseries of values, each of which is the result of aggregating several objects’ slot values.

Type

NUMERIC

Arguments

Type

Meaning

1

STRING

Subbasin name

2

STRING

slot name

3

STRING

aggregation function ("SUM", "AVG", "MIN", or "MAX")

4

STRING

aggregation filter ("INPUT", "OUTPUT", or "ALL")

5

BOOLEAN

time conversion option ("TRUE" or "FALSE")

6

DATETIME

start datetime

7

DATETIME

end datetime

Evaluation

A list of slots is generated by searching all of the objects in the subbasin argument for slots which match the slot name argument. If the time conversion option argument is TRUE, and the values to be aggregated are of the FLOW unit type, the values are multiplied by their corresponding timestep length to convert them to values of the unit type VOLUME.

Next, all of the objects’ slot values are aggregated according to the aggregation function argument for each timestep in the time range of the datetime arguments. During each of these slot aggregations, any values which do not satisfy the aggregation filter argument are ignored.

Finally, the timeseries of object aggregated slot values are summed.

Mathematical Expression

Comments

If the time conversion option argument is TRUE, but the unit of the slot values is not FLOW, RiverWare aborts the run with an error.

If none of the values for a slot satisfy the aggregation filter argument, the "SUM" aggregation function yields an aggregated value of 0.0 for that slot, while the "AVG", "MIN", and "MAX" aggregation functions abort RiverWare with an error.