Slots
Temperature Slots
Inflow Heat
Type: Multi Slot
Units: Heat
Description: Holds the values of inflow heat for each inflow to the reservoir
I/O: Required Known
Links: This slot can be linked to the Outflow Heat slot of an upstream object.
Diversion Temperature
Type: Series Slot
Units: Temperature
Description: Temperature of Diversion
I/O: Optional input
Links: If Diversion is not linked and is not valid, Diversion Temperature is set to zero.
Return Flow Temperature
Type: Series Slot
Units: Temperature
Description: Temperature of Return Flow.
I/O: Optional input
Links: If Return Flow is not linked and is not valid, Return Flow Temperature is set to zero.
Local Inflow Temperature
Type: Series Slot
Units: Temperature
Description: Temperature of Local Inflow.
I/O: Optional input
Links: If Local Inflow is not linked and is not valid, Local Inflow Temperature is set to zero.
Maximum Flow Rate for WQ Stability
Type: Table Slot
Units: Flow
Description: Input a flow rate which is greater then or equal to any anticipated for the simulation to keep the explicit solution stable.
Note: Extremely large values will significantly increase computational cost.
I/O: Input only
Links: Not linkable
Outflow Heat
Type: Series Slot
Units: Heat
Description: Temperature of releases from the reservoir
I/O: Output only
Links: This slot can be linked to the Inflow Heat slot of a downstream object.
Dispersion Coefficient
Type: Table Slot
Units: None
Description: Longitudinal dispersion coefficient in units of L2/T
Information: Used in temperature calculation
I/O: Input only
Links: Not linkable
Specific Heat of Water
Type: Table Slot
Units: SpecificHeat
Description: Specific heat of water. Used for heat / temperature conversions.
I/O: Optional input
Links: Not linkable
Distributed Temperature Output
Type: Table Series Slot
Units: Various
Description: Table which displays the discretized values Water temperature with respect to distance within the Reach.
I/O: Output only; this is a temporary slot that is not saved in the model file.
Links: Not linkable
Distributed Total Surface Flux Output
Type: Table Series Slot
Units: Various
Description: Table which displays the discretized values of the main components of surface heat exchange as well as the total surface flux with respect to distance.
I/O: Output only; this is a temporary slot that is not saved in the model file.
Links: Not linkable
Air Temperature
Type: Series Slot
Units: Temperature
Description: Air temperature at the reservoir surface
I/O: Input only
Links: Not linkable
Dewpoint Temperature
Type: Series Slot
Units: Temperature
Description: Dewpoint temperature at the reservoir surface
I/O: Required input
Links: Not linkable
Incoming Solar Radiation
Type: Series Slot
Units: HeatFlux
Description: Incoming solar radiation received by the reservoir
I/O: Required Input
Links: Not linkable
Wind Velocity
Type: Series Slot
Units: Velocity
Description: wind velocity at reservoir surface
Information: This slot is assumed to be zero if not a user input.
I/O: Optional input
Links: Not linkable
Distributed Temperature Output
Type: Table Series Slot
Units: Various
Description: Table which displays the discretized values Water temperature with respect to distance within the Reach.
I/O: Output only - This is a temporary slot that is not saved in the model file.
Links: Not linkable
Salinity Slots
Inflow Salt Mass
Type: Series Slot
Units: Mass
Description: Holds the values of inflow salinity for each inflow to the reach
I/O: Required known
Links: Linkable, but the Inflow Salt Concentration should be linked instead.
Outflow Salt Mass
Type: Series Slot
Units: Mass
Description: Salt mass in outflow from the reservoir
I/O: Output only
Links: Linkable, but the Outflow Salt Concentration should be linked instead.
Seepage Salt Concentration
Type: Series Slot
Units: Concentration
Description: Salt concentration of the Seepage
I/O: Input, set by a rule, or propagated across a link.
Links: Linkable
Diversion Salt Concentration
Type: Series Slot
Units: Concentration
Description: Salt concentration of Diversion.
I/O: Input, Output, or set by a rule.
Links: If Diversion is not linked and is not valid, Diversion Salt Concentration is set to zero.
Return Flow Salt Concentration
Type: Multi Slot
Units: Concentration
Description: Salt concentration of Return Flow.
Information: When there are multiple links to this slot, the subslots will be shown. The first column is the sum column, which is not relevant as these are concentrations not mass.
I/O: Input, rules, or propagated from another object
Links: If Return Flow is not linked and is not valid, Return Flow Salt Concentration is set to zero. For Well Mixed Salt, this slot should NOT be linked. Link Return Flow Salt Mass instead.
Local Inflow Salt Concentration
Type: Series Slot
Units: Concentration
Description: Salt concentration of Local Inflow.
I/O: Input, rules, solved for by dispatch method, or propagated from another object
Links: If Local Inflow is not linked and is not valid, Local Inflow Salt Concentration is set to zero.
Distributed Salt Concentration Output
Type: Table Series Slot
Units: Various
Description: Table which displays the discretized values of Salt Concentration with respect to distance within the Reach.
I/O: Output only - This is a temporary slot that is not saved in the model file.
Links: Not linkable
Inflow Salt Concentration
Type: Series Slot
Units: Concentration
Description: Holds the values of inflow salinity for inflow to the reach
I/O: Required known
Links: This slot can be linked to the Outflow Salt Concentration of an upstream object.
Seepage Salt Mass
Type: Series Slot
Units: Mass
Description: Salt Mass of the Seepage
I/O: Output only
Links: Not linkable
Return Flow Salt Mass
Type: Multi Slot
Units: Mass
Description: Salt mass of Return Flow.
I/O: Optional known
Links: Yes, for Well Mixed Salt. If Return Flow is not linked and is not valid, Return Flow Salt Mass is set to zero. Do not link Return Flow Salt Mass if using the discretized methods, link the concentration instead.
Diversion Salt Mass
Type: Series Slot
Units: Mass
Description: Salt mass value of the Diversion from the reach
I/O: Output only
Links: Not linkable
Local Inflow Salt Mass
Type: Series Slot
Units: Mass
Description: Salt mass value of the Local Inflow
I/O: Output Only
Links: Not linkable
Outflow Salt Concentration
Type: Series Slot
Units: Concentration
Description: Salinity of releases from the reservoir
I/O: Output only
Links: This slot can be linked to the Inflow Salt Concentration of a downstream object.
Salt Mass Removal
Type: Series Slot
Units: Mass
Description: Mass of salt removed from the reach, typically by a linked Agg Diversion Site. This is included into the reach’s salinity mass balance. A positive Salt Mass Removal represents salt removed from (subtracted from) the Outflow Salt Mass.
I/O: Optional input, if not linked and not input, defaults to zero
Links: Can be linked to Salt Mass Removal on an Agg Diversion Site
Salt Available For Removal
Type: Series Slot
Units: Mass
Description: Maximum salt mass that can be removed without dropping below the specified Minimum Salt Concentration (if solving downstream) or exceeding the specified Maximum Salt Concentration (if solving upstream). If this slot is not linked, it is not used.
I/O: Output only
Links: Can be linked to Salt Available For Removal on an Agg Diversion Site
Salt Storage
Type: Series Slot
Units: Mass
Description: Mass of salt stored on the reach due to low flows
I/O: Initial timestep can be input, otherwise Output only.
Links: Not linkable
Maximum Salt Concentration
Type: Periodic Slot
Units: Concentration
Description: Maximum possible salt concentration; i.e. the concentration at saturation
I/O: Input
Links: Not linkable
Minimum Salt Concentration
Type: Periodic Slot
Units: Concentration
Description: Minimum possible salt concentration. There is no restriction on the value in this slot. It can be negative.
I/O: If the Salt Mass Removal slot is linked, this slot is required input. Otherwise it is an optional input.
Links: Not linkable
Diversion Salt Concentration Maximum
Type: Series Slot with Periodic Input
Units: Concentration
Description: Maximum possible salt concentration on the diversion.
I/O: Optional input. Can be specified as a periodic or series relationship
Links: Not linkable
Dissolved Oxygen Slots
Inflow Dissolved Oxygen Mass
Type: Multi Slot
Units: Mass
Description: Holds the values of inflow dissolved oxygen for each inflow to the reservoir
I/O: Input, rules, or propagated across a link
Links: This slot can be linked to the Outflow Dissolved Oxygen Mass slot of an upstream object.
Inflow Detritus Mass
Type: Multi Slot
Units: Mass
Description: Holds the values of inflow detritus for each inflow to the reservoir
I/O: Input, rules, or propagated across a link
Links: This slot can be linked to the Outflow Detritus Mass slot of an upstream object.
Inflow Dissolved Organics Mass
Type: Multi Slot
Units: Mass
Description: Holds the values of inflow dissolved oxygen for each inflow to the reservoir
I/O: Input, rules, or propagated across a link
Links: This slot can be linked to the Outflow Dissolved Organics Mass slot of an upstream object.
Inflow Ammonia Mass
Type: Multi Slot
Units: Mass
Description: Holds the values of inflow ammonia for each inflow to the reservoir
I/O: Input, rules, or propagated across a link
Links: This slot can be linked to the Outflow Ammonia Mass slot of an upstream object.
Outflow Dissolved Oxygen Mass
Type: Series Slot
Units: Mass
Description: Dissolved oxygen mass in Outflow from the reach
I/O: Output only
Links: This slot can be linked to the Inflow Dissolved Oxygen Mass slot of a downstream object.
Outflow Detritus Mass
Type: Series Slot
Units: Mass
Description: detritus mass in Outflow from the reach
I/O: Output only
Links: This slot can be linked to the Inflow Detritus Mass slot of a downstream object.
Outflow Dissolved Organics Mass
Type: Series Slot
Units: Mass
Description: Dissolved oxygen mass in releases from the reach\
I/O: Output only
Links: This slot can be linked to the Inflow Dissolved Organics Mass slot of a downstream object.
Outflow Ammonia Mass
Type: Series Slot
Units: Mass
Description: ammonia mass in the outflow from the reach
I/O: Output only
Links: This slot can be linked to the Inflow Ammonia Mass slot of a downstream object.
Diversion Detritus Concentration
Type: Series Slot
Units: Concentration
Description: detritus concentration of Diversion.
Information:
I/O: Output only
Links: If Diversion is not linked and is not valid, Diversion Detritus Concentration is set to zero.
Return Flow Detritus Concentration
Type: Series Slot
Units: Concentration
Description: detritus concentration of Return Flow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Return Flow is not linked and is not valid, Return Flow Detritus Concentration is set to zero.
Local Inflow Detritus Concentration
Type: Series Slot
Units: Concentration
Description: detritus concentration of Local Inflow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Local Inflow is not linked and is not valid, Local Inflow Detritus Concentration is set to zero.
Diversion Diss Org Concentration
Type: Series Slot
Units: Concentration
Description: Dissolved organics concentration of Diversion.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Diversion is not linked and is not valid, Diversion Diss Org Concentration is set to zero.
Return Flow Diss Org Conc
Type: Series Slot
Units: Concentration
Description: Dissolved organics concentration of Return Flow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Return Flow is not linked and is not valid, Return Flow Diss Org Concentration is set to zero.
Local Inflow Diss Org Concentration
Type: Series Slot
Units: Concentration
Description: Dissolved organics concentration of Local Inflow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Local Inflow is not linked and is not valid, Local Inflow Diss Org Concentration is set to zero.
Diversion Ammonia Concentration
Type: Series Slot
Units: Concentration
Description: detritus concentration of Diversion.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Diversion is not linked and is not valid, Diversion Ammonia Concentration is set to zero.
Return Flow Ammonia Concentration
Type: Series Slot
Units: Concentration
Description: detritus concentration of Return Flow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Return Flow is not linked and is not valid, Return Flow Ammonia Concentration is set to zero.
Local Inflow Ammonia Concentration
Type: Series Slot
Units: Concentration
Description: Ammonia concentration of Local Inflow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Local Inflow is not linked and is not valid, Local Inflow Ammonia Concentration is set to zero.
Diversion DO Concentration
Type: Series Slot
Units: Concentration
Description: Dissolved oxygen concentration of Diversion.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Diversion is not linked and is not valid, Diversion DO Concentration is set to zero.
Return Flow DO Concentration
Type: Series Slot
Units: Concentration
Description: Dissolved oxygen concentration of Return Flow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Return Flow is not linked and is not valid, Return Flow DO Concentration is set to zero.
Local Inflow DO Concentration
Type: Series Slot
Units: Concentration
Description: Dissolved oxygen concentration of Local Inflow.
I/O: Input, rules, solved for, or propagated across a link.
Links: If Local Inflow is not linked and is not valid, Local Inflow DO Concentration is set to zero.
Total Dissolved Gas Slots
Inflow TDG Concentration
Type: Series
Units: Fraction
Description: TDG concentration of the Inflow
I/O: Input or output
Links: Linked to upstream TDG concentration slot
Outflow TDG Concentration
Type: Series
Units: Fraction
Description: TDG concentration of the Outflow
I/O: Output only
Links: Linked to downstream TDG concentration slot
TDG Lag Time
Type: Scalar
Units: Time
Description: Amount of time the TDG concentration should be lagged from the Inflow to the Outflow
I/O: Required Input
Links: Not linkable
Number of TDG Dispersion Coefficients
Type: Scalar
Units: None
Description: Number of coefficients used to model TDG dispersion. The slot value must be an integer greater than or equal to 1, and it must equal the number of rows in the TDG Dispersion Coefficients slot.
I/O: Required Input
Links: Not linkable
TDG Dispersion Coefficients
Type: Table
Units: None, Fraction
Description: Coefficients used to model TDG dispersion; the first column contains the Lag Time Offset values, which must be integers in sequential order. The second column contains the Coefficients, which must sum to one. The Lag Time Offset is added to the TDG Lag Time to determine the timestep for which the Coefficient is applied to the Inflow TDG Concentration.
I/O: Required Input
Links: Not linkable
Lagged Dispersed TDG Concentration
Type: Series
Units: Fraction
Description: Calculated TDG concentration after lagging and dispersion have been applied to the Inflow TDG Concentration, before Dissipation has been applied
I/O: Output only
Links: Not linkable
TDG Dissipation Coefficient
Type: Scalar
Units: None
Description: A coefficient applied to the Lagged Dispersed TDG Concentration to calculate the TDG Dissipation
I/O: Required Input if TDG Dissipation is not specified
Links: Not linkable
TDG Dissipation Adjustment
Type: Scalar
Units: Fraction
Description: An adjustment or correction factor that is subtracted in the TDG Dissipation calculation (a positive value increases the Outflow TDG Concentration)
I/O: Optional input, defaults to zero
Links: Not linkable
TDG Dissipation
Type: Series
Units: Fraction
Description: Decrease in TDG concentration while in transit, subtracted from the Lagged Dispersed TDG Concentration to compute the Outflow TDG Concentration
I/O: Input or Output
Links: Not linkable
Delta Inflow
Type: Series
Units: Flow
Description: This slot represents the optimization variable for Delta Inflow
Links: Linkable
Delta Outflow
Type: Series
Units: Flow
Description: This slot represents the optimization variable for Delta Outflow.
Links: Linkable
Delta Inflow TDG Concentration
Type: Series
Units: Fraction
Description: This slot represents the optimization variable for Delta Inflow TDG Concentration.
Links: Linkable
Delta Outflow TDG Concentration
Type: Series
Units: Fraction
Description: This slot represents the optimization variable for Delta Inflow TDG Concentration.
Links: Linkable
Revised: 07/09/2023