pywrdrb.parameters.TotalReleaseNeededForDownstreamMRF

class pywrdrb.parameters.TotalReleaseNeededForDownstreamMRF(model, step, mrf, predicted_nonnyc_gage_flow_mrf, predicted_demand_nj, mrf_target_flow, release_needed_mrf_montague, mrf_target_individual_nyc, flood_release_nyc, previous_release_reservoirs, **kwargs)

Calculates the total releases needed from FFMP reservoirs to meet Montague or Trenton target, above and beyond their individual direct mandated releases and flood control releases.

model

The Pywr model instance.

Type:

Model

mrf

The MRF target for which we are calculating the total release needed.

Type:

str

step

The step in the calculation process, to account for lag travel to downstream sites.

Type:

int

predicted_nonnyc_gage_flow_mrf

The predicted non-NYC gage flow MRF parameter.

Type:

Parameter

predicted_demand_nj

The predicted demand NJ parameter.

Type:

Parameter

mrf_target_flow

The MRF target flow parameter.

Type:

Parameter

release_needed_mrf_montague

The release needed MRF Montague parameter.

Type:

Parameter

mrf_target_individual_nyc

The MRF target individual NYC parameter.

Type:

Parameter

flood_release_nyc

The flood release NYC parameter.

Type:

Parameter

previous_release_reservoirs

The list of previous release reservoirs parameters.

Type:

list

value(timestep, scenario_index)

Returns the total releases needed from FFMP reservoirs to meet Montague or Trenton target.

__init__(model, step, mrf, predicted_nonnyc_gage_flow_mrf, predicted_demand_nj, mrf_target_flow, release_needed_mrf_montague, mrf_target_individual_nyc, flood_release_nyc, previous_release_reservoirs, **kwargs)

Methods

__init__(model, step, mrf, ...)
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 total releases needed from FFMP reservoirs to meet Montague or Trenton target, above and beyond their individual direct mandated releases and flood control releases.

Attributes

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