gnome.movers.vertical_movers

Classes

RiseVelocityMover	This mover class inherits from CyMover and contains CyRiseVelocityMover
TamocRiseVelocityMover	The only thing this adds (so far)

Module Contents

class gnome.movers.vertical_movers.RiseVelocityMover(**kwargs)

Bases: gnome.movers.CyMover

This mover class inherits from CyMover and contains CyRiseVelocityMover

The real work is done by CyRiseVelocityMover. CyMover sets everything up that is common to all movers.

Uses super to invoke base class __init__ method.

Optional parameters (kwargs) used to initialize CyRiseVelocityMover

Parameters:

• water_density – Default is 1020 kg/m3

• water_viscosity – Default is 1.e-6

Remaining kwargs are passed onto Mover’s __init__ using super. See Mover documentation for remaining valid kwargs.

mover

get_move(sc, time_step, model_time_datetime)

Override base class functionality because mover has a different get_move signature

Parameters:

• sc – an instance of the gnome.SpillContainer class

• time_step – time step in seconds

• model_time_datetime – current time of the model as a date time object

class gnome.movers.vertical_movers.TamocRiseVelocityMover(*args, **kwargs)

Bases: RiseVelocityMover

The only thing this adds (so far)

are droplet_diameter and density array types

Uses super to invoke base class __init__ method.

Optional parameters (kwargs) used to initialize CyRiseVelocityMover

Parameters:

• water_density – Default is 1020 kg/m3

• water_viscosity – Default is 1.e-6

Remaining kwargs are passed onto Mover’s __init__ using super. See Mover documentation for remaining valid kwargs.