timflow.transient.well.HeadWell
===============================

.. toctree::
   :hidden:

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

.. py:class:: timflow.transient.well.HeadWell(model, xw=0, yw=0, rw=0.1, tsandh=[(0, 1)], res=0, layers=0, label=None)

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


   
   Create a well with a specified head inside the well.

   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_wH_i(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 rw: radius of the well
   :type rw: float
   :param tsandh: tuples of starting time and discharge after starting time
   :type tsandh: list of tuples
   :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.transient.well.HeadWell.initialize
   timflow.transient.well.HeadWell.setflowcoef
   timflow.transient.well.HeadWell.potinf
   timflow.transient.well.HeadWell.potinfone
   timflow.transient.well.HeadWell.disvecinf
   timflow.transient.well.HeadWell.headinside
   timflow.transient.well.HeadWell.plot
   timflow.transient.well.HeadWell.potential
   timflow.transient.well.HeadWell.unitpotential
   timflow.transient.well.HeadWell.unitpotentialone
   timflow.transient.well.HeadWell.disvec
   timflow.transient.well.HeadWell.unitdisvec
   timflow.transient.well.HeadWell.potinflayers
   timflow.transient.well.HeadWell.potentiallayers
   timflow.transient.well.HeadWell.unitpotentiallayers
   timflow.transient.well.HeadWell.disvecinflayers
   timflow.transient.well.HeadWell.disveclayers
   timflow.transient.well.HeadWell.unitdisveclayers
   timflow.transient.well.HeadWell.discharge
   timflow.transient.well.HeadWell.dischargeold
   timflow.transient.well.HeadWell.run_after_solve
   timflow.transient.well.HeadWell.equation