opendrift.models.openoil.adios.models.oil.cleanup.cleanup

classes for options to clean up Records

Module Contents

Classes

Cleanup

initialize a Cleanup object with an oil object
class opendrift.models.openoil.adios.models.oil.cleanup.cleanup.Cleanup(oil)[source]

initialize a Cleanup object with an oil object

Parameters:

oil (adios_db.models.oil.oil.OIl) – the oil object you want to clean up

ID
abstract cleanup(oil, do_it=False)[source]

run this particular cleanup option

Parameters:

  • oil – an Oil object to act on

  • do_it=False – flag to tell the cleanup to do its thing. If False, the method returns a message. If True, the action is taken, and the Oil object is altered.

Returns:

a message of what could be done, or what was done.