opendrift.models.plastdrift

Attributes

logger

Classes

`PlastElement`	Extending LagrangianArray for elements moving in 3 dimensions
`PlastDrift`	Trajectory model based on the OpenDrift framework.

Module Contents

opendrift.models.plastdrift.logger

class opendrift.models.plastdrift.PlastElement(**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.plastdrift.PlastDrift(*args, **kwargs)[source]

Bases: opendrift.models.oceandrift.OceanDrift

Trajectory model based on the OpenDrift framework.

Propagation of plastics particles with ocean currents and additional Stokes drift and wind drag.

Developed at MET Norway.

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 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’)

ElementType: Any trajectory model implementation must define an ElementType.

required_variables: Any trajectory model implementation must list needed variables.

update()[source]: Update positions and properties of elements.

update_particle_depth()[source]