Skip to content

RollingVirtualStorage Node

The RollingVirtualStorage node is a rolling virtual storage node useful for implementing rolling licences. API Reference.

Notes:

TODO: The cost property is not currently respected. See issue #242.

NameDescriptionRequired
allocation penaltyThe cost per unit flow via the nodeOptional
nodesList of inflow/outflow nodes that affect the storage volumeRequired
min_volumeThe minimum volume the storage is allowed to reachOptional
max_volumeThe maximum volume of the storageRequired, defaults to 0 if not entered
initial_volumeThe initial storage volumeOne is required
factorsList of factors to multiply node flow by. Positive factors remove water from the storage, negative factors remove it.Optional
timestepsThe number of timesteps to apply to the rolling storage overRequired
daysThe number of days to apply the rolling storage over. Specifying a number of days (instead of a number of timesteps) is only valid with models running a timestep of daily frequencyRequired

coming soon…