timflow.transient.well.Well
===========================

.. toctree::
   :hidden:

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

.. py:class:: timflow.transient.well.Well(model, xw=0, yw=0, rw=0.1, tsandQ=[(0, 1)], res=0, rc=None, layers=0, wbstype='pumping', label=None)

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


   
   Create a well with a specified discharge.

   The well may be screened in multiple layers. The discharge is distributed across
   the layers such that the head inside the well is the same in all screened layers.
   Wellbore storage and skin effect may be taken into account. 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 tsandQ: tuples of starting time and discharge after starting time
   :type tsandQ: list of tuples
   :param res: resistance of the well screen
   :type res: float
   :param rc: radius of the caisson, the pipe where the water table inside
              the well flucuates, which accounts for the wellbore storage
   :type rc: float
   :param layers: layer (int) or layers (list or array) where well is screened
   :type layers: int, array or list
   :param wbstype: 'pumping': Q is the discharge of the well
                   'slug': volume of water instantaneously taken out of the well
   :type wbstype: string
   :param label: label of the well
   :type label: string (default: None)















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

.. autoapisummary::

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