:py:mod:`opendrift.readers.reader_oscillating`
==============================================

.. py:module:: opendrift.readers.reader_oscillating


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

Classes
~~~~~~~

.. autoapisummary::

   opendrift.readers.reader_oscillating.Reader




.. py:class:: Reader(variable, amplitude, period_seconds=3600 * 24, phase=0, zero_time=datetime(2017, 1, 1, 0))


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

   Returning values oscillating in time with given amplitude and period

   init with 

   .. 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.