pywrdrb.parameters.VolBalanceLowerBasinMRFIndividual

class pywrdrb.parameters.VolBalanceLowerBasinMRFIndividual(model, reservoir, lower_basin_agg_mrf_trenton, lower_basin_max_mrf_contributions, **kwargs)

Distributes Trenton contributions among individual lower basin reservoirs.

Allocates the required aggregate contribution to individual reservoirs based on their capacity and priority staging.

split_lower_basin_mrf_contributions(scenario_index)

Split the MRF contributions from the lower basin reservoirs into individual reservoir contributions.

value(timestep, scenario_index)

Return the contribution from this specific reservoir.

load(model, data)

Load and initialize the VolBalanceLowerBasinMRFIndividual parameter.

reservoir

Name of the reservoir.

Type:

str

lower_basin_agg_mrf_trenton

Aggregate MRF contribution required from lower basin.

Type:

Parameter

lower_basin_max_mrf_contributions

Maximum MRF contributions from each lower basin reservoir.

Type:

dict

drbc_lower_basin_reservoirs

List of lower basin reservoirs.

Type:

list

__init__(model, reservoir, lower_basin_agg_mrf_trenton, lower_basin_max_mrf_contributions, **kwargs)

Initialize the VolBalanceLowerBasinMRFIndividual parameter.

Parameters:

• model (Model) – The pywrdrb.Model instance.

• reservoir (str) – Name of the reservoir.

• lower_basin_agg_mrf_trenton (Parameter) – Aggregate MRF contribution required from lower basin.

• lower_basin_max_mrf_contributions (dict) – Maximum MRF contributions from each lower basin reservoir.

• **kwargs – Additional keyword arguments.

Methods

__init__(model, reservoir, ...)	Initialize the VolBalanceLowerBasinMRFIndividual 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)
split_lower_basin_mrf_contributions(...)	Split aggregate Trenton contribution among individual reservoirs.
unregister(cls)
value(timestep, scenario_index)	Calculate Trenton contribution for this specific reservoir.

Attributes

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