The output node (API Reference) is a general output at any point from the network. Output nodes remove water from the system.
Output nodes are required at the end of a river and in this use case generally do not have an allocation penalty or max_flow assigned.
Output nodes are also used to represent consumptive water demands. In this use case, they tend to have negative allocation penalties assigned so that the linear program allocates water to them as well as a max_flow which can be either a constant or a parameter representing the water demand.
allocation penalty
The cost per unit flow via the node
Optional
max_flow
The maximum flow constraint on the node
Optional
min_flow
The minimum flow constraint on the node
Optional
coming soon...
Output nodes are locations where water leaves the system. Below are the most used water output nodes:
A loss link allows for the definition of a fixed proportional loss of flow that goes through this node. Loss links are often used to represent potable water treatment works which incur some process losses.
The Max and Min flow attributes that are defined are applied to the net output after losses.
The node itself records the net output in its flow attribute (which would be used by any attached recorders).
In this example 10% of the gross amount of water flowing into the node is lost.
Allocation Penalty
The cost per unit flow via the node
Optional
Loss factor
loss_factor : float or Parameter. The proportion of flow that is lost through this node. Must be greater than or equal to zero. This value is either a proportion of gross or net flow depending on the value of loss_factor_type
.
Optional, defaults to 0
Loss Factor Type
Either "gross" or "net" (default) to specify whether the loss factor is applied as a proportion of gross or net flow respectively.
Optional, defaults to "net"
Max Flow
The maximum flow constraint on the node
Optional
Min Flow
The minimum flow constraint on the node
Optional