timml.linesink.RiverString
==========================

.. toctree::
   :hidden:

   /05api/timml/linesink/RiverString.potinf
   /05api/timml/linesink/RiverString.disvecinf
   /05api/timml/linesink/RiverString.discharge_per_linesink
   /05api/timml/linesink/RiverString.discharge
   /05api/timml/linesink/RiverString.potinflayers
   /05api/timml/linesink/RiverString.potentiallayers
   /05api/timml/linesink/RiverString.disvec
   /05api/timml/linesink/RiverString.disvecinflayers
   /05api/timml/linesink/RiverString.disveclayers

.. py:class:: timml.linesink.RiverString(model, xy=None, hls=0, res=0, wh=1, order=0, layers=0, dely=0, label=None, name='RiverString')

   Bases: :py:obj:`LineSinkStringBase2`


   
   String of head-specified line-sinks with optional width and resistance.

   :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 hls: head along string
               if scalar: head is the same everywhere along the string
               if list or array of length 2: head at beginning and end of string
               if list or array with same length as xy: heads at nodes, which
               may contain nans, except for first and last point
   :type hls: scalar, array or list
   :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: order of all line-sinks in string
   :type order: int (default is 0)
   :param dely: distance between control points and line
   :type dely: float (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 label:
   :type label: str or None

   .. seealso:: :class:`.River`















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

.. autoapisummary::

   timml.linesink.RiverString.potinf
   timml.linesink.RiverString.disvecinf
   timml.linesink.RiverString.discharge_per_linesink
   timml.linesink.RiverString.discharge
   timml.linesink.RiverString.potinflayers
   timml.linesink.RiverString.potentiallayers
   timml.linesink.RiverString.disvec
   timml.linesink.RiverString.disvecinflayers
   timml.linesink.RiverString.disveclayers