pywrdrb.parameters.NYCFloodRelease

class pywrdrb.parameters.NYCFloodRelease(model, node, drought_level_reservoir, level1c, volume_reservoir, max_volume_reservoir, weekly_rolling_mean_flow_reservoir, max_release_reservoir, mrf_target_individual_reservoir, **kwargs)

Calculates any excess flood control releases needed to reduce NYC reservoir’s storage back down to level 1b/1c boundary within 7 days. See Page 21 FFMP for details.

node

The node associated with the parameter.

Type:

Node

drought_level_reservoir

The drought level reservoir parameter.

Type:

Parameter

level1c

The level 1c parameter.

Type:

Parameter

volume_reservoir

The volume reservoir parameter.

Type:

Parameter

max_volume_reservoir

The max volume reservoir parameter.

Type:

Parameter

weekly_rolling_mean_flow_reservoir

The weekly rolling mean flow reservoir parameter.

Type:

Parameter

max_release_reservoir

The max release reservoir parameter.

Type:

Parameter

mrf_target_individual_reservoir

The MRF target individual reservoir parameter.

Type:

Parameter

value(timestep, scenario_index)

Returns the excess flood control releases needed to reduce NYC reservoir’s storage.

Class Methods:

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

__init__(model, node, drought_level_reservoir, level1c, volume_reservoir, max_volume_reservoir, weekly_rolling_mean_flow_reservoir, max_release_reservoir, mrf_target_individual_reservoir, **kwargs)

Methods

__init__(model, node, ...)
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 excess flood control releases needed to reduce NYC reservoir's storage back down to level 1b/1c boundary within 7 days.

Attributes

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