pywr.parameters.FlowParameter

class pywr.parameters.FlowParameter(model, node, *args, **kwargs)

Parameter that provides the flow from a node from the previous time-step.

Parameters
modelpywr.model.Model
nodeNode

The node that will have its flow tracked

initial_valuefloat (default=0.0)

The value to return on the first time-step before the node has any past flow.

Notes

This parameter keeps track of the previous time step’s flow on the given 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 ts, ...)

Attributes

children

comment

comment: unicode

double_size

double_size: 'int'

initial_value

initial_value: 'double'

integer_size

integer_size: 'int'

is_constant

is_variable

is_variable: 'bool'

model

name

node

node: pywr._core.Node

parents

size

tags

tags: dict