:py:mod:`gnome.movers.vertical_movers`
======================================

.. py:module:: gnome.movers.vertical_movers


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

Classes
~~~~~~~

.. autoapisummary::

   gnome.movers.vertical_movers.RiseVelocityMover
   gnome.movers.vertical_movers.TamocRiseVelocityMover




.. py:class:: RiseVelocityMover(**kwargs)


   Bases: :py:obj:`gnome.movers.CyMover`

   This mover class inherits from CyMover and contains CyRiseVelocityMover

   The real work is done by CyRiseVelocityMover.
   CyMover sets everything up that is common to all movers.

   Uses super to invoke base class __init__ method.

   Optional parameters (kwargs) used to initialize CyRiseVelocityMover

   :param water_density: Default is 1020 kg/m3
   :param water_viscosity: Default is 1.e-6

   Remaining kwargs are passed onto Mover's __init__ using super.
   See Mover documentation for remaining valid kwargs.

   .. py:attribute:: _schema

      

   .. py:method:: __repr__()

      .. todo::
          We probably want to include more information.


   .. py:method:: get_move(sc, time_step, model_time_datetime)

      Override base class functionality because mover has a different
      get_move signature

      :param sc: an instance of the gnome.SpillContainer class
      :param time_step: time step in seconds
      :param model_time_datetime: current time of the model as a date time
          object



.. py:class:: TamocRiseVelocityMover(*args, **kwargs)


   Bases: :py:obj:`RiseVelocityMover`

   The only thing this adds (so far)

   are droplet_diameter and density array types

   Uses super to invoke base class __init__ method.

   Optional parameters (kwargs) used to initialize CyRiseVelocityMover

   :param water_density: Default is 1020 kg/m3
   :param water_viscosity: Default is 1.e-6

   Remaining kwargs are passed onto Mover's __init__ using super.
   See Mover documentation for remaining valid kwargs.