ttim.element
============

.. py:module:: ttim.element


Classes
-------

.. autoapisummary::

   ttim.element.Element


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

.. py:class:: Element(model, nparam=1, nunknowns=0, layers=0, tsandbc=[(0, 0)], type='z', name='', label=None, inhomelement=False)

   Bases: :py:obj:`abc.ABC`


   
   Helper class that provides a standard way to create an ABC using
   inheritance.
















   ..
       !! processed by numpydoc !!

   .. py:attribute:: model


   .. py:attribute:: aq
      :value: None



   .. py:attribute:: nparam
      :value: 1



   .. py:attribute:: nunknowns
      :value: 0



   .. py:attribute:: layers


   .. py:attribute:: nlayers


   .. py:attribute:: inhomelement
      :value: False



   .. py:attribute:: type
      :value: 'z'



   .. py:attribute:: name
      :value: ''



   .. py:attribute:: label
      :value: None



   .. py:attribute:: rzero
      :value: 30



   .. py:method:: setbc()


   .. py:method:: initialize()
      :abstractmethod:


      
      Initialize the element.

      Initialization of terms that cannot be initialized before other elements or
      the aquifer is defined.

      As we don't want to require a certain order of entering elements, these terms
      are initialized when Model.solve is called The initialization class needs to be
      overloaded by all derived classes















      ..
          !! processed by numpydoc !!


   .. py:method:: potinf(x, y, aq=None)
      :abstractmethod:


      
      Returns complex array of size (nparam, naq, npval).
















      ..
          !! processed by numpydoc !!


   .. py:method:: potential(x, y, aq=None)

      
      Returns complex array of size (ngvbc, naq, npval).
















      ..
          !! processed by numpydoc !!


   .. py:method:: unitpotential(x, y, aq=None)

      
      Returns complex array of size (naq, npval).

      Can be more efficient for given elements.















      ..
          !! processed by numpydoc !!


   .. py:method:: unitpotentialone(x, y, jtime, aq=None)

      
      Returns complex array of size (naq, npval).

      Can be more efficient for given elements.















      ..
          !! processed by numpydoc !!


   .. py:method:: disvecinf(x, y, aq=None)
      :abstractmethod:


      
      Returns 2 complex arrays of size (nparam, naq, npval).
















      ..
          !! processed by numpydoc !!


   .. py:method:: disvec(x, y, aq=None)

      
      Returns 2 complex arrays of size (ngvbc, naq, npval).
















      ..
          !! processed by numpydoc !!


   .. py:method:: unitdisvec(x, y, aq=None)

      
      Returns 2 complex arrays of size (naq, npval).

      Can be more efficient for given elements.















      ..
          !! processed by numpydoc !!


   .. py:method:: potinflayers(x, y, layers=0, aq=None)

      
      Layers can be scalar, list, or array.

      returns array of size (len(layers),nparam,npval) only used in building equations















      ..
          !! processed by numpydoc !!


   .. py:method:: potentiallayers(x, y, layers=0, aq=None)

      
      Returns complex array of size (ngvbc, len(layers),npval).

      Only used in building equations.















      ..
          !! processed by numpydoc !!


   .. py:method:: unitpotentiallayers(x, y, layers=0, aq=None)

      
      Returns complex array of size (len(layers), npval).

      Only used in building equations.















      ..
          !! processed by numpydoc !!


   .. py:method:: disvecinflayers(x, y, layers=0, aq=None)

      
      Layers can be scalar, list, or array.

      returns 2 arrays of size (len(layers),nparam,npval) only used in building
      equations















      ..
          !! processed by numpydoc !!


   .. py:method:: disveclayers(x, y, layers=0, aq=None)

      
      Returns 2 complex array of size (ngvbc, len(layers), npval).

      Only used in building equations.















      ..
          !! processed by numpydoc !!


   .. py:method:: unitdisveclayers(x, y, layers=0, aq=None)

      
      Returns complex array of size (len(layers), npval).

      Only used in building equations.















      ..
          !! processed by numpydoc !!


   .. py:method:: discharge(t, derivative=0)

      
      The discharge in each layer.

      :param t: times at which discharge is computed.
                t must be ordered and tmin <= t <= tmax
      :type t: scalar, list or array

      :returns: Discharge in each screen with zeros for layers that are not
                screened
      :rtype: array of discharges (nlayers,len(t))















      ..
          !! processed by numpydoc !!


   .. py:method:: dischargeold(t, derivative=0)

      
      The discharge in each layer.

      :param t: times at which discharge is computed.
                t must be ordered and tmin <= t <= tmax
      :type t: scalar, list or array

      :returns: Discharge in each screen with zeros for layers that are not
                screened
      :rtype: array of discharges (nlayers,len(t))















      ..
          !! processed by numpydoc !!


   .. py:method:: headinside(t)


   .. py:method:: storeinput(frame)


   .. py:method:: write()


   .. py:method:: run_after_solve()

      
      Function to run after a solution is completed.

      For most elements nothing needs to be done, but for strings of elements some
      arrays may need to be filled.















      ..
          !! processed by numpydoc !!


   .. py:method:: plot(ax=None)
      :abstractmethod:


      
      Plot the element.
















      ..
          !! processed by numpydoc !!