{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "a7de453f",
   "metadata": {},
   "source": [
    "(cut_group)=\n",
    "# cut_group\n",
    "An object to represent the set of linear cut constraints that can be used as end valuation for a watercourse. The constant right-hand side of the cut constraints are stored on this object, while the cut coefficients are found on the connected reservoir and inflow_series objects.\n",
    "\n",
    "|   |   |\n",
    "|---|---|\n",
    "|Input connections|{ref}`reservoir`, {ref}`inflow_series`|\n",
    "|Output connections|{ref}`reservoir`, {ref}`inflow_series`|\n",
    "|License|SHOP_OPEN|\n",
    "|Release version|14.0.0.3|\n",
    "\n",
    "```{contents}\n",
    ":local:\n",
    ":depth: 1\n",
    "```\n",
    "\n",
    "\n",
    "\n",
    "## Examples\n",
    "  - [](cut-description)\n",
    "  - [](water-value-descriptions)\n",
    "  \n",
    "\n",
    "## References\n",
    "  - Increased Information Flow between Hydropower Scheduling Models through Extended Cut Sharing {cite}`Gjerden2016`\n",
    "  \n",
    "\n",
    "## Attributes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "b9baf49f",
   "metadata": {
    "tags": [
     "remove-input",
     "full-width"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table id=\"cut_group-table\" class=\"display compact\"></table>\n",
       "<script>\n",
       "enableDataTable(\n",
       "  \"#cut_group-table\",\n",
       "  \"/_static/data/cut_group-attribute-table.json\"\n",
       ");\n",
       "</script>\n"
      ],
      "text/plain": [
       "<IPython.core.display.HTML object>"
      ]
     },
     "execution_count": 1,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "from IPython.core.display import HTML\n",
    "HTML(\"\"\"<table id=\"cut_group-table\" class=\"display compact\"></table>\n",
    "<script>\n",
    "enableDataTable(\n",
    "  \"#cut_group-table\",\n",
    "  \"/_static/data/cut_group-attribute-table.json\"\n",
    ");\n",
    "</script>\n",
    "\"\"\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "cbc4c1a3",
   "metadata": {},
   "source": [
    "(cut_group:rhs)=\n",
    "### rhs\n",
    "The right hand side constant for each cut in the cut_group. Represent the future expected income of the system and is usually a positive number. In the case of price dependent cuts, the price level should be the reference value for each xy in the xy_array. (xUnit: NO_UNIT, yUnit: NOK)\n",
    "\n",
    "\n",
    "(cut_group:end_value)=\n",
    "### end_value\n",
    "Future expected income of the system that is part of the cut_group. (xUnit: NO_UNIT, yUnit: NOK)\n",
    "\n",
    "\n",
    "(cut_group:binding_cut_up)=\n",
    "### binding_cut_up\n",
    "The zero-indexed binding cut constraint in the closest price level above the average price in SHOP is saved as the final value in the time series. The value is set to -1 if no cuts have a price above the average price in SHOP. In case of price independent cuts, the value is the binding cut in the cut group. (xUnit: NO_UNIT, yUnit: NO_UNIT)\n",
    "\n",
    "\n",
    "(cut_group:binding_cut_down)=\n",
    "### binding_cut_down\n",
    "The zero-indexed binding cut constraint in the closest price level below the average price in SHOP is saved as the final value in the time series. In case of price independent cuts or if there are no cuts with a price below the average price in SHOP, the value is set to -1. (xUnit: NO_UNIT, yUnit: NO_UNIT)"
   ]
  }
 ],
 "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.12.9"
  },
  "source_map": [
   11,
   41,
   53
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}