timflow.steady.inhomogeneity.PolygonInhom3D
===========================================

.. toctree::
   :hidden:

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

.. py:class:: timflow.steady.inhomogeneity.PolygonInhom3D(model, xy, kaq=1, z=None, kzoverkh=1, npor=0.3, topboundary='conf', topres=0, topthick=0, hstar=0, N=None, order=3, ndeg=3)

   Bases: :py:obj:`PolygonInhom`


   
   Create a multi-layer model object consisting of many aquifer layers.

   The resistance between the layers is computed from the vertical hydraulic
   conductivity of the layers.

   :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 layer from the top down
               if float, hydraulic conductivity is the same in all aquifers
   :type kaq: float, array or list
   :param z: elevation of top of system followed by bottoms of all layers
             from the top down
             bottom of layer is automatically equal to top of layer below it
             length is number of aquifer layers + 1
   :type z: 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
   :param npor: porosity of all aquifer layers
                from the top down
                if float, porosity is the same for all layers
                if topboundary='conf': length is number of layers
                if topboundary='semi': length is number of layers + 1
   :type npor: float, array or list
   :param topboundary: indicating whether the top is confined ('conf') or
                       semi-confined ('semi')
   :type topboundary: string, 'conf' or 'semi' (default is 'conf')
   :param topres: resistance of top semi-confining 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 (read if topboundary='semi')
   :type hstar: float or None (default is None)
   :param N: infiltration rate (L/T) inside inhomogeneity. Only possible if
             topboundary='conf'
   :type N: float or None (default is None)
   :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















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

.. autoapisummary::

   timflow.steady.inhomogeneity.PolygonInhom3D.findlayer
   timflow.steady.inhomogeneity.PolygonInhom3D.summary