{
 "cells": [
  {
   "cell_type": "markdown",
   "id": "ad643534",
   "metadata": {},
   "source": [
    "(creek_intake)=\n",
    "# creek_intake\n",
    "A creek intake object which represents unregulated inflow entering the tunnel system below a reservoir\n",
    "\n",
    "|   |   |\n",
    "|---|---|\n",
    "|Input connections|{ref}`reservoir`, {ref}`creek_intake`|\n",
    "|Output connections|{ref}`plant`, {ref}`gate`, {ref}`junction`, {ref}`creek_intake`|\n",
    "|License|SHOP_CREEK_INTAKE|\n",
    "|Release version|13.0.0.a|\n",
    "\n",
    "```{contents}\n",
    ":local:\n",
    ":depth: 1\n",
    "```\n",
    "\n",
    "```{warning}\n",
    "The creek_intake object is old and will be deprecated in the future. A creek_intake can be replaced with a small [](reservoir) connected to a [](tunnel).\n",
    "```\n",
    "\n",
    "## Examples\n",
    "  - [](creek-intake-example)\n",
    "  \n",
    "\n",
    "\n",
    "\n",
    "## Attributes"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "id": "1d55ab37",
   "metadata": {
    "tags": [
     "remove-input",
     "full-width"
    ]
   },
   "outputs": [
    {
     "data": {
      "text/html": [
       "<table id=\"creek_intake-table\" class=\"display compact\"></table>\n",
       "<script>\n",
       "enableDataTable(\n",
       "  \"#creek_intake-table\",\n",
       "  \"/_static/data/creek_intake-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=\"creek_intake-table\" class=\"display compact\"></table>\n",
    "<script>\n",
    "enableDataTable(\n",
    "  \"#creek_intake-table\",\n",
    "  \"/_static/data/creek_intake-attribute-table.json\"\n",
    ");\n",
    "</script>\n",
    "\"\"\")"
   ]
  },
  {
   "cell_type": "markdown",
   "id": "ad951014",
   "metadata": {},
   "source": [
    "(creek_intake:net_head)=\n",
    "### net_head\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license). Physical height of the creek intake opening (xUnit: METER, yUnit: METER)\n",
    "\n",
    "\n",
    "(creek_intake:max_inflow)=\n",
    "### max_inflow\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Static maximum capacity for inflow to this creek intake (xUnit: M3/S, yUnit: M3/S)\n",
    "\n",
    "\n",
    "(creek_intake:max_inflow_dynamic)=\n",
    "### max_inflow_dynamic\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Time-dependent maxiumu capacity for inflow to this creek intake (xUnit: NO_UNIT, yUnit: M3/S)\n",
    "\n",
    "\n",
    "(creek_intake:inflow)=\n",
    "### inflow\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Inflow to the creek intake (xUnit: NO_UNIT, yUnit: M3/S)\n",
    "\n",
    "\n",
    "(creek_intake:sim_inflow)=\n",
    "### sim_inflow\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting inflow to this creek intake after simulation based on observed reservoir level and plant production (xUnit: NO_UNIT, yUnit: M3/S)\n",
    "\n",
    "\n",
    "(creek_intake:sim_pressure_height)=\n",
    "### sim_pressure_height\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting pressure height of the creek intake after simulation based on observed reservoir level and plant production (xUnit: NO_UNIT, yUnit: METER)\n",
    "\n",
    "\n",
    "(creek_intake:inflow_percentage)=\n",
    "### inflow_percentage\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Predefined factor to generate inflow to this creek intake based on a percentage of the inflow to the reservoir above (xUnit: NO_UNIT, yUnit: M3/S)\n",
    "\n",
    "\n",
    "(creek_intake:overflow_cost)=\n",
    "### overflow_cost\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Cost for spillage from this creek intake if a spill gate is connected to it (xUnit: NO_UNIT, yUnit: NOK/MM3)\n",
    "\n",
    "\n",
    "(creek_intake:non_physical_overflow_flag)=\n",
    "### non_physical_overflow_flag\n",
    "Future deprecation: All creek_intakes should be modelled by using the tunnel object (does not require additional license).Resulting flag series telling if there was non-physical overflow from this creek intake i.e. spilling water with inflow below the maximum capacity (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,
   40,
   52
  ]
 },
 "nbformat": 4,
 "nbformat_minor": 5
}