{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "3e4b699e",
   "metadata": {},
   "source": [
    "(volume_constraint)=\n",
    "# volume_constraint\n",
    "A constraint object that can be used to force the total volume of the connected reservoirs to be between specified minimum and maximum limits\n",
    "\n",
    "|   |   |\n",
    "|---|---|\n",
    "|Input connections|{ref}`reservoir`|\n",
    "|Output connections|{ref}`reservoir`|\n",
    "|License|SHOP_OPEN|\n",
    "|Release version|13.0.0.a|\n",
    "\n",
    "```{contents}\n",
    ":local:\n",
    ":depth: 1\n",
    "```\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "\n",
    "## Attributes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "1b089109",
   "metadata": {
    "tags": [
     "remove-input",
     "full-width"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table id=\"volume_constraint-table\" class=\"display compact\"></table>\n",
       "<script>\n",
       "enableDataTable(\n",
       "  \"#volume_constraint-table\",\n",
       "  \"/_static/data/volume_constraint-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=\"volume_constraint-table\" class=\"display compact\"></table>\n",
    "<script>\n",
    "enableDataTable(\n",
    "  \"#volume_constraint-table\",\n",
    "  \"/_static/data/volume_constraint-attribute-table.json\"\n",
    ");\n",
    "</script>\n",
    "\"\"\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "1fcafef9",
   "metadata": {},
   "source": [
    "(volume_constraint:min_vol)=\n",
    "### min_vol\n",
    "Minimum volume for the sum of all reservoirs connected to this constraint (xUnit: NO_UNIT, yUnit: MM3)\n",
    "\n",
    "\n",
    "(volume_constraint:max_vol)=\n",
    "### max_vol\n",
    "Maximum volume for the sum of all reservoirs connected to this constraint (xUnit: NO_UNIT, yUnit: MM3)\n",
    "\n",
    "\n",
    "(volume_constraint:min_vol_penalty)=\n",
    "### min_vol_penalty\n",
    "Given penalty cost for having a sum volume below the min_vol (xUnit: NO_UNIT, yUnit: NOK/MM3)\n",
    "\n",
    "\n",
    "(volume_constraint:max_vol_penalty)=\n",
    "### max_vol_penalty\n",
    "Given penalty cost for having a sum volume above the max_vol (xUnit: NO_UNIT, yUnit: NOK/MM3)"
   ]
  }
 ],
 "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,
   36,
   48
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}