plasticparcels.constructors#

plasticparcels.constructors.create_fieldset(settings)[source]#

A constructor method to create a Parcels.Fieldset with all fields necessary for a plasticparcels simulation (e.g., a hydrodynamic model velocity field, biogeochemical model variable fields, a wind field, etc.).

Parameters:: settings – A dictionary of settings that contains an ocean model information, biogeochemical model information, wind model information, and other optional settings.
Returns:: A parcels.FieldSet object.
Return type:: fieldset

plasticparcels.constructors.create_hydrodynamic_fieldset(settings)[source]#

A constructor method to create a Parcels.Fieldset from hydrodynamic model data.

Parameters:: settings – A dictionary of settings that contains an ocean model directory, a filename style, and the location of the ocean model mesh file, used to create the fieldset.
Returns:: A parcels.FieldSet object.
Return type:: fieldset

plasticparcels.constructors.create_kernel(fieldset)[source]#

A constructor method to create a list of kernels for a plasticparcels simulation.

Parameters:: fieldset – A parcels.FieldSet object containing constants used to turn on/off different kernel behaviours.
Returns:: A list of kernels used in the execution of the particle set.
Return type:: kernels

plasticparcels.constructors.create_particleset(fieldset, settings, release_locations)[source]#

A constructor method to create a Parcels.ParticleSet for a plasticparcels simulation.

Parameters:

fieldset – A Parcels.FieldSet object.
settings – A dictionary containing the plastic-type settings.
release_locations – A dictionary containing release locations for particles.

Returns:

A parcels.ParticleSet object.

Return type:

particleset

plasticparcels.constructors.create_particleset_from_map(fieldset, settings)[source]#

A constructor method to create a Parcels.ParticleSet for a plasticparcels simulation using one of the available initialisation maps.