timflow.steady.model.Model3D
============================

.. toctree::
   :hidden:

   /api/timflow/steady/model/Model3D.remove_element
   /api/timflow/steady/model/Model3D.disvec
   /api/timflow/steady/model/Model3D.normflux
   /api/timflow/steady/model/Model3D.intnormflux_segment
   /api/timflow/steady/model/Model3D.intnormflux
   /api/timflow/steady/model/Model3D.head
   /api/timflow/steady/model/Model3D.headgrid
   /api/timflow/steady/model/Model3D.headgrid2
   /api/timflow/steady/model/Model3D.headalongline
   /api/timflow/steady/model/Model3D.disvecalongline
   /api/timflow/steady/model/Model3D.solve
   /api/timflow/steady/model/Model3D.solve_mp
   /api/timflow/steady/model/Model3D.aquifer_summary

.. py:class:: timflow.steady.model.Model3D(kaq=1, z=None, kzoverkh=1, npor=0.3, topboundary='conf', topres=0, topthick=0, hstar=0)

   Bases: :py:obj:`Model`


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

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

   :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)

   .. rubric:: Notes

   For semi-confined aquifers, set top equal to 'semi' and provide:
      - topres: resistance of top
      - tophick: thickness of top
      - hstar: head above top

   .. rubric:: Examples

   Create a 3D model with 10 layers::

       ml = Model3D(kaq=10, z=np.arange(20, -1, -2), kzoverkh=0.1)















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

.. autoapisummary::

   timflow.steady.model.Model3D.remove_element
   timflow.steady.model.Model3D.disvec
   timflow.steady.model.Model3D.normflux
   timflow.steady.model.Model3D.intnormflux_segment
   timflow.steady.model.Model3D.intnormflux
   timflow.steady.model.Model3D.head
   timflow.steady.model.Model3D.headgrid
   timflow.steady.model.Model3D.headgrid2
   timflow.steady.model.Model3D.headalongline
   timflow.steady.model.Model3D.disvecalongline
   timflow.steady.model.Model3D.solve
   timflow.steady.model.Model3D.solve_mp
   timflow.steady.model.Model3D.aquifer_summary