timflow.transient.model.Model3D
===============================

.. toctree::
   :hidden:

   /api/timflow/transient/model/Model3D.compute_laplace_parameters
   /api/timflow/transient/model/Model3D.potential
   /api/timflow/transient/model/Model3D.potentialone
   /api/timflow/transient/model/Model3D.disvec
   /api/timflow/transient/model/Model3D.head
   /api/timflow/transient/model/Model3D.headalongline
   /api/timflow/transient/model/Model3D.disvecalongline
   /api/timflow/transient/model/Model3D.headgrid
   /api/timflow/transient/model/Model3D.headgrid2
   /api/timflow/transient/model/Model3D.inverseLapTran
   /api/timflow/transient/model/Model3D.solve
   /api/timflow/transient/model/Model3D.aquifer_summary

.. py:class:: timflow.transient.model.Model3D(kaq=1, z=[4, 3, 2, 1], Saq=0.001, kzoverkh=0.1, leffaq=0, poraq=0.3, topboundary='conf', phreatictop=None, topres=0, topthick=0, topSll=0, toppor=0.3, tmin=1, tmax=10, tstart=0, M=10, steady=None)

   Bases: :py:obj:`TimModel`


   
   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 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
             if topboundary='conf': length is number of layers + 1
             if topboundary='semi': length is number of layers + 2 as top
             of leaky layer on top of systems needs to be specified
   :type z: array or list
   :param Saq: specific storage of all aquifers layers
               if float, sepcific storage is same in all aquifers layers
               if phreatictop is True and topboundary is 'conf', Saq of top
               aquifer is phreatic storage coefficient (and not multiplied
               with the layer thickness)
   :type Saq: 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
   :param leffaq: loading efficiency of the aquifer
                  only used when topboundary='semi' and hstar varies with time
   :type leffaq: float, array or list
   :param topboundary: indicating whether the top is confined ('con' is enough), phreatic
                       ('phr' is enough) or semi-confined ('sem' is enough).
                       When 'phreatic', the storage coefficient (Saq) of the top model layer is
                       treated as phreatic storage (and not multiplied with the aquifer thickness)
                       When 'semi', the topres and topthick must be specified.
   :type topboundary: string, 'confined', 'phreatic', or 'semi' (default is 'conf')
   :param topres: resistance of top semi-confining layer, only read if topboundary='semi'
   :type topres: float
   :param topthick: thickness of top semi-confining layer, only read if topboundary='semi'
   :type topthick: float
   :param tmin: the minimum time for which heads can be computed after any change
                in boundary condition.
   :type tmin: scalar
   :param tmax: the maximum time for which heads can be computed.
   :type tmax: scalar
   :param tstart: time at start of simulation (default 0)
   :type tstart: scalar
   :param M: the number of terms to be used in the numerical inversion algorithm.
             10 is usually sufficient. If drawdown curves appear to oscillate,
             more terms may be needed, but this seldom happens.
   :type M: integer (default 10)
   :param steady: a timflow.steady model may be included to add steady-state flow
   :type steady: optional instance of a solved timflow.steady model















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

.. autoapisummary::

   timflow.transient.model.Model3D.compute_laplace_parameters
   timflow.transient.model.Model3D.potential
   timflow.transient.model.Model3D.potentialone
   timflow.transient.model.Model3D.disvec
   timflow.transient.model.Model3D.head
   timflow.transient.model.Model3D.headalongline
   timflow.transient.model.Model3D.disvecalongline
   timflow.transient.model.Model3D.headgrid
   timflow.transient.model.Model3D.headgrid2
   timflow.transient.model.Model3D.inverseLapTran
   timflow.transient.model.Model3D.solve
   timflow.transient.model.Model3D.aquifer_summary