pywrdrb.parameters.VolBalanceLowerBasinMRFAggregate

pywrdrb.parameters.VolBalanceLowerBasinMRFAggregate#

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

Calculates total Trenton contribution from all lower basin reservoirs.

value(timestep, scenario_index)#: Checks how much lower basin reservoir release are needed & allowed to contribute to Trenton.

load(model, data)#: Load the VolBalanceLowerBasinMRFAggregate parameter.

release_needed_mrf_trenton#

Required MRF contributions for Trenton.

lower_basin_max_mrf_contributions#

Maximum MRF contributions from each lower basin reservoir.

drbc_lower_basin_reservoirs#

List of lower basin reservoirs.

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

Initialize the VolBalanceLowerBasinMRFAggregate parameter.

Parameters:

model (Model) – The pywrdrb.Model instance.
release_needed_mrf_trenton (Parameter) – Required contributions to maintain Trenton target.
lower_basin_max_mrf_contributions (dict) – Maximum contributions from each lower basin reservoir.
**kwargs – Additional keyword arguments.

Methods

`__init__`(model, release_needed_mrf_trenton, ...)	Initialize the VolBalanceLowerBasinMRFAggregate parameter.
`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)	Load the parameter from model data.
`register`(cls)
`reset`(self)
`set_double_variables`(self, double[)
`set_integer_variables`(self, int[)
`setup`(self)
`unregister`(cls)
`value`(timestep, scenario_index)	Calculate aggregate Trenton contribution from lower basin reservoirs.

Attributes