pywrdrb.parameters.VolBalanceNYCDemand

class pywrdrb.parameters.VolBalanceNYCDemand(model, reservoir, nodes, max_volume_agg_nyc, volume_agg_nyc, max_flow_delivery_nyc, flow_agg_nyc, max_vol_reservoirs, vol_reservoirs, flow_reservoirs, hist_max_flow_delivery_nycs, mrf_target_individual_reservoirs, downstream_release_target_reservoirs, flood_release_reservoirs, **kwargs)

Updates the contribution to NYC deliveries made by each of the NYC reservoirs, in such a way as to balance the relative storages across the three reservoirs. See comments on this GitHub issue for the equations & logic: users/ahamilton144

Parameters:

• model (Model) – The Pywr model instance.

• node (Node) – The node associated with the parameter.

reservoir

The reservoir associated with the parameter.

Type:

str

node

The node associated with the parameter.

Type:

Node

max_volume_agg_nyc

The maximum volume aggregate NYC parameter.

Type:

Parameter

volume_agg_nyc

The volume aggregate NYC parameter.

Type:

Parameter

max_flow_delivery_nyc

The maximum flow delivery NYC parameter.

Type:

Parameter

flow_agg_nyc

The flow aggregate NYC parameter.

Type:

Parameter

max_vol_reservoir

The maximum volume reservoir parameter.

Type:

Parameter

vol_reservoir

The volume reservoir parameter.

Type:

Parameter

flow_reservoir

The flow reservoir parameter.

Type:

Parameter

value(timestep, scenario_index)

Returns the target NYC delivery for this reservoir to balance storages across reservoirs.

Class Methods:

load(model, data): Loads the parameter from model and data dictionary.

__init__(model, reservoir, nodes, max_volume_agg_nyc, volume_agg_nyc, max_flow_delivery_nyc, flow_agg_nyc, max_vol_reservoirs, vol_reservoirs, flow_reservoirs, hist_max_flow_delivery_nycs, mrf_target_individual_reservoirs, downstream_release_target_reservoirs, flood_release_reservoirs, **kwargs)

Methods

__init__(model, reservoir, nodes, ...)
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(model, data)	Setup the parameter.
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup(self)
unregister(cls)
value(self, Timestep ts, ...)

Attributes

children
comment	unicode
double_size	'int'
integer_size	'int'
is_constant
is_variable	'bool'
model
name
parents
size
tags	dict