timml.well.TargetHeadWellString
===============================

.. toctree::
   :hidden:

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

.. py:class:: timml.well.TargetHeadWellString(model, xy, rw=0.1, res=0.0, layers=0, hcp=10, xcp=None, ycp=None, lcp=0, label=None)

   Bases: :py:obj:`WellStringBase`


   
   A string of wells for which the head is specified at a point.

   The head in the wells is equal but unknown and the head at the control point
   (lcp, xcp, ycp) must equal the specified head hcp.

   :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 wells
   :type xy: list of tuples or np.ndarray
   :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 hcp: head at the control point (lcp, xcp, ycp)
   :type hcp: float
   :param xcp: x-coordinate where head is specified
   :type xcp: float
   :param ycp: y-coordinate where head is specified
   :type ycp: float
   :param lcp: layer in which head is specified, default is the first layer, layer 0
   :type lcp: int
   :param label: label of the well string
   :type label: string or None (default: None)















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

.. autoapisummary::

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