pywrdrb.parameters.VolBalanceLowerBasinMRFAggregate

class pywrdrb.parameters.VolBalanceLowerBasinMRFAggregate(model, release_needed_mrf_trenton, lower_basin_max_mrf_contributions, **kwargs)

Calculate the aggregate MRF contribution from the lower basin reservoirs.

model

Pywr model

Type:

Model

debugging

Debugging flag

Type:

bool

release_needed_mrf_trenton

NYC and Lower Basin MRF contributions required

Type:

Parameter

lower_basin_max_mrf_contributions

Max MRF contributions from lower basin reservoirs

Type:

dict

drbc_lower_basin_reservoirs

List of lower basin reservoirs

Type:

list

value(timestep, scenario_index)

Return aggregate MRF contribution from the lower basin reservoirs.

__init__(model, release_needed_mrf_trenton, lower_basin_max_mrf_contributions, **kwargs)

Methods

__init__(model, release_needed_mrf_trenton, ...)
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)	Set up the VolBalanceLowerBasinMRFAggregate parameter.
register(cls)
reset(self)
set_double_variables(self, double[)
set_integer_variables(self, int[)
setup(self)
unregister(cls)
value(timestep, scenario_index)	Checks how much lower basin reservoir release are needed & allowed to contribute to MRF.

Attributes

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