VirtualStorage Node

General Description

The VirtualStorage node is a virtual storage unit. API Reference.

Notes:

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

Primary Attributes

Name
Description
Required

allocation penalty

The cost per unit flow via the node

Optional

nodes

List of inflow/outflow nodes that affect the storage volume

Required

min_volume

The minimum volume the storage is allowed to reach

Optional

max_volume

The maximum volume of the storage

Required, defaults to 0 if not entered

initial_volume

The initial storage volume

One is required

factors

List of factors to multiply node flow by. Positive factors remove water from the storage, negative factors remove it.

Optional

Examples

coming soon...

Last updated