timflow.steady.inhomogeneity.LeakyBuildingPit3D
===============================================

.. toctree::
   :hidden:

   /api/timflow/steady/inhomogeneity/LeakyBuildingPit3D.findlayer
   /api/timflow/steady/inhomogeneity/LeakyBuildingPit3D.summary

.. py:class:: timflow.steady.inhomogeneity.LeakyBuildingPit3D(model, xy, kaq=1.0, z=None, kzoverkh=1.0, npor=0.3, topboundary='conf', topres=0.0, topthick=0.0, hstar=None, order=3, ndeg=3, layers=None, res=np.inf)

   Bases: :py:obj:`LeakyBuildingPit`


   
   Element to simulate a building pit with a leaky wall in Model3D.

   :param model: model to which the element is added
   :type model: Model object
   :param xy: list or array of (x,y) pairs of coordinates of corners of the
              inhomogeneity
              polygonal boundary is automatically closed (so first point
              is not repeated)
   :type xy: array or list
   :param kaq: hydraulic conductivity of each aquifer from the top down
               if float, hydraulic conductivity is the same in all aquifers
   :type kaq: float, array or list
   :param kzoverkh: vertical anisotropy ratio vertical k divided by horizontal k
                    if float, value is the same for all layers, length is number of layers
   :type kzoverkh: float, array or list
   :param z: elevation tops and bottoms of the aquifers from the top down
             leaky layers may have zero thickness
             if topboundary='conf': length is 2 * number of aquifers
             if topboundary='semi': length is 2 * number of aquifers + 1 as top
             of leaky layer on top of systems needs to be specified
   :type z: array or list
   :param topboundary: indicating whether the top is confined ('conf') or
                       semi-confined ('semi'). For a building pit, the 'conf'
                       option is generally more applicable.
   :type topboundary: string, 'conf' or 'semi' (default is 'conf')
   :param topres: resistance of top leaky layer (read if topboundary="semi")
   :type topres: float
   :param topthick: thickness of top semi-confining layer (read if topboundary='semi')
   :type topthick: float
   :param hstar: head value above semi-confining top, only read if topboundary='semi'
   :type hstar: float or None (default is None)
   :param npor: porosity of all aquifers and leaky layers from the top down
                if float, porosity is the same for all layers
                if topboundary='conf': length is 2 * number of aquifers - 1
                if topboundary='semi': length is 2 * number of aquifers
   :type npor: float, array or list
   :param order: polynomial order of flux along each segment
   :type order: int
   :param ndeg: number of points used between two segments to numerically
                integrate normal discharge
   :type ndeg: int
   :param layers: layers in which leaky wall is present.
   :type layers: list or np.array
   :param res: resistance of leaky wall, if passed as an array must be either
               shape (n_segments,) or (n_segments, n_layers). Default is np.inf,
               which simulates an impermeable wall.
   :type res: float or np.array, optional















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

.. autoapisummary::

   timflow.steady.inhomogeneity.LeakyBuildingPit3D.findlayer
   timflow.steady.inhomogeneity.LeakyBuildingPit3D.summary