timflow.transient.linesink.RiverString
======================================

.. toctree::
   :hidden:

   /api/timflow/transient/linesink/RiverString.initialize
   /api/timflow/transient/linesink/RiverString.potinf
   /api/timflow/transient/linesink/RiverString.disvecinf
   /api/timflow/transient/linesink/RiverString.headinside
   /api/timflow/transient/linesink/RiverString.plot
   /api/timflow/transient/linesink/RiverString.run_after_solve
   /api/timflow/transient/linesink/RiverString.discharge_list
   /api/timflow/transient/linesink/RiverString.potential
   /api/timflow/transient/linesink/RiverString.unitpotential
   /api/timflow/transient/linesink/RiverString.unitpotentialone
   /api/timflow/transient/linesink/RiverString.disvec
   /api/timflow/transient/linesink/RiverString.unitdisvec
   /api/timflow/transient/linesink/RiverString.potinflayers
   /api/timflow/transient/linesink/RiverString.potentiallayers
   /api/timflow/transient/linesink/RiverString.unitpotentiallayers
   /api/timflow/transient/linesink/RiverString.disvecinflayers
   /api/timflow/transient/linesink/RiverString.disveclayers
   /api/timflow/transient/linesink/RiverString.unitdisveclayers
   /api/timflow/transient/linesink/RiverString.discharge
   /api/timflow/transient/linesink/RiverString.dischargeold
   /api/timflow/transient/linesink/RiverString.equation

.. py:class:: timflow.transient.linesink.RiverString(model, xy=[(-1, 0), (1, 0)], tsandh=[(0, 1)], res=0, wh='H', layers=0, label=None)

   Bases: :py:obj:`LineSinkStringBase`, :py:obj:`timflow.transient.equation.HeadEquation`


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

   Inflow per unit length of line-sink is computed as:

   .. math::
       \sigma = w(h_{aq} - h_{ls})/c

   where :math:`c` is the resistance of the bottom of the line-sink,
   :math:`w` is the width over which water enters the line-sink,
   :math:`h_{aq}` is the head in the aquifer at the center of the line-sink,
   :math:`h_{ls}` is the specified head inside the line-sink
   Note that all that matters is the conductance term :math:`w/c` but
   both are specified separately

   :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 tsandh: if list or 2D array: pairs of time and head after that time
                  if 'fixed': head is fixed (no change in head) during entire simulation
   :type tsandh: list or 2D array of (time, head) values or string
   :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

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















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

.. autoapisummary::

   timflow.transient.linesink.RiverString.initialize
   timflow.transient.linesink.RiverString.potinf
   timflow.transient.linesink.RiverString.disvecinf
   timflow.transient.linesink.RiverString.headinside
   timflow.transient.linesink.RiverString.plot
   timflow.transient.linesink.RiverString.run_after_solve
   timflow.transient.linesink.RiverString.discharge_list
   timflow.transient.linesink.RiverString.potential
   timflow.transient.linesink.RiverString.unitpotential
   timflow.transient.linesink.RiverString.unitpotentialone
   timflow.transient.linesink.RiverString.disvec
   timflow.transient.linesink.RiverString.unitdisvec
   timflow.transient.linesink.RiverString.potinflayers
   timflow.transient.linesink.RiverString.potentiallayers
   timflow.transient.linesink.RiverString.unitpotentiallayers
   timflow.transient.linesink.RiverString.disvecinflayers
   timflow.transient.linesink.RiverString.disveclayers
   timflow.transient.linesink.RiverString.unitdisveclayers
   timflow.transient.linesink.RiverString.discharge
   timflow.transient.linesink.RiverString.dischargeold
   timflow.transient.linesink.RiverString.equation