pywr.parameters.StorageParameter

class pywr.parameters.StorageParameter(model, storage_node, use_proportional_volume=False, *args, **kwargs)

Parameter that provides the current volume from a storage node.

Parameters
modelpywr.model.Model
storage_nodeAbstractStorage

The node that will have its volume tracked

use_proportional_volumebool

An optional boolean only to switch between returning absolute or proportional volume.

Notes

This parameter returns the current volume of the given storage node. These values can be used in calculations for the current timestep as though this was any other parameter.

__init__(*args, **kwargs)

Methods

__init__(*args, **kwargs)

after(self)

before(self)

finish(self)

get_all_values(self)

get_constant_value(self)

Return a constant value.

get_double_lower_bounds(self)

get_double_upper_bounds(self)

get_double_variables(self)

get_integer_lower_bounds(self)

get_integer_upper_bounds(self)

get_integer_variables(self)

get_value(self, ScenarioIndex scenario_index)

load(type cls, model, data)

register(type cls)

reset(self)

set_double_variables(self, double[)

set_integer_variables(self, int[)

setup(self)

unregister(type cls)

value(self, Timestep timestep, ...)

Attributes

children

comment

comment: unicode

double_size

double_size: 'int'

integer_size

integer_size: 'int'

is_constant

is_variable

is_variable: 'bool'

model

name

parents

size

storage_node

storage_node: pywr._core.AbstractStorage

tags

tags: dict

use_proportional_volume

use_proportional_volume: 'bool'