pywr.parameters.DeficitParameter

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

Parameter track the deficit (max_flow - actual flow) of a Node

Parameters

modelpywr.model.Model

nodeNode

The node that will have it’s deficit tracked

Notes

This parameter is a little unusual in that it’s value is calculated during the after method, not calc_values. It is intended to be used in combination with a recorder (e.g. NumpyArrayNodeRecorder) to record the deficit ( defined as requested - actual flow) at a node. Note that this means recording this parameter does not give you the value that was used by the solver in this timestep. Alternatively, this parameter can be used in the model by other parameters and will evaluate to yesterdays deficit, where the deficit in the zeroth timestep is zero.

__init__(*args, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__(*args, **kwargs)	Initialize self.
after(self)
before(self)
finish(self)
get_all_values(self)
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’
integer_size	integer_size: ‘int’
is_variable	is_variable: ‘bool’
model
name
node	node: pywr._core.Node
parents
size