timflow.steady.well.Well
========================

.. toctree::
   :hidden:

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

.. py:class:: timflow.steady.well.Well(model, xw=0, yw=0, Qw=100.0, rw=0.1, res=0.0, layers=0, label=None, xc=None, yc=None)

   Bases: :py:obj:`WellBase`


   
   Well Class to create a well with a specified discharge.

   .. 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. The total discharge is distributed over the
   screens such that :math:`h_w` is the same in each screened layer.

   :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 Qw: total discharge of the well
   :type Qw: 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 or None (default: None)
   :param xc: x-location of control point (default None, which puts it at xw)
   :type xc: float
   :param yc: y-location of control point (default None, which puts it at yw + rw)
   :type yc: float

   .. rubric:: Examples

   Create a well in multiple layers::

       ml = Model3D(kaq=10, z=np.arange(20, -1, -2), kzoverkh=0.1)
       Well(ml, 100, 200, 1000, layers=[0, 1, 2, 3])















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

.. autoapisummary::

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