{ "cells": [ { "cell_type": "markdown", "id": "fa98ee2b", "metadata": {}, "source": [ "(reservoir)=\n", "# reservoir\n", "A reservoir that is part of a regulated hydropower watercourse\n", "\n", "| | |\n", "|---|---|\n", "|Input connections|{ref}`plant`, {ref}`gate`, {ref}`junction`, {ref}`volume_constraint`, {ref}`cut_group`, {ref}`inflow_series`, {ref}`tunnel`, {ref}`river`|\n", "|Output connections|{ref}`plant`, {ref}`river`, {ref}`gate`, {ref}`tunnel`, {ref}`cut_group`, {ref}`inflow_series`, {ref}`junction_gate`, {ref}`junction`, {ref}`creek_intake`, {ref}`volume_constraint`|\n", "|License|SHOP_OPEN|\n", "|Release version|13.0.0.a|\n", "\n", "```{contents}\n", ":local:\n", ":depth: 1\n", "```\n", "\n", "\n", "\n", "## Required input \n", "The reservoir object is one of the fundamental building blocks of a SHOP model, and has the following mandatory input attributes:\n", "- [max_vol](reservoir:max_vol): Maximum volume of the reservoir at the point of forced overflow.\n", "- [lrl](reservoir:lrl): Lowest regulated level, should correspond to zero volume stored.\n", "- [hrl](reservoir:hrl): Highest regulated level, should correspond to max_vol volume stored.\n", "- [vol_head](reservoir:vol_head): The relation between reservoir volume and level (masl).\n", "- [start_head](reservoir:start_head) / [start_vol](reservoir:start_vol): The reservoir level at the beginning of the optimisation, either given in masl or Mm3.\n", "\n", "## Volume and level\n", "The relation between volume and level is required and given by the [vol_head](reservoir:vol_head) attribute, which is a piecewise linear [XY-curve](datatype:xy). The vol_head curve should go above the point (max_vol, hrl) to describe overflow situations. The total reservoir volume before forced overflow is given by [max_vol](reservoir:max_vol). The [max_vol](reservoir:max_vol) attribute can either represent only the active volume or the full volume of the reservoir. If only the active volume is considered, [lrl](reservoir:lrl) will coincide with zero volume.\n", "\n", "\n", "## Reservoir level limit constraints\n", "The user can specify different types of reservoir limits to enforce correct physical behaviour and to enforce different physical and environmental restrictions. Figure 1 illustrates the available reservoir level limits and Table 1 gives an overview of their related inputs and outputs. \n", "\n", "|![](./img/reservoir_limits.png)|\n", "|---|\n", "|Figure 1: Overview of reservoir limit types.|\n", "\n", "|Attribute|Constraint type|Penalty input|Penalty output|Objective|\n", "|---|---|---|---|---|\n", "|[flow_descr](reservoir:flow_descr) \\[meter\\]||[overflow_cost](reservoir:overflow_cost)||[nonphysical_spill_cost](objective:nonphysical_spill_cost), [physical_spill_cost](objective:physical_spill_cost)|\n", "|[max_vol](reservoir:max_vol),[hrl](reservoir:hrl)|soft|[penalty_cost](penalty_cost)|[penalty](reservoir:penalty), [endpoint_penalty](reservoir:endpoint_penalty)|[rsv_penalty](objective:rsv_penalty), [rsv_end_penalty](objective:rsv_end_penalty)|\n", "|[max_vol_constr](reservoir:max_vol_constr)|hard|||||\n", "|[tactical_limit_max](reservoir:tactical_limit_max)|soft|[tactical_cost_max](reservoir:tactical_cost_max)|[tactical_penalty_up](reservoir:tactical_penalty_up), [tactical_penalty](reservoir:tactical_penalty)|[rsv_tactical_penalty](objective:rsv_tactical_penalty)|\n", "|[tactical_limit_min](reservoir:tactical_limit_min)|soft|[tactical_cost_min](reservoir:tactical_cost_min)|[tactical_penalty_down](reservoir:tactical_penalty_down), [tactical_penalty](reservoir:tactical_penalty)|[rsv_tactical_penalty](objective:rsv_tactical_penalty)|\n", "|[min_vol_constr](reservoir:min_vol_constr)|hard|||||\n", "|[lrl](reservoir:lrl)|soft|[penalty_cost](penalty_cost)|[penalty](reservoir:penalty), [endpoint_penalty](reservoir:endpoint_penalty), [end_penalty](reservoir:end_penalty)|[rsv_penalty](objective:rsv_penalty), [rsv_end_penalty](objective:rsv_end_penalty)|\n", "\n", "The outer limits are typically [max_vol](reservoir:max_vol), [hrl](reservoir:hrl) and [lrl](reservoir:lrl), which represent the physical limts the system is designed for and regulated to operate within. These are soft constraints, allowing SHOP to provide a solution even in situations where the input is overspecified so that no physical solution exist. In this case, a penalty will be applied. \n", "\n", "The [min_vol_constr](reservoir:min_vol_constr) and [max_vol_constr](reservoir:max_vol_constr) are time dependent operation constraints. These can, for example, be used if the system must be operated within given limits due to maintenance. However, hard constraints should be used carefully since they may cause infeasibility or non-physical behaviour in other parts of the system.\n", "\n", "The tactical limits, [tactical_limit_min](reservoir:tactical_limit_min) and [tactical_limit_max](reservoir:tactical_limit_max), let the user specify time dependent soft constraints at a time dependent self defined cost.\n", "\n", "Additionally, the reservoir level can be constrained by ramping constraints, such as [level_ramping_up](reservoir:level_ramping_up), [level_ramping_down](reservoir:level_ramping_down), and the [dynamic_level_limit](reservoir:dynamic_level_limit) constraint. \n", "\n", "\n", "## Overflow\n", "In reservoirs where overflow may occur, the [vol_head](reservoir:vol_head) curve must also contain the relevant space above the [hrl](reservoir:hrl) and max_vol. To ensure that the spilled water is directed to the right reservoir and assigned a reasonable penalty cost, the reservoir object should be connected to a [](river), with the river [](river:upstream_elevation) equal to the reservoir hrl. The overflow rate as a function of the reservoir level is then described by the [up_head_flow_curve](river:up_head_flow_curve), and an overflow penalty can be given by setting the river [flow_cost](river:flow_cost). The river can be connected to a downstream reservoir if the spillage should be directed there instead of to the ocean. This is described in more detail in the [overflow example](reservoir-overflow).\n", "\n", "Previously, the {ref}`gate` object has been used for overflow modelling. Gate objects will be removed in SHOP 19 (2027 Q2), and so using rivers is the recommended way for future compatibility. To model overflow using gates, the upstream reservoir has to been connected to the gate using connection type **SPILL**. Overflow is described by the [flow_descr](reservoir:flow_descr) [XY-curve](datatype:xy), where the x-values represents reservoir levels and the y-values are the overflow rates in $m^3/s$. The first xy pair must be [hrl](reservoir:hrl) and zero, meaning that there is no overflow at [hrl](reservoir:hrl). The following xy pairs must have increasing x and y values.\n", "\n", "### Physical overflow description\n", "The overflow description is a linear relaxation, hence overflow may occur in situations where it is not physically possible. SHOP includes a MIP formulation that can be used to prevent this, which can be activated using the river [mip_flag](river:mip_flag), reservoir [overflow_mip_flag](reservoir:overflow_mip_flag), or [universal_overflow_mip](global_settings:universal_overflow_mip). See the [overflow modelling example](reservoir-overflow) for further details.\n", "\n", "\n", "## Water values\n", "The value of stored water beyond the optimization horizon will typically come from a seasonal- or long-term model. Details on how to set the water values can be found [here](water-value-descriptions). Se also the [individual water values example](individual-water-values).\n", "\n", "### Reservoir schedule, slack and cut descriptions\n", "Reservoir [schedule](reservoir:schedule) can be used instead of water values to impose a specific strategy on a reservoir. Since this limits the way the system can be operated, it should be used very carefully. A schedule can be set either for the end value or for specific moments throughout the optimization period. The reservoir [upper_slack](reservoir:upper_slack) and [lower_slack](reservoir:lower_slack) limits can be used in combination with a reservoir schedule. When upper_slack and/or lower_slack is used together with a schedule, the reservoir trajectory is bound to be within the upper_slack and lower_slack values. If only one of the slack parameters are given, the reservoir schedule will act as the missing upper/lower bound.\n", "\n", "For further details on the use of reservoir schedule see the [reservoir schedule example](reservoir-schedule).\n", "\n", "## Ramping\n", "Ramping constraints limit how rapidly the volume or head of a reservoir can change over time, for example, to avoid excessive wear of the reservoir shores. Ramping constraints can be set individually for the up and down direction. They can be set in terms of volume with [volume_ramping_up](reservoir:volume_ramping_up) and [volume_ramping_down](reservoir:volume_ramping_down), or in terms of level with [level_ramping_up](reservoir:level_ramping_up) and [level_ramping_down](reservoir:level_ramping_down). \n", "\n", "Other ramping constraint types include [level_amplitude_ramping_limit_up](reservoir:level_amplitude_ramping_limit_up), [level_amplitude_ramping_limit_down](reservoir:level_amplitude_ramping_limit_down), [level_nonseq_ramping_limit_up](reservoir:level_nonseq_ramping_limit_up) and [level_nonseq_ramping_limit_down](reservoir:level_nonseq_ramping_limit_down), demonstrated in the [amplitude and non-sequential ramping example](reservoir-amplitude-nonseq-ramping). Complex ramping is demonstrated in the [complex ramping on reservoir level example](reservoir-complex-ramping). The complex ramping types include [limit_level_period_ramping_up](reservoir:limit_level_period_ramping_up), [limit_level_period_ramping_down](reservoir:limit_level_period_ramping_down), [average_level_rolling_ramping_up](reservoir:average_level_rolling_ramping_up) and [average_level_rolling_ramping_down](reservoir:average_level_rolling_ramping_down). The [dynamic_level_limit](reservoir:dynamic_level_limit) constraint is similar to the limit period level ramping, except the difference in reservoir level is found within the same time period instead of between consecutive time periods. See the\n", "[reservoir dynamic level limit example](reservoir-dynamic-level-limit) for more information about this constraint.\n", "\n", "## Examples\n", " - [](cut-description)\n", " - [](water-value-descriptions)\n", " - [](individual-water-values)\n", " - [](ramping)\n", " - [](reservoir-overflow)\n", " - [](reservoir-schedule)\n", " - [](reservoir-complex-ramping)\n", " - [](creek-intake-example)\n", " - [](reservoir-dynamic-level-limit)\n", " - [](reservoir-amplitude-nonseq-ramping)\n", " \n", "\n", "## References\n", " - Modelling overflow using mixed integer programming in short-term hydropower scheduling {cite}`Litlabo2023`\n", " \n", "\n", "## Attributes" ] }, { "cell_type": "code", "execution_count": 1, "id": "34a8139b", "metadata": { "tags": [ "remove-input", "full-width" ] }, "outputs": [ { "data": { "text/html": [ "
\n", "\n" ], "text/plain": [ "" ] }, "execution_count": 1, "metadata": {}, "output_type": "execute_result" } ], "source": [ "from IPython.core.display import HTML\n", "HTML(\"\"\"
\n", "\n", "\"\"\")" ] }, { "cell_type": "markdown", "id": "11a94601", "metadata": {}, "source": [ "(reservoir:latitude)=\n", "### latitude\n", "Reserved for future use. Unit: NO_UNIT.\n", "\n", "\n", "(reservoir:longitude)=\n", "### longitude\n", "Reserved for future use. Unit: NO_UNIT.\n", "\n", "\n", "(reservoir:max_vol)=\n", "### max_vol\n", "Maximum volume of the reservoir. Unit: MM3.\n", "\n", "\n", "(reservoir:lrl)=\n", "### lrl\n", "Lowest Regulation Level (meter above sea level) of the reservoir. Unit: METER.\n", "\n", "\n", "(reservoir:hrl)=\n", "### hrl\n", "Highest Regulation Level (meter above sea level) of the reservoir. Unit: METER.\n", "\n", "\n", "(reservoir:vol_head)=\n", "### vol_head\n", "The volume (Mm3) and water level (meter above sea level) relation of the reservoir. The list should cover all feasible reservoir level values so that the volume-head conversion is always successful. Units: x: MM3 and y: METER.\n", "\n", "\n", "(reservoir:head_area)=\n", "### head_area\n", "The water level (meter above sea level) and surface area (Km2) relation of the reservoir. Units: x: METER and y: KM2.\n", "\n", "\n", "(reservoir:elevation_adjustment)=\n", "### elevation_adjustment\n", "Adjustment for the lowest regulation level (lrl), highest regulation level (hrl), and the volume (Mm3) and water level (meter above sea level) relation of the reservoir. Unit (y): METER.\n", "\n", "\n", "(reservoir:start_vol)=\n", "### start_vol\n", "Reservoir start volume. If start_vol and start_head are both defined, the value of the prefer_start_vol attribute on global_settings will decide which is used. Unit: MM3.\n", "\n", "\n", "(reservoir:start_head)=\n", "### start_head\n", "Reservoir start water level (meter above sea level). If start_vol and start_head are both defined, the value of the prefer_start_vol attribute on global_settings will decide which is used. Unit: METER.\n", "\n", "\n", "(reservoir:inflow)=\n", "### inflow\n", "Natural inflow to reservoir. Unit (y): M3/S.\n", "\n", "\n", "(reservoir:inflow_flag)=\n", "### inflow_flag\n", "Flag determining whether the inflow to a reservoir should be used as input or calculated as output in the simulation: 0 = input; 1 = output. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:sim_inflow_flag)=\n", "### sim_inflow_flag\n", "Flag determining whether inflow should be simulated to reservoir or not. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:flow_descr)=\n", "### flow_descr\n", "The water level (meter above sea level) and overflow (m3/s) relation of the reservoir. Only used when a spill gate is connected, please see the overflow modelling example. Units: x: METER and y: M3/S.\n", "\n", "\n", "(reservoir:overflow_mip_flag)=\n", "### overflow_mip_flag\n", "Flag determining whether the binary variables should be used to prevent non-physical spill. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:overflow_cost)=\n", "### overflow_cost\n", "Overflow cost for the reservoir. Unit (y): NOK/MM3.\n", "\n", "\n", "(reservoir:overflow_cost_flag)=\n", "### overflow_cost_flag\n", "Flag determining whether overflow cost for this reservoir should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:min_vol_constr)=\n", "### min_vol_constr\n", "Time-dependent minimum volume limit for the reservoir. Unit (y): MM3.\n", "\n", "\n", "(reservoir:min_vol_constr_flag)=\n", "### min_vol_constr_flag\n", "Flag determining whether the time-dependent minimum volume limit for the reservoir should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:max_vol_constr)=\n", "### max_vol_constr\n", "Time-dependent maximum volume limit for the reservoir. Unit (y): MM3.\n", "\n", "\n", "(reservoir:max_vol_constr_flag)=\n", "### max_vol_constr_flag\n", "Flag determining whether the time-dependent maximum volume limit for the reservoir should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:min_head_constr)=\n", "### min_head_constr\n", "Time-dependent minimum water level limit for the reservoir. The min_vol_constr attribute is preferred if it is present for the same reservoir. Unit (y): METER.\n", "\n", "\n", "(reservoir:min_head_constr_flag)=\n", "### min_head_constr_flag\n", "Flag determining whether the time-dependent minimum water level limit for the reservoir should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:max_head_constr)=\n", "### max_head_constr\n", "Time-dependent maximum water level limit for the reservoir. The max_vol_constr attribute is preferred if it is present for the same reservoir. Unit (y): METER.\n", "\n", "\n", "(reservoir:max_head_constr_flag)=\n", "### max_head_constr_flag\n", "Flag determining whether the time-dependent maximum water level limit for the reservoir should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:tactical_limit_min)=\n", "### tactical_limit_min\n", "Tactical (soft) minimum volume limit for the reservoir. Unit (y): MM3.\n", "\n", "\n", "(reservoir:tactical_limit_min_flag)=\n", "### tactical_limit_min_flag\n", "Flag determining whether the tactical minimum volume limit should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:tactical_cost_min)=\n", "### tactical_cost_min\n", "Given penalty cost for violating the tactical minimum volume limit for the reservoir. Unit (y): NOK/MM3H.\n", "\n", "\n", "(reservoir:tactical_cost_min_flag)=\n", "### tactical_cost_min_flag\n", "Flag determining whether the penalty cost for violating the tactical minimum volume limit should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:tactical_limit_max)=\n", "### tactical_limit_max\n", "Tactical (soft) maximum volume limit for the reservoir. Unit (y): MM3.\n", "\n", "\n", "(reservoir:tactical_limit_max_flag)=\n", "### tactical_limit_max_flag\n", "Flag determining whether the tactical maximum volume limit should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:tactical_cost_max)=\n", "### tactical_cost_max\n", "Given penalty cost for violating the tactical maximum volume limit for the reservoir. Unit (y): NOK/MM3H.\n", "\n", "\n", "(reservoir:tactical_cost_max_flag)=\n", "### tactical_cost_max_flag\n", "Flag determining whether the penalty cost for violating the tactical maximum volume limit should be included in the optimization model. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:tactical_level_limit_min)=\n", "### tactical_level_limit_min\n", "Tactical minimum level limit for the reservoir. Unit (y): METER.\n", "\n", "\n", "(reservoir:tactical_level_limit_max)=\n", "### tactical_level_limit_max\n", "Tactical maximum level limit for the reservoir. Unit (y): METER.\n", "\n", "\n", "(reservoir:upper_slack)=\n", "### upper_slack\n", "Used to expand the upper reservoir limit when running with an active reservoir schedule so that the volume can be between the schedule and upper_slack. Unit (y): MM3.\n", "\n", "\n", "(reservoir:lower_slack)=\n", "### lower_slack\n", "Used to expand the lower reservoir limit when running with an active reservoir schedule so that the volume can be between the schedule and lower_slack. Unit (y): MM3.\n", "\n", "\n", "(reservoir:schedule)=\n", "### schedule\n", "Reservoir volume schedule used to specify the volume of the reservoir in each time step. Must be combined with a schedule_flag to be active. Unit (y): MM3.\n", "\n", "\n", "(reservoir:schedule_flag)=\n", "### schedule_flag\n", "Flag determining whether the reservoir volume schedule should be included in the optimization model: 0 = no schedule; 1 = the endpoint interval upper_slack and lower_slack is valid; 2 = reservoir volume schedule is valid anywhere during the optimization period. Unit (y): NO_UNIT.\n", "\n", "\n", "(reservoir:sim_volume_schedule)=\n", "### sim_volume_schedule\n", "Reservoir volume schedule used in the SHOP simulator when simulating reservoir inflow with the /inflow command option. The sim_volume_schedule takes precedence over the sim_level_schedule if both are defined. If neither attribute is defined, the storage attribute (result from the optimization) is used. Unit (y): MM3.\n", "\n", "\n", "(reservoir:sim_level_schedule)=\n", "### sim_level_schedule\n", "Reservoir water level schedule used in the SHOP simulator when simulating reservoir inflow with the /inflow command option. The sim_volume_schedule takes precedence over the sim_level_schedule if both are defined. If neither attribute is defined, the storage attribute (result from the optimization) is used. Unit (y): METER.\n", "\n", "\n", "(reservoir:volume_ramping_up)=\n", "### volume_ramping_up\n", "Maximum limit for increase in reservoir volume per hour. Unit (y): MM3/HOUR.\n", "\n", "\n", "(reservoir:volume_ramping_down)=\n", "### volume_ramping_down\n", "Maximum limit for decrease in reservoir volume per hour. Unit (y): MM3/HOUR.\n", "\n", "\n", "(reservoir:level_ramping_up)=\n", "### level_ramping_up\n", "Maximum limit for increase in reservoir level per hour. Unit (y): METER/HOUR.\n", "\n", "\n", "(reservoir:level_ramping_down)=\n", "### level_ramping_down\n", "Maximum limit for decrease in reservoir level per hour. Unit (y): METER/HOUR.\n", "\n", "\n", "(reservoir:water_value_input)=\n", "### water_value_input\n", "The input water value description of water values referred to the sea. Can be a single constant value, a water value table (xy), or cut coefficients for a single or multiple price nodes. In the case of price dependent cut coefficients, the reference value of each xy in the xy_array should be the relevant price level. Units: x: MM3 and y: NOK/MM3.\n", "\n", "\n", "(reservoir:energy_value_input)=\n", "### energy_value_input\n", "The input local energy value of the reservoir which will be converted to a global water value internally. Unit: NOK/MWH.\n", "\n", "\n", "(reservoir:peak_volume_cost_curve)=\n", "### peak_volume_cost_curve\n", "A piece-wise constant increasing cost which is applied to the highest reservoir volume reached in the optimization horizon. Units: x: MM3 and y: NOK/MM3.\n", "\n", "\n", "(reservoir:flood_volume_cost_curve)=\n", "### flood_volume_cost_curve\n", "A piece-wise constant increasing cost curve which is used to penalize the reservoir volume level in each hour of the optimzation. Units: x: MM3 and y: NOK/MM3.\n", "\n", "\n", "(reservoir:evaporation_rate)=\n", "### evaporation_rate\n", "Evaporation rate of water from the reservoir. Unit (y): METER/HOUR.\n", "\n", "\n", "(reservoir:level_rolling_ramping_penalty_cost)=\n", "### level_rolling_ramping_penalty_cost\n", "The penalty cost for breaking any rolling ramping constraint applied to the reservoir level. Unit (y): NOK/METER.\n", "\n", "\n", "(reservoir:level_period_ramping_penalty_cost)=\n", "### level_period_ramping_penalty_cost\n", "The penalty cost for breaking any period ramping constraint applied to the reservoir level. Unit (y): NOK/METER.\n", "\n", "\n", "(reservoir:average_level_rolling_ramping_up)=\n", "### average_level_rolling_ramping_up\n", "Input to specify rolling ramping constraints that constrain the reservoir level upwards from the average reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can increase above the average rolling level. Each (x, y) point in each xy curve represents a rolling ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:average_level_rolling_ramping_down)=\n", "### average_level_rolling_ramping_down\n", "Input to specify rolling ramping constraints that constrain the reservoir level downwards from the average reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can decrease below the average rolling level. Each (x, y) point in each xy curve represents a rolling ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:limit_level_rolling_ramping_up)=\n", "### limit_level_rolling_ramping_up\n", "Input to specify rolling ramping constraints that constrain the reservoir level upwards from the minimal reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can increase above the minimal rolling level. Each (x, y) point in each xy curve represents a rolling ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:limit_level_rolling_ramping_down)=\n", "### limit_level_rolling_ramping_down\n", "Input to specify rolling ramping constraints that constrain the reservoir level downwards from the maximal reservoir level in a rolling time window. The x-values represent the length of the rolling time window and the y-values specify the number of meters the reservoir level can decrease below the maximal rolling level. Each (x, y) point in each xy curve represents a rolling ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:average_level_period_ramping_up)=\n", "### average_level_period_ramping_up\n", "Input to specify period ramping constraints that constrain the reservoir level upwards from the average reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can increase above the average level in the previous fixed time period. Each (x, y) point in each xy curve represents a period ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:average_level_period_ramping_down)=\n", "### average_level_period_ramping_down\n", "Input to specify period ramping constraints that constrain the reservoir level downwards from the average reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can decrease below the average level in the previous fixed time period. Each (x, y) point in each xy curve represents a period ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:limit_level_period_ramping_up)=\n", "### limit_level_period_ramping_up\n", "Input to specify period ramping constraints that constrain the reservoir level upwards from the minimal reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can increase above the minimal level in the previous fixed time period. Each (x, y) point in each xy curve represents a period ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:limit_level_period_ramping_down)=\n", "### limit_level_period_ramping_down\n", "Input to specify period ramping constraints that constrain the reservoir level downwards from the maximal reservoir level in a fixed time window. The x-values represent the length of the fixed time window and the y-values specify the number of meters the reservoir level can decrease below the maximal level in the previous fixed time period. Each (x, y) point in each xy curve represents a period ramping constraint. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:historical_level)=\n", "### historical_level\n", "The reservoir level for times before the optimization start. The input start volume or start level of the reservoir will override any value in this time series that corresponds to the start time of the optimization, values inside the optimization horizon are ignored. The datatype of this attribute changed from xy to txy in version 15.3.1.0. Unit (y): METER.\n", "\n", "\n", "(reservoir:average_level_period_ramping_up_offset)=\n", "### average_level_period_ramping_up_offset\n", "The y-values must be the same as the period lengths used in the average_level_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping up period constraints. Units: s: STRING and y: MINUTE.\n", "\n", "\n", "(reservoir:average_level_period_ramping_down_offset)=\n", "### average_level_period_ramping_down_offset\n", "The y-values must be the same as the period lengths used in the average_level_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the average ramping down period constraints. Units: s: STRING and y: MINUTE.\n", "\n", "\n", "(reservoir:limit_level_period_ramping_up_offset)=\n", "### limit_level_period_ramping_up_offset\n", "The y-values must be the same as the period lengths used in the limit_level_period_ramping_up attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping up period constraints. Units: s: STRING and y: MINUTE.\n", "\n", "\n", "(reservoir:limit_level_period_ramping_down_offset)=\n", "### limit_level_period_ramping_down_offset\n", "The y-values must be the same as the period lengths used in the limit_level_period_ramping_down attribute, while the strings are timestamps that specify when the first whole ramping period starts for each of the limit ramping up period constraints. Units: s: STRING and y: MINUTE.\n", "\n", "\n", "(reservoir:volume_nonseq_ramping_limit_up)=\n", "### volume_nonseq_ramping_limit_up\n", "Limit volume ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: MM3.\n", "\n", "\n", "(reservoir:volume_nonseq_ramping_limit_down)=\n", "### volume_nonseq_ramping_limit_down\n", "Limit volume ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: MM3.\n", "\n", "\n", "(reservoir:volume_amplitude_ramping_limit_up)=\n", "### volume_amplitude_ramping_limit_up\n", "Limit volume ramping between in time interval. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: MM3.\n", "\n", "\n", "(reservoir:volume_amplitude_ramping_limit_down)=\n", "### volume_amplitude_ramping_limit_down\n", "Limit volume ramping between in time interval. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: MM3.\n", "\n", "\n", "(reservoir:level_nonseq_ramping_limit_up)=\n", "### level_nonseq_ramping_limit_up\n", "Limit level ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:level_nonseq_ramping_limit_down)=\n", "### level_nonseq_ramping_limit_down\n", "Limit level ramping between two non-sequential time steps. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:level_amplitude_ramping_limit_up)=\n", "### level_amplitude_ramping_limit_up\n", "Limit level ramping between in time interval. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:level_amplitude_ramping_limit_down)=\n", "### level_amplitude_ramping_limit_down\n", "Limit level ramping between in time interval. Start time is given by time T, duration by X and ramping by Y. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:dynamic_level_limit)=\n", "### dynamic_level_limit\n", "Input to specify the maximum difference between the max and min reservoir level within given time periods. The x-values represent the length of the fixed time period and the y-values specify the max difference in reservoir level within that time period. Units: x: MINUTE and y: METER.\n", "\n", "\n", "(reservoir:dynamic_level_limit_offset)=\n", "### dynamic_level_limit_offset\n", "The y-values must be the same as the period lengths used in the dynamic_level_limit attribute, while the strings are timestamps that specify when the first whole dynamic level limit period starts for each of the dynamic level limit constraints. Units: s: STRING and y: MINUTE.\n", "\n", "\n", "(reservoir:dynamic_level_limit_penalty_cost)=\n", "### dynamic_level_limit_penalty_cost\n", "The penalty cost for breaking the dynamic reservoir level limits. Unit (y): NOK/METER.\n", "\n", "\n", "(reservoir:storage)=\n", "### storage\n", "Resulting reservoir volume, includes both the start volume and the final end volume in the optimization. Unit (y): MM3.\n", "\n", "\n", "(reservoir:sim_storage)=\n", "### sim_storage\n", "Simulated reservoir volume. Unit (y): MM3.\n", "\n", "\n", "(reservoir:head)=\n", "### head\n", "Resulting reservoir water level (meter above sea level), calculated by converting the volume of the reservoir with the vol_head_curve. Unit (y): METER.\n", "\n", "\n", "(reservoir:area)=\n", "### area\n", "Resulting reservoir surface area (km2), used to calculate evaporation. Unit (y): KM2.\n", "\n", "\n", "(reservoir:sim_head)=\n", "### sim_head\n", "Simulated reservoir water level (meter above sea level). Unit (y): METER.\n", "\n", "\n", "(reservoir:sim_inflow)=\n", "### sim_inflow\n", "Simulated inflow to the reservoir that is calculated when the SHOP simulator is used to calculate inflow with the /inflow command option. Unit (y): M3/S.\n", "\n", "\n", "(reservoir:sim_water_surplus)=\n", "### sim_water_surplus\n", "Simulated reservoir volume that has been subtracted from the simulation to maintain the reservoir below the maximal volume defined in the vol_head curve. Similar to reservoir penalty from the optimization. Unit (y): MM3.\n", "\n", "\n", "(reservoir:sim_water_deficit)=\n", "### sim_water_deficit\n", "Simulated reservoir volume that has been added from the simulation to maintain the reservoir above 0 Mm3. Similar to reservoir penalty from the optimization. Unit (y): MM3.\n", "\n", "\n", "(reservoir:endpoint_penalty)=\n", "### endpoint_penalty\n", "Resulting penalty when the maximum or minimum volume limit for the reservoir at the end of the optimization period is violated. Unit (y): MM3.\n", "\n", "\n", "(reservoir:penalty)=\n", "### penalty\n", "Resulting penalty when the maximum or minimum volume limit for the reservoir during the optimization period is violated. Unit (y): MM3.\n", "\n", "\n", "(reservoir:tactical_penalty_up)=\n", "### tactical_penalty_up\n", "Resulting penalty when the tactical maximum volume limit for the reservoir is violated. Unit (y): MM3.\n", "\n", "\n", "(reservoir:tactical_penalty_down)=\n", "### tactical_penalty_down\n", "Resulting penalty when the tactical minimum volume limit for the reservoir is violated. Unit (y): MM3.\n", "\n", "\n", "(reservoir:end_penalty)=\n", "### end_penalty\n", "Resulting penalty cost when the maximum or minimum volume limit for the reservoir at the end of the optimization period is violated. Unit (y): NOK.\n", "\n", "\n", "(reservoir:penalty_nok)=\n", "### penalty_nok\n", "Resulting penalty cost when the maximum or minimum volume limit for the reservoir during the optimization period is violated. Unit (y): NOK.\n", "\n", "\n", "(reservoir:tactical_penalty)=\n", "### tactical_penalty\n", "Resulting penalty cost when the tactical maximum or minimum volume limit for the reservoir is violated. Unit (y): NOK.\n", "\n", "\n", "(reservoir:water_value_global_result)=\n", "### water_value_global_result\n", "Marginal cost of 1 Mm3 of the water in the reservoir calculated using the sum of the best efficiency point of all cascaded plants below this reservoir. Unit (y): NOK/MM3.\n", "\n", "\n", "(reservoir:water_value_local_result)=\n", "### water_value_local_result\n", "Marginal cost of 1 Mm3 of the water discharged from the reservoir through the downstream plant. Unit (y): NOK/MM3.\n", "\n", "\n", "(reservoir:energy_value_local_result)=\n", "### energy_value_local_result\n", "Marginal cost of 1 MWh power that generated from the water in the reservoir through the downstream plant. Unit (y): NOK/MWH.\n", "\n", "\n", "(reservoir:end_value)=\n", "### end_value\n", "Value of reservoir contents at the end of the optimization period. Unit (y): NOK.\n", "\n", "\n", "(reservoir:change_in_end_value)=\n", "### change_in_end_value\n", "Relative change in value of reservoir contents between the start and the end of the optimization horizon. Unit (y): NOK.\n", "\n", "\n", "(reservoir:vow_in_transit)=\n", "### vow_in_transit\n", "Value of delayed water on its way to this reservoir after the end of the optimization period. Unit (y): NOK.\n", "\n", "\n", "(reservoir:calc_global_water_value)=\n", "### calc_global_water_value\n", "The resulting global water value of the reservoir after the local energy value has been converted internally based on the energy_conversion_factor reservoir attribute. Unit: NOK/MM3.\n", "\n", "\n", "(reservoir:energy_conversion_factor)=\n", "### energy_conversion_factor\n", "The calculated conversion factor between MWh and Mm3 based on the first plant below the reservoir and initial start head. Unit: MWH/MM3.\n", "\n", "\n", "(reservoir:water_value_cut_result)=\n", "### water_value_cut_result\n", "The resulting output water value cut coefficients when SHOP is used to create cuts. Units: x: MM3 and y: NOK/MM3.\n", "\n", "\n", "(reservoir:added_to_network)=\n", "### added_to_network\n", "Flag determining whether the model has determined that this reservoir is part of a tunnel network. Unit: NO_UNIT.\n", "\n", "\n", "(reservoir:network_no)=\n", "### network_no\n", "Network identification number set by the model to indicate which tunnel network this reservoir is part of. Unit: NO_UNIT.\n", "\n", "\n", "(reservoir:peak_volume_penalty)=\n", "### peak_volume_penalty\n", "The peak volume penalty incurred for the reservoir, zero in all time steps except for when the reservoir volume peak occurs. Unit (y): NOK.\n", "\n", "\n", "(reservoir:flood_volume_penalty)=\n", "### flood_volume_penalty\n", "The penalty incurred for the reservoir based on the optimized reservoir volume and the flood_volume_cost_curve. Unit (y): NOK." ] } ], "metadata": { "jupytext": { "text_representation": { "extension": ".md", "format_name": "myst", "format_version": 0.13, "jupytext_version": "1.13.8" } }, "kernelspec": { "display_name": "Python 3", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.13.9" }, "source_map": [ 11, 110, 122 ] }, "nbformat": 4, "nbformat_minor": 5 }