opendrift.models.sedimentdrift

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

Module Contents

Classes

SedimentElement

Extending LagrangianArray for elements moving in 3 dimensions

SedimentDrift

Model for sediment drift, under development

opendrift.models.sedimentdrift.logger
class opendrift.models.sedimentdrift.SedimentElement(**kwargs)[source]

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

variables
class opendrift.models.sedimentdrift.SedimentDrift(*args, **kwargs)[source]

Bases: opendrift.models.oceandrift.OceanDrift

Model for sediment drift, under development

Constructor of SedimentDrift module

ElementType
required_variables
update(self)[source]

Update positions and properties of sediment particles.

bottom_interaction(self, seafloor_depth)[source]

Sub method of vertical_mixing, determines settling

resuspension(self)[source]

Resuspending elements if current speed > .5 m/s