timflow.steady.linesink1d.River1D
=================================

.. toctree::
   :hidden:

   /api/timflow/steady/linesink1d/River1D.potinf
   /api/timflow/steady/linesink1d/River1D.disvecinf
   /api/timflow/steady/linesink1d/River1D.discharge
   /api/timflow/steady/linesink1d/River1D.potinflayers
   /api/timflow/steady/linesink1d/River1D.potentiallayers
   /api/timflow/steady/linesink1d/River1D.disvec
   /api/timflow/steady/linesink1d/River1D.disvecinflayers
   /api/timflow/steady/linesink1d/River1D.disveclayers
   /api/timflow/steady/linesink1d/River1D.equation

.. py:class:: timflow.steady.linesink1d.River1D(model, xls=0, hls=1, res=0, wh=1, layers=0, label=None)

   Bases: :py:obj:`LineSink1DBase`, :py:obj:`timflow.steady.equation.HeadEquation`


   
   Create an infinitely long line-sink with a given head.

   :param model: Model to which the element is added
   :type model: Model object
   :param xls: x-location of line-sink
   :type xls: scalar
   :param hls: head in line-sink
   :type hls: scalar
   :param res: resistance of line-sink
   :type res: scalar (default is 0)
   :param wh: distance over which water enters line-sink
              * if 'H': (default) distance is equal to the thickness of the aquifer layer
                (when flow comes mainly from one side)
              * if '2H': distance is twice the thickness of the aquifer layer
                (when flow comes from both sides)
              * if scalar: the width of the stream that partially penetrates the aquifer layer
   :type wh: scalar or str
   :param layers: layer(s) in which element is placed
                  if scalar: element is placed in this layer
                  if list or array: element is placed in all these layers
   :type layers: scalar, list or array
   :param label: label of element
   :type label: str or None















   ..
       !! processed by numpydoc !!
Methods
-------

.. autoapisummary::

   timflow.steady.linesink1d.River1D.potinf
   timflow.steady.linesink1d.River1D.disvecinf
   timflow.steady.linesink1d.River1D.discharge
   timflow.steady.linesink1d.River1D.potinflayers
   timflow.steady.linesink1d.River1D.potentiallayers
   timflow.steady.linesink1d.River1D.disvec
   timflow.steady.linesink1d.River1D.disvecinflayers
   timflow.steady.linesink1d.River1D.disveclayers
   timflow.steady.linesink1d.River1D.equation