gnome.utilities.plume

This module holds classes and supporting code for simulating the vertical plume that is generated by an underwater blowout.

Module Contents

Classes

Plume

Here, we represent the characteristics of the plume

PlumeGenerator

Here we define the method for generating LEs from a 3D plume

Functions

get_plume_data()

Here we will generate plume data that conforms to that of Socolofsky's

Attributes

release_time

gnome.utilities.plume.get_plume_data()

Here we will generate plume data that conforms to that of Socolofsky’s model.

  • We will represent the mass flux amounts in kg/s.

  • We will probably get these values from a running plume model, but for right now, we just return an array with some hardcoded values.

  • For now, we return data in the format [(depth, mass_flux), …]

class gnome.utilities.plume.Plume(position, plume_data)

Bases: object

Here, we represent the characteristics of the plume as a set of mass fluxes along a vertical stack.

Parameters:
  • position (3-tuple of floats (long, lat, z)) – location the elements are released

  • plume_data (list of items in the format: [(depth, mass_flux), ...]) – data that is supplied by a plume model

Note:

we don’t really use the z, since the plume data supplies the depths

class gnome.utilities.plume.PlumeGenerator(release_time, end_release_time, time_step_delta, plume)

Bases: object

Here we define the method for generating LEs from a 3D plume over a range of time.

property time_step_delta
_seconds_from_beginning(time)

qualify our time value and return total number of seconds from release time to the specified time

set_le_mass_from_total_le_count(num_elements)
_mass_to_elems(mass)

Calculate mass into an equivalent number of LEs and return them. - We do not count the fractional amounts.

_elems_to_mass(elems)

Calculate LEs into equivalent amounts of mass and return them.

elems_from_beginning(time)

returns the number of LEs released from release_time to the specified time

elems_in_range(begin, end)
__iter__()
gnome.utilities.plume.release_time