pywrdrb.parameters.NYCCombinedReleaseFactor

class pywrdrb.parameters.NYCCombinedReleaseFactor(model, node, drought_level_agg_nyc, mrf_drought_factor_agg_reservoir, mrf_drought_factor_individual_reservoir, **kwargs)

Decides whether an NYC reservoir’s release is dictated by its own storage (in the case of flood operations) or the aggregate storage across the three NYC reservoirs (in the case of normal or drought operations). It returns the “factor” which is a multiplier to baseline release value for the reservoir. See 8/30/2022 comment on this GitHub issue for the equation & logic: users/ahamilton144

Parameters:

• model (Model) – The Pywr model instance.

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

node

The node associated with the parameter.

Type:

Node

drought_level_agg_nyc

The drought level aggregate NYC parameter.

Type:

Parameter

mrf_drought_factor_agg_reservoir

The MRF drought factor aggregate reservoir parameter.

Type:

Parameter

mrf_drought_factor_individual_reservoir

The MRF drought factor individual reservoir parameter.

Type:

Parameter

value(timestep, scenario_index)

Returns the overall release factor for the NYC reservoir.

Class Methods:

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

__init__(model, node, drought_level_agg_nyc, mrf_drought_factor_agg_reservoir, mrf_drought_factor_individual_reservoir, **kwargs)

Methods

__init__(model, node, drought_level_agg_nyc, ...)
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)	Loads the parameter from model and data dictionary.
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup(self)
unregister(cls)
value(timestep, scenario_index)	Returns the overall release factor for the NYC reservoir, depending on whether it is flood stage (in which case we use the reservoirs individual storage) or normal/drought stage (in which case we use aggregate storage across the NYC reservoirs).

Attributes

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