Reservoir Node

General Description

The reservoir node is a subclass of storage node with additional functionality to represent evaporation and precipitation. API Reference.

Primary Attributes

Name
Description
Required

allocation penalty

The cost per unit flow via the node

Optional

min_volume

The minimum volume of the storage. Defaults to 0.0

Optional

max_volume

The maximum volume of the storage. Defaults to 0.0

Required, otherwise defaults to 0

initial_volume, initial_volume_pc

Specify initial volume in either absolute or proportional terms. Both are required if max_volume is a parameter because the parameter will not be evaluated at the first time-step. If both are given and max_volume is not a Parameter, then the absolute value is ignored

One is required

area, level

Optional float or Parameter defining the area and level of the storage node. These values are accessible through the get_area and get_level methods respectively

Optional

evaporation, precipitation

Evaporation and precipitation rates (length/day)

Optional

unit_conversion

Conversion factor to convert precipitation and evaporation to required length/day units

Optional, default is 0.001 to convert mm/day for use with km2 reservoir area

evaporation penalty (evaporation cost)

Allocation penalty set on the evaporation output

Optional, defaults to -999

Examples

coming soon...

Last updated