Objects and Methods
Aggregate Reach
The Aggregate Reach (Agg Reach) is an aggregate of Reach Objects. This object performs no routing calculations; it just totals various information from its elements.
This object also handles the connection between elements. This is done by linking inflow of the aggregate object to the inflow of the top element, then the outflow of the top element to the inflow of the next, and so on, until the last object’s outflow is connected to the Agg Reach’s outflow.
General Slots
Inflow
Type: SeriesSlot
Units: FLOW
Description: inflow into the top of the aggregate
Information: It is automatically linked to the inflow of the first element in the list of elements, if any.
I/O: Optional; Depends on desired dispatching.
Links: May be linked to the Outflow of any object.
Outflow
Type: SeriesSlot
Units: FLOW
Description: outflow from bottom of aggregate
Information: It is automatically linked to the outflow of the last element in the list of elements, if any.
I/O: Optional; Depends on desired dispatching.
Links: May be linked to the Inflow of any object.
Total Diversion
Type: SeriesSlot
Units: FLOW
Description: total amount of water diverted from elements within the Aggregate Reach
Information: This is calculated in the dispatch method.
I/O: Output only
Links: Usually not linked
Total Local Inflow
Type: SeriesSlot
Units: FLOW
Description: total amount of local inflow into the elements within the Aggregate Reach
Information: This is calculated in the dispatch method.
I/O: Output only
Links: Usually not linked
Total Return Flow
Type: SeriesSlot
Units: FLOW
Description: total amount of water returned to elements within the Aggregate Reach
Information: This is calculated in the dispatch method.
I/O: Output only
Links: Usually not linked
User Methods
This object has no user methods.
Dispatch Methods
This object has only one dispatch method.
solveTotalsThis dispatch method totals various auxiliary slots of the elements.
Required Known Slots
• Inflow
• Outflow
Required Unknown Slots
Method Details
When Inflow and Outflow for the Aggregate Reach are known, it is assumed that all interior reaches have dispatched and solved for all auxiliary slots.
The method then sums all these values (Diversion, Return Flow, and Local Inflow) and reports them in the appropriate total slot on the Aggregate Reach. If any value is NaN, the total does not include any contribution from that slot on that element.
Revised: 11/11/2019