skip to main content
Aggregate Reach
Objects and Methods
Aggregate Reach
The Aggregate Reach (Agg Reach) is an aggregate of Reach Objects. The aggregate performs no routing calculations, it just totals various information from its elements. It 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.
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.
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
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
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
User Methods
This object has no user methods.
Dispatch Methods
This object has only one dispatch method.
* solveTotals
This dispatch method totals various auxiliary slots of the elements.
Required Knowns
• Inflow
• Outflow
Required Unknowns
When the inflow and the outflow of the Aggregate Reach are known, it is assumed that all interior reaches have dispatched, and have solved for all auxiliary slots. This 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 a NaN, the total will not include any contribution from that slot of that element
Revised: 06/03/2019