timflow.steady.well.HeadWell
============================

.. toctree::
   :hidden:

   /api/timflow/steady/well/HeadWell.potinf
   /api/timflow/steady/well/HeadWell.disvecinf
   /api/timflow/steady/well/HeadWell.headinside
   /api/timflow/steady/well/HeadWell.discharge
   /api/timflow/steady/well/HeadWell.capzone
   /api/timflow/steady/well/HeadWell.plotcapzone
   /api/timflow/steady/well/HeadWell.potinflayers
   /api/timflow/steady/well/HeadWell.potentiallayers
   /api/timflow/steady/well/HeadWell.disvec
   /api/timflow/steady/well/HeadWell.disvecinflayers
   /api/timflow/steady/well/HeadWell.disveclayers
   /api/timflow/steady/well/HeadWell.equation

.. py:class:: timflow.steady.well.HeadWell(model, xw=0, yw=0, hw=10, rw=0.1, res=0, layers=0, label=None, addtomodel=True)

   Bases: :py:obj:`WellBase`, :py:obj:`timflow.steady.equation.HeadEquation`


   
   HeadWell Class to create a well with a specified head inside the well.

   .. rubric:: Notes

   The well may be screened in multiple layers.
   The resistance of the screen may be specified.
   The head is computed such that the discharge :math:`Q_i` in layer :math:`i` is
   computed as:

   .. math::
       Q_i = 2\pi r_w(h_i - h_w)/c

   where :math:`c` is the resistance of the well screen and :math:`h_w` is
   the head inside the well.

   :param model: model to which the element is added
   :type model: Model object
   :param xw: x-coordinate of the well
   :type xw: float
   :param yw: y-coordinate of the well
   :type yw: float
   :param hw: head inside the well
   :type hw: float
   :param rw: radius of the well
   :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 label: label of the well
   :type label: string (default: None)















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

.. autoapisummary::

   timflow.steady.well.HeadWell.potinf
   timflow.steady.well.HeadWell.disvecinf
   timflow.steady.well.HeadWell.headinside
   timflow.steady.well.HeadWell.discharge
   timflow.steady.well.HeadWell.capzone
   timflow.steady.well.HeadWell.plotcapzone
   timflow.steady.well.HeadWell.potinflayers
   timflow.steady.well.HeadWell.potentiallayers
   timflow.steady.well.HeadWell.disvec
   timflow.steady.well.HeadWell.disvecinflayers
   timflow.steady.well.HeadWell.disveclayers
   timflow.steady.well.HeadWell.equation