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

.. py:module:: opendrift.models.sedimentdrift

.. autoapi-nested-parse::

   SedimentDrift is an OpenDrift module for drift and settling of sediments.
   Based on work by Simon Weppe, MetOcean Solutions Ltd.



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

Classes
~~~~~~~

.. autoapisummary::

   opendrift.models.sedimentdrift.SedimentElement
   opendrift.models.sedimentdrift.SedimentDrift




Attributes
~~~~~~~~~~

.. autoapisummary::

   opendrift.models.sedimentdrift.logger


.. py:data:: logger

   

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


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

   Extending LagrangianArray for elements moving in 3 dimensions
   The Particle may be buoyant and/or subject to vertical mixing
   buoyant bahaviour is described by terminal velocity

   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:: SedimentDrift(*args, **kwargs)


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

   Model for sediment drift, under development
       

   Constructor of SedimentDrift module
           

   .. py:attribute:: ElementType

      

   .. py:attribute:: required_variables

      

   .. py:method:: update()

      Update positions and properties of sediment particles.
              


   .. py:method:: bottom_interaction(seafloor_depth)

      Sub method of vertical_mixing, determines settling


   .. py:method:: resuspension()

      Resuspending elements if current speed > .5 m/s