opendrift.readers.reader_telemac_selafin
========================================

.. py:module:: opendrift.readers.reader_telemac_selafin


Attributes
----------

.. autoapisummary::

   opendrift.readers.reader_telemac_selafin.logger
   opendrift.readers.reader_telemac_selafin.pytel


Classes
-------

.. autoapisummary::

   opendrift.readers.reader_telemac_selafin.Reader


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

.. py:data:: logger

.. py:data:: pytel

.. py:class:: Reader(filename=None, name=None, proj4=None, start_time=None)

   Bases: :py:obj:`opendrift.readers.basereader.BaseReader`, :py:obj:`opendrift.readers.basereader.UnstructuredReader`


   A reader for unstructured (irregularily gridded) `Telemac3D` files.
   Args:
       :param filename: A single Selafin file
       :type filename: string, required.
       :param name: Name of reader
       :type name: string, optional
       :param proj4: PROJ.4 string describing projection of data.
       :type proj4: string, optional
   .. seealso::
       py:mod:`opendrift.readers.basereader.unstructured`.

   Common constructor for all readers


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



   .. py:attribute:: slf


   .. py:attribute:: proj4
      :value: None



   .. py:attribute:: boundary


   .. py:attribute:: tree


   .. py:attribute:: times
      :value: []


      Setting this to `True` overrides temporal and spatial bounds checks.
      Also useful for readers that are constant and do not have a temporal
      dimension.



   .. py:attribute:: end_time


   .. py:attribute:: altitude_ID


   .. py:attribute:: meshID


   .. py:method:: plot_mesh()

      Plot the grid mesh. Does not automatically show the figure.



   .. py:method:: get_variables(requested_variables, time=None, x=None, y=None, z=None)

      - Query variables based on the particle coordinates x, y, z
      - find the nearest node in the KD tree
      - extract the z array corresponding.
      - extract the index of the node within the 3D mesh
      - extract the variables at the point
      Args:
          x,y,z: np.arrays(float)
              3D coordinates of the particles
          time: np.datetime64
              age of the particle set
          variables: np.array(int)
              indexes of variables
      Returns:
          variables: dictionary of numpy arrays



   .. py:method:: __nearest_idx__(array, value)
      :staticmethod:


      we are looking for a tuple describing where the sample is and at which
      distance. So we can calculate the FE solution of the variable value.
      input:
          array: a 1D numpy array
          monotonic array
      output:
          bounds: a tupple
          tupple describing the bounding indexes
          dist = tupple
          the distance between the sample and the index values
          so that dist[0]+dist[1]=0



   .. py:method:: __extractslf__(frames, duration, index_var, index_nodes)

      extract variables from slf files
      index_var must be a list of integer