General Slots
Available Pumps
Type: Table Series
Units: NONE vs NONE
Description: Pump unit vs availability of that unit
Information: Availability is a positive value no greater than 1.0 indicating the decimal fraction of the capacity of the unit for the entire run time.
I/O: Required input
Links: Not linkable
Convergence Percentage
Type: Table
Units: NONE
Description: Percentage value ranging from 0 to 1 used for convergence in all iterative calculations
Information: See Reservoir Convergence for more information on the convergence algorithm
I/O: Optional; defaults to 0.0001 if not input.
Links: Not linkable
Diversion
Type: Series
Units: FLOW
Description: Flow from the reservoir to a diverting object
Information: If not linked or input it is set to zero.
I/O: Optional; may be input or linked or neither
Links: May be linked to the Total Diversion slot on an Agg Diversion Site or the Total delivery Request slot on an AggDistribution Canal.
Diversion Capacity
Type: Scalar Slot
Units: FLOW
Description: Used to hold the maximum diversion physically possible from the reservoir
Information: This slot is used in the accounting system for allocation purposes and can be used in Rulebased Simulation
I/O: Input only
Links: Not linkable
Elevation Volume Table
Type: Table
Units: LENGTH vs VOLUME
Description: Reservoir Pool Elevation vs Reservoir Storage
Information:
I/O: Required input
Links: Not linkable
Energy
Type: Series Slot
Units: ENERGY
Description: Product of the power generated by flow through the turbines and the length of the timestep
Information: This slot may also take the BEST_EFFICIENCY or MAX_CAPACITY flags, which allow Energy to act as input for dispatching, but solve for the value of energy assuming the generators are operating at best efficiency or maximum capacity.
I/O: Optional; if not input by the user, Energy is computed in the power calculations.
Links: Usually not linked
Head vs Pump Flow
Type: Table
Units: LENGTH vs FLOW
Description: Operating head vs maximum flow for each pump type
Information:
I/O: Required input
Links: Not linkable
Head vs Pump Power
Type: Table
Units: LENGTH vs POWER
Description: Operating head vs maximum pumping power for each pump type
Information:
I/O: Required input
Links: Not linkable
Hours Utilized
Type: Table Series
Units: TIME, TIME
Description: Hours of the timestep spent generating energy and pumping, respectively
Information:
I/O: Output only
Links: Not linkable
Inflow
Type: Multi Slot
Units: FLOW
Description: Inflow into the reservoir from upstream
Information:
I/O: Optional; if not input by the user, it is set through either mass balance computations or the propagation of values across the link.
Links: May be linked to one or more outflow slots of upstream objects.
Max Iterations
Type: Table
Units: NOUNITS
Description: Maximum number of allowable iterations for iterative loops in the solution algorithms
Information: Used in conjunction with Convergence Percentage as a stopping criterion for iterative calculations.
I/O: Optional; defaults to 100 if not input.
Links: Not linkable
Operating Head
Type: Series Slot
Units: LENGTH
Description: Elevation difference between the average Pool Elevation and the average Tailwater Elevation during a timestep
Information:
I/O: Output only
Links: Usually not linked
Outflow
Type: Series Slot
Units: FLOW
Description: Outflow from reservoir through the turbines
Information: Outflow is the sum of the Turbine Release and Spill
I/O: Optional; if not input by the user, it is set through mass balance computations.
Links: Linked to the Flow FROM Pumped Storage slot on another reservoir, or the Inflow slot on any object.
Pool Elevation
Type: Series Slot
Units: LENGTH
Description: Elevation of the water surface of the Reservoir
Information: There must be an initial value for either Storage or Pool Elevation given by the user for the first timestep.
I/O: Optional; if not input by the user, it is solved by the mass balance computations. It may take a TARGET flag indicated by the user for target operation solution.
Links: May be linked to Tailwater Elevation or Tailwater Base Value of an upstream object or to Elevation 1 or Elevation 2 of a Canal object.
Power
Type: Series Slot
Units: POWER
Description: Power generated by flow through the turbines
Information: Calculated by the power methods and cannot be input by the user.
I/O: Output only
Links: Not linkable
Pump Capacity
Type: Series Slot
Units: POWER
Description: Maximum pumping capacity
Information:
I/O: Output only
Links: Usually not linked
Pump Energy
Type: Series Slot
Units: ENERGY
Description: energy required to run the pumps for the timestep
Information:
I/O: Can be input or solved for by the dispatch methods
Links: Usually not linked
Pumped Flow
Type: Series
Units: FLOW
Description: Flow into the reservoir by pumping
Information:
I/O: Optional; can be input or solved for
Links: Linked to the Flow TO Pumped Storage slot on another reservoir.
Pump Power
Type: Series Slot
Units: POWER
Description: Power required to run the pumps
Information:
I/O: Output only
Links: Usually not linked
Pump Unit Types
Type: Table
Units: NONE vs NONE
Description: Pump unit number vs type identification number of all pump units
Information:
I/O: Required input
Links: Not linkable
Pumps Used
Type: Series
Units: NONE
Description: the number of pumps used during the timestep
Information: Specific pumps cannot be designated. Pumps will always be added in the best efficiency order.
I/O: Optional; input or output
Links: Usually not linked
Return Flow
Type: Multi Slot
Units: FLOW
Description: Flow returning from a diverting object
Information:
I/O: Optional; defaults to zero if not linked or input.
Links: May be linked to one or more Return Flow slots on Water User objects or the Total Return Flow slot on the Agg Diversion Site objects.
Spill
Type: Series Slot
Units: FLOW
Description: Sum of the regulated and unregulated spills and bypass
Information: May be input or solved for by RiverWare (see spill calculation methods).
I/O: Optional; may be input or solved for by RiverWare (see spill calculation methods).
Links: Usually not linked
Storage
Type: Series Slot
Units: VOLUME
Description: Volume of water stored in the reservoir
Information: May be flagged as a TARGET Storage value by the user. There must be an initial value for either Storage or Pool Elevation given by the user for the first timestep. If flagged as a TARGET, a target operation solution is used.
I/O: Optional; if not input by the user, it is set through mass balance computations.
Links: Usually not linked
Tailwater Elevation
Type: Series
Units: LENGTH
Description: water surface elevation on the downstream side of the dam
Information: It can be linked to the Pool Elevation or Backwater Elevation of a downstream reservoir if the Linked or Input method is selected for the Tailwater category. Otherwise, it is calculated by the user method selected. It is used to compute the Operating Head used in the power calculations.
I/O: Optional; can be input, linked or calculated.
Links: It can be linked to the Pool Elevation or Backwater Elevation of a downstream reservoir if the Linked or Input method is selected for the Tailwater category.
Total Inflows
Type: Series
Units: Flow
Description: Summary slot displaying the flows into and out of the reservoir excluding the flows through the outlet works
Information: Total Inflows is calculated using the following equation. Any component that is not in use or is not valid defaults to zero.
I/O: Output only
Links: Not linkable
Inflow Sum
Type: Series
Units: Flow
Description: Sum of the total flows entering the reservoir at each timestep
Information: Inflow Sum is calculated using the following equation:
I/O: Output only
Links: Not linkable
Turbine Release
Type: Series Slot
Units: FLOW
Description: Flow through the turbines of a power reservoir (excluding spill)
Information:
I/O: Optional; solved for if not input.
Links: Usually not linked
Revised: 07/09/2023