timflow.steady.linesink.DitchString
===================================

.. toctree::
   :hidden:

   /api/timflow/steady/linesink/DitchString.potinf
   /api/timflow/steady/linesink/DitchString.disvecinf
   /api/timflow/steady/linesink/DitchString.discharge_per_linesink
   /api/timflow/steady/linesink/DitchString.discharge
   /api/timflow/steady/linesink/DitchString.potinflayers
   /api/timflow/steady/linesink/DitchString.potentiallayers
   /api/timflow/steady/linesink/DitchString.disvec
   /api/timflow/steady/linesink/DitchString.disvecinflayers
   /api/timflow/steady/linesink/DitchString.disveclayers

.. py:class:: timflow.steady.linesink.DitchString(model, xy=None, Qls=1, res=0, wh=1, order=0, layers=0, dely=0, label=None)

   Bases: :py:obj:`RiverString`


   
   String of Ditches with specified discharge and uniform unknown head.

   :param model: Model to which the element is added
   :type model: Model object
   :param xy: list or array of (x,y) pairs of coordinates of end-points of
              line-sinks in string
   :type xy: array or list
   :param Qls: total discharge of the string
   :type Qls: scalar
   :param res: resistance of line-sinks in string
   :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
                   (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
   :type wh: float or str
   :param order: polynomial order or inflow along each line-sink in string
   :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:`.Ditch`















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

.. autoapisummary::

   timflow.steady.linesink.DitchString.potinf
   timflow.steady.linesink.DitchString.disvecinf
   timflow.steady.linesink.DitchString.discharge_per_linesink
   timflow.steady.linesink.DitchString.discharge
   timflow.steady.linesink.DitchString.potinflayers
   timflow.steady.linesink.DitchString.potentiallayers
   timflow.steady.linesink.DitchString.disvec
   timflow.steady.linesink.DitchString.disvecinflayers
   timflow.steady.linesink.DitchString.disveclayers