timml.well.WellString
=====================

.. toctree::
   :hidden:

   /05api/timml/well/WellString.potinf
   /05api/timml/well/WellString.disvecinf
   /05api/timml/well/WellString.discharge
   /05api/timml/well/WellString.discharge_per_well
   /05api/timml/well/WellString.headinside
   /05api/timml/well/WellString.potinflayers
   /05api/timml/well/WellString.potentiallayers
   /05api/timml/well/WellString.disvec
   /05api/timml/well/WellString.disvecinflayers
   /05api/timml/well/WellString.disveclayers

.. py:class:: timml.well.WellString(model, xy, Qw=100, rw=0.1, res=0.0, layers=0, label=None)

   Bases: :py:obj:`WellStringBase`


   
   WellString is a string of wells for which the total discharge is specified.

   The head inside the wells is equal but unknown, and the total discharge of the
   wells is specified.

   :param model: model to which the element is added
   :type model: Model object
   :param xy: list of (x, y) tuples or 2d array of x and y coordinates
              of the well nodes
   :type xy: list of tuples or np.ndarray
   :param Qw: total discharge of the well string
   :type Qw: float
   :param rw: radius of the wells
   :type rw: float
   :param res: resistance of the well screens
   :type res: float
   :param layers: layer (int) or layers (list or array) where well is screened
   :type layers: int, array or list
   :param label: label of the well string
   :type label: string or None (default: None)















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

.. autoapisummary::

   timml.well.WellString.potinf
   timml.well.WellString.disvecinf
   timml.well.WellString.discharge
   timml.well.WellString.discharge_per_well
   timml.well.WellString.headinside
   timml.well.WellString.potinflayers
   timml.well.WellString.potentiallayers
   timml.well.WellString.disvec
   timml.well.WellString.disvecinflayers
   timml.well.WellString.disveclayers