ttim.aquifer
============

.. py:module:: ttim.aquifer


Classes
-------

.. autoapisummary::

   ttim.aquifer.AquiferData
   ttim.aquifer.Aquifer
   ttim.aquifer.SimpleAquifer


Module Contents
---------------

.. py:class:: AquiferData(model, kaq, z, Haq, Hll, c, Saq, Sll, poraq, porll, ltype, topboundary, phreatictop, kzoverkh=None, model3d=False, name=None)

   .. py:attribute:: model


   .. py:attribute:: kaq


   .. py:attribute:: z


   .. py:attribute:: naq


   .. py:attribute:: nlayers


   .. py:attribute:: Haq


   .. py:attribute:: Hll


   .. py:attribute:: T


   .. py:attribute:: Tcol


   .. py:attribute:: c


   .. py:attribute:: Saq


   .. py:attribute:: Sll


   .. py:attribute:: poraq


   .. py:attribute:: porll


   .. py:attribute:: ltype


   .. py:attribute:: zaqtop


   .. py:attribute:: zaqbot


   .. py:attribute:: layernumber


   .. py:attribute:: topboundary


   .. py:attribute:: phreatictop


   .. py:attribute:: kzoverkh
      :value: None



   .. py:attribute:: model3d
      :value: False



   .. py:attribute:: area
      :value: 1e+200



   .. py:attribute:: name
      :value: None



   .. py:method:: __repr__()


   .. py:method:: initialize()

      
      Initialize the aquifer data.

      .. attribute:: eigval[naq, npval]

         Array with eigenvalues

      .. attribute:: lab[naq, npval]

         Array with lambda values

      .. attribute:: lab2[naq, nint, npint]

         Array with lambda values reorganized per interval

      .. attribute:: eigvec[naq, naq, npval]

         Array with eigenvector matrices

      .. attribute:: coef[naq ,naq, npval]

         Array with coefficients coef[ilayers, :, np] are the coefficients if the
         element is in ilayers belonging to Laplace parameter number np.















      ..
          !! processed by numpydoc !!


   .. py:method:: compute_lab_eigvec(p, returnA=False, B=None)


   .. py:method:: head_to_potential(h, layers)


   .. py:method:: potential_to_head(pot, layers)


   .. py:method:: is_inside(x, y)
      :abstractmethod:



   .. py:method:: in_which_layer(z)

      
      Get layer given elevation z.

      Returns -9999 if above top of system, +9999 if below bottom of system, negative
      for in leaky layer.

      leaky layer -n is on top of aquifer n















      ..
          !! processed by numpydoc !!


   .. py:method:: findlayer(z)

      
      Returns layer-number, layer-type and model-layer-number.
















      ..
          !! processed by numpydoc !!


   .. py:method:: summary()


.. py:class:: Aquifer(model, kaq, z, Haq, Hll, c, Saq, Sll, poraq, porll, ltype, topboundary, phreatictop, kzoverkh=None, model3d=False)

   Bases: :py:obj:`AquiferData`


   .. py:attribute:: inhomdict


   .. py:attribute:: area
      :value: 1e+300



   .. py:method:: __repr__()


   .. py:method:: initialize()

      
      Initialize the aquifer data.

      .. attribute:: eigval[naq, npval]

         Array with eigenvalues

      .. attribute:: lab[naq, npval]

         Array with lambda values

      .. attribute:: lab2[naq, nint, npint]

         Array with lambda values reorganized per interval

      .. attribute:: eigvec[naq, naq, npval]

         Array with eigenvector matrices

      .. attribute:: coef[naq ,naq, npval]

         Array with coefficients coef[ilayers, :, np] are the coefficients if the
         element is in ilayers belonging to Laplace parameter number np.















      ..
          !! processed by numpydoc !!


   .. py:method:: is_inside(x, y)


   .. py:method:: find_aquifer_data(x, y)


   .. py:method:: add_inhom(inhom)


.. py:class:: SimpleAquifer(naq)

   Bases: :py:obj:`Aquifer`


   .. py:attribute:: naq


   .. py:attribute:: inhomdict


   .. py:attribute:: area
      :value: 1e+300



   .. py:method:: __repr__()


   .. py:method:: initialize()

      
      Initialize the aquifer data.

      .. attribute:: eigval[naq, npval]

         Array with eigenvalues

      .. attribute:: lab[naq, npval]

         Array with lambda values

      .. attribute:: lab2[naq, nint, npint]

         Array with lambda values reorganized per interval

      .. attribute:: eigvec[naq, naq, npval]

         Array with eigenvector matrices

      .. attribute:: coef[naq ,naq, npval]

         Array with coefficients coef[ilayers, :, np] are the coefficients if the
         element is in ilayers belonging to Laplace parameter number np.















      ..
          !! processed by numpydoc !!