Objects and Methods
Water User
The Water User object simulates the consumption and depletion of water, often from a reservoir or reach. A Water User object can exist as a standalone object on the workspace, or as an element of the Aggregate Diversion Site (Agg Diversion Site) object.
When the Water User object is an element of an Agg Diversion Site, the link structure selected on the Agg Diversion Site determines how the Water User elements interact with each other, the Agg Diversion Site, and the object from which water is being diverted (that is, Reach or Reservoir).
When the Water User is a standalone object on the workspace, it functions in the same manner as an element on an Agg Diversion Site using the default, No Structure, linking structure.
Three linking structures exist on the Agg Diversion Site object.
General Slots
The general slots exist on the Water User regardless of the type of linking structure on the Agg Diversion Site.
Depletion Requested
Type: Series Slot
Units: Flow
Description: Amount of water to be consumed, given the request is met
Information: Automatically linked to the Total Depletion Requested multislot on the Agg Diversion Site.
I/O: Input, output, or set by a rule
Links: Usually not linked
Diversion Requested
Type: Series Slot
Units: Flow
Description: Amount of water requested by the Water User
Information: Automatically linked to the Total Diversion Requested multislot on the Agg Diversion Site.
I/O: Input, output, or set by a rule
Links: Usually not linked
Water User Groups
Type: List Slot
Units: NA
Description: Contains the user-defined subbasins to which this Water User is a member. It can be used to encode and display attributes of the Water User. For example, a water user may only be able to use Imported Water while other water users may only use Basin Water. By defining a subbasin for Imported Water and one for Basin Water and adding the appropriate water users to each, you can keep summarize information about each group of users. Perhaps you wish to create an expression slot that sums up the total diversion requested for Imported Water. You can use the Imported Water subbasin. The Water User Groups slot then allows you to see, from each water user, the groups to which it belongs.
Information: This slot is a special type of list slot called Subbasin Membership List Slot. The values in the slot are the subbasins to which this water user is a member. To add/remove an entry from the slot, you must go to the subbasin manager and add/remove the water user from the particular subbasin. The slot does provide a menu option to open the subbasin manager File->Edit Subbasins.
I/O: Specified by subbasin membership.
Links: Not linkable
Standalone or No Structure Slots
In addition to the general slots, the following slots exist for a standalone water user, or when the parent Agg Diversion Site has the No Structure method selected.
Note: The No Structure method is the default linking structure.
Depletion
Type: Series Slot
Units: Flow
Description: Amount of water consumed by the water user
Information:
I/O: Output only
Links: Usually not linked
Depletion Shortage
Type: Series Slot
Units: Flow
Description: Difference between the Depletion Requested and the Depletion
Information: This value is only calculated if Depletion Requested and Depletion are both valid.
I/O: Output only
Links: Usually not linked
Diversion
Type: Series Slot
Units: Flow
Description: Amount of water actually taken (diverted) by the water user
Information:
I/O: Optional; Can be input or calculated based on Diversion Requested and Incoming Available Water (see dispatch methods).
Links: Must be linked to the Diversion slot on the object being diverted from if using the No Structure.
Diversion Shortage
Type: Series Slot
Units: Flow
Description: Difference between the Diversion Requested and the Diversion
Information:
I/O: Output only
Links: Usually not linked
Incoming Available Water
Type: Series Slot
Units: Flow
Description: Water available to be diverted
Information: It is the user’s responsibility to link this slot to the appropriate slot on the object from which water is diverted if using No Structure.
I/O: Set via link
Links: Must be linked to the Available for Diversion slot on the object being diverted from if using No Structure. If using the sequential structure it is automatically linked to the Agg Diversion Site Total Diversion.
Lumped Structure Slots
In addition to the general slots, the following slots exist when the parent Agg Diversion Site has the Lumped Structure selected.
Depletion Shortage
Type: Series Slot
Units: Flow
Description: Amount of the Depletion Request that could not be met.
Information: This value is calculated by the Agg Diversion Site when it dispatched. Depletion Requested must be valid. See “Process Lumped given Diversion Requested” for details.
I/O: Output only
Description: Usually not linked
Sequential Structure Slots
In addition to the general slots, the following slots exist when the parent Agg Diversion Site has the Sequential structure selected.
When the sequential linking structure is active, the Incoming Available Water slot on the first Water User element is automatically linked to the Total Diversion slot on the Agg Diversion Site.
Outgoing Available Water
Type: Series Slot
Units: Flow
Description: Portion of the Incoming Available Water that is unused by the Water User
Information:
I/O: Output only
Links: Automatically linked to the Incoming Available Water slot on the next Water User or to the Total Unused Water slot on the Agg Diversion Site if it is the last Water User.
Revised: 11/11/2019