ttim.linedoublet
================

.. py:module:: ttim.linedoublet


Classes
-------

.. autoapisummary::

   ttim.linedoublet.LineDoubletHoBase
   ttim.linedoublet.LeakyLineDoublet
   ttim.linedoublet.LeakyLineDoubletString


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

.. py:class:: LineDoubletHoBase(model, x1=-1, y1=0, x2=1, y2=0, tsandbc=[(0.0, 0.0)], res='imp', order=0, layers=0, type='', name='LineDoubletHoBase', label=None, addtomodel=True)

   Bases: :py:obj:`ttim.element.Element`


   
   Higher Order LineDoublet Base Class.

   All Higher Order Line Doublet elements are derived from this class















   ..
       !! processed by numpydoc !!

   .. py:attribute:: order
      :value: 0



   .. py:attribute:: nparam


   .. py:attribute:: x1


   .. py:attribute:: y1


   .. py:attribute:: x2


   .. py:attribute:: y2


   .. py:method:: __repr__()


   .. py:method:: initialize()

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

      
      Separate function so that this can be overloaded for other types.
















      ..
          !! processed by numpydoc !!


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

      
      Can be called with only one x,y value.
















      ..
          !! processed by numpydoc !!


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

      
      Can be called with only one x,y value.
















      ..
          !! processed by numpydoc !!


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

      
      Plot the element.
















      ..
          !! processed by numpydoc !!


.. py:class:: LeakyLineDoublet(model, x1=-1, y1=0, x2=1, y2=0, res='imp', order=0, layers=0, label=None, addtomodel=True)

   Bases: :py:obj:`LineDoubletHoBase`, :py:obj:`ttim.equation.LeakyWallEquation`


   
   Create a segment of a leaky wall, which is simulated with a line-doublet.

   The specific discharge through the wall is equal to the head difference
   across the wall divided by the resistance of the wall.

   :param model: Model to which the element is added
   :type model: Model object
   :param x1: x-coordinate of fist point of line-doublet
   :type x1: scalar
   :param y1: y-coordinate of fist point of line-doublet
   :type y1: scalar
   :param x2: x-coordinate of second point of line-doublet
   :type x2: scalar
   :param y2: y-coordinate of second point of line-doublet
   :type y2: scalar
   :param res: if string: 'imp' for an impermeable wall (same as res = np.inf)
               if scalar: resistance of leaky wall
   :type res: scalar or string
   :param order: polynomial order of potential jump along line-doublet
                 (head jump if transmissivity is equal on each side of wall)
   :type order: int (default is 0)
   :param layers: layer(s) in which element is placed
                  if scalar: element is placed in this layer
                  if list or array: element is placed in all these layers
   :type layers: scalar, list or array
   :param label: label of element
   :type label: str or None

   .. seealso:: :class:`.LeakyLineDoubletString`















   ..
       !! processed by numpydoc !!

   .. py:attribute:: nunknowns


   .. py:method:: initialize()

      
      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:class:: LeakyLineDoubletString(model, xy=[(-1, 0), (1, 0)], res='imp', order=0, layers=0, label=None)

   Bases: :py:obj:`ttim.element.Element`, :py:obj:`ttim.equation.LeakyWallEquation`


   
   Create a string of leaky wall segements consisting of line-doublets.

   :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 end-points of
              the segements in the string
   :type xy: array or list
   :param res: if string: 'imp' for an impermeable wall (same as res = np.inf)
               if scalar: resistance of leaky wall
   :type res: scalar or string
   :param order: polynomial order of potential jump along line-doublet
                 (head jump if transmissivity is equal on each side of wall)
   :type order: int (default is 0)
   :param layers: layer(s) in which element is placed
                  if scalar: element is placed in this layer
                  if list or array: element is placed in all these layers
   :type layers: scalar, list or array
   :param label: label of element
   :type label: str or None

   .. seealso:: :class:`.LeakyLineDoublet`















   ..
       !! processed by numpydoc !!

   .. py:attribute:: res
      :value: 'imp'



   .. py:attribute:: order
      :value: 0



   .. py:attribute:: ldlist
      :value: []



   .. py:attribute:: nld


   .. py:method:: __repr__()


   .. py:method:: initialize()

      
      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)

      
      Returns array (nunknowns,nperiods).
















      ..
          !! processed by numpydoc !!


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

      
      Returns array (nunknowns,nperiods).
















      ..
          !! processed by numpydoc !!


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

      
      Plot the element.
















      ..
          !! processed by numpydoc !!