timml.linesink.CollectorWell
============================

.. toctree::
   :hidden:

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

.. py:class:: timml.linesink.CollectorWell(model, xy, Qw=100.0, rw=0.1, res=0.0, layers=0, order=0, label=None)

   Bases: :py:obj:`DitchString`


   
   Collector well: collection of line sinks with a specified total discharge.

   Collection of (discontinuous) line sinks with specified total discharge
   and unknown but uniform head.

   :param model: model to which the element is added
   :type model: Model object
   :param xy: array of shape (N, 4) with start and end coordinates of the line sinks
              on each row: [(x1, y1, x2, y2), ...]
   :type xy: np.array
   :param Qw: total discharge of the collector well
   :type Qw: float
   :param rw: radius of the collector well arms
   :type rw: float
   :param res: resistance of the well screen
   :type res: float
   :param layers: layer (int) or layers (list or array) where well is screened
   :type layers: int, array or list
   :param order: order of the line sink elements
   :type order: int
   :param label: label of the collector well
   :type label: string, optional

   .. rubric:: Examples

   Create a collector well with two arms::

       ml = timml.Model3D(kaq=10, z=np.arange(20, -1, -2), kzoverkh=0.1)
       xy = [(1, 0, 10, 0), (0, 1, 0, 10)]
       w = timml.CollectorWell(ml, xy=xy, Qw=1000, layers=np.arange(5, 10))
       ml.solve()















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

.. autoapisummary::

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