timflow.transient.linesink.River
================================

.. toctree::
   :hidden:

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

.. py:class:: timflow.transient.linesink.River(model, x1=-1, y1=0, x2=1, y2=0, tsandh=[(0, 1)], res=0, wh='H', layers=0, label=None, addtomodel=True)

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


   
   Create a head-specified line-sink 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 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 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:`.RiverString`















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

.. autoapisummary::

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