timflow.steady.linesink.Ditch
=============================

.. toctree::
   :hidden:

   /api/timflow/steady/linesink/Ditch.equation
   /api/timflow/steady/linesink/Ditch.potinf
   /api/timflow/steady/linesink/Ditch.disvecinf
   /api/timflow/steady/linesink/Ditch.potinflayers
   /api/timflow/steady/linesink/Ditch.potentiallayers
   /api/timflow/steady/linesink/Ditch.disvec
   /api/timflow/steady/linesink/Ditch.disvecinflayers
   /api/timflow/steady/linesink/Ditch.disveclayers

.. py:class:: timflow.steady.linesink.Ditch(model, x1=-1, y1=0, x2=1, y2=0, Qls=1, res=0, wh=1, order=0, layers=0, dely=0, label=None, addtomodel=True)

   Bases: :py:obj:`River`


   
   Line-sink with specified total discharge, and uniform but unknown head.

   :param model: Model to which the element is added
   :type model: Model object
   :param x1: x-coordinate of fist point of line-sink
   :type x1: scalar
   :param y1: y-coordinate of fist point of line-sink
   :type y1: scalar
   :param x2: x-coordinate of second point of line-sink
   :type x2: scalar
   :param y2: y-coordinate of second point of line-sink
   :type y2: scalar
   :param Qls: total discharge of the line-sink
   :type Qls: 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 order: polynomial order or inflow along line-sink
   :type order: int (default is 0)
   :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 dely: distance between control points and line
   :type dely: float (default  is 0)
   :param label: label of element
   :type label: str or None

   .. seealso:: :class:`.DitchString`















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

.. autoapisummary::

   timflow.steady.linesink.Ditch.equation
   timflow.steady.linesink.Ditch.potinf
   timflow.steady.linesink.Ditch.disvecinf
   timflow.steady.linesink.Ditch.potinflayers
   timflow.steady.linesink.Ditch.potentiallayers
   timflow.steady.linesink.Ditch.disvec
   timflow.steady.linesink.Ditch.disvecinflayers
   timflow.steady.linesink.Ditch.disveclayers