:py:mod:`opendrift.models.pelagicegg`
=====================================

.. py:module:: opendrift.models.pelagicegg


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

Classes
~~~~~~~

.. autoapisummary::

   opendrift.models.pelagicegg.PelagicEgg
   opendrift.models.pelagicegg.PelagicEggDrift




Attributes
~~~~~~~~~~

.. autoapisummary::

   opendrift.models.pelagicegg.logger


.. py:data:: logger

   

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


   Bases: :py:obj:`opendrift.models.oceandrift.Lagrangian3DArray`

   Extending Lagrangian3DArray with specific properties for pelagic eggs
       

   Initialises a LagrangianArray with given properties.

   Args:
       Keyword arguments (kwargs) with names corresponding to the
       OrderedDict 'variables' of the class, and corresponding values.
       The values must be ndarrays of equal length, or scalars.
       All (or none) variables must be given, unless a default value
       is specified in the OrderedDict 'variables'
       An empty object may be created by giving no input.

   .. py:attribute:: variables

      


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


   Bases: :py:obj:`opendrift.models.oceandrift.OceanDrift`

   Buoyant particle trajectory model based on the OpenDrift framework.

   Developed at MET Norway

   Generic module for particles that are subject to vertical turbulent
   mixing with the possibility for positive or negative buoyancy

   Particles could be e.g. oil droplets, plankton, or sediments

   Under construction.

   Initialise OpenDriftSimulation

   Args:
       seed: integer or None. A given integer will yield identical
           random numbers drawn each simulation. Random numbers are
           e.g. used to distribute particles spatially when seeding,
           and may be used by modules (subclasses) for e.g. diffusion.
           Specifying a fixed value (default: 0) is useful for sensitivity
           tests. With seed = None, different random numbers will be drawn
           for subsequent runs, even with identical configuration/input.
       iomodule: name of module used to export data
           default: netcdf, see :py:mod:`opendrift.io` for more alternatives.
           `iomodule` is module/filename without preceeding `io_`
       loglevel: set to 0 (default) to retrieve all debug information.
           Provide a higher value (e.g. 20) to receive less output.
           Use the string 'custom' to configure logging from outside.
       logtime: if True, a time stamp is given for each logging line.
                logtime can also be given as a python time specifier
                (e.g. '%H:%M:%S')

   .. py:attribute:: ElementType

      

   .. py:attribute:: required_variables

      

   .. py:attribute:: status_colors

      

   .. py:method:: update_terminal_velocity(Tprofiles=None, Sprofiles=None, z_index=None)

      Calculate terminal velocity for Pelagic Egg

      according to
      S. Sundby (1983): A one-dimensional model for the vertical
      distribution of pelagic fish eggs in the mixed layer
      Deep Sea Research (30) pp. 645-661

      Method copied from ibm.f90 module of LADIM:
      Vikebo, F., S. Sundby, B. Aadlandsvik and O. Otteraa (2007),
      Fish. Oceanogr. (16) pp. 216-228


   .. py:method:: update()

      Update positions and properties of buoyant particles.