opendrift.readers.reader_double_gyre
====================================

.. py:module:: opendrift.readers.reader_double_gyre


Classes
-------

.. autoapisummary::

   opendrift.readers.reader_double_gyre.Reader


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

.. py:class:: Reader(initial_time=datetime(2000, 1, 1, 0, 0), epsilon=0.1, omega=0.628, A=0.25, proj4='+proj=stere +lat_0=0 +lon_0=0 +lat_ts=0 ' + '+units=m +a=6.371e+06 +e=0 +no_defs')

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


   Analytical current field with double gyre

   Common constructor for all readers


   .. py:attribute:: fileName
      :value: 'double_gyre'



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



   .. py:attribute:: proj4
      :value: '+proj=stere +lat_0=0 +lon_0=0 +lat_ts=0 +units=m +a=6.371e+06 +e=0 +no_defs'



   .. py:attribute:: proj


   .. py:attribute:: xmin
      :value: 0.0



   .. py:attribute:: xmax
      :value: 2.0



   .. py:attribute:: ymin
      :value: 0.0



   .. py:attribute:: ymax
      :value: 1.0



   .. py:attribute:: A
      :value: 0.25



   .. py:attribute:: epsilon
      :value: 0.1



   .. py:attribute:: omega
      :value: 0.628



   .. py:attribute:: initial_time


   .. py:attribute:: start_time
      :value: None



   .. py:attribute:: end_time
      :value: None



   .. py:attribute:: time_step
      :value: None



   .. py:attribute:: variables
      :value: ['x_sea_water_velocity', 'y_sea_water_velocity']



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

      Obtain and return values of the requested variables at all positions
      (x, y, z) closest to given time.

      Returns:

          Dictionary with arrays of length len(x) with values at exact positions x, y and z.