opendrift.models.openoil.adios.models.oil.physical_properties

Main class that represents an oil record.

This maps to the JSON used in the DB

Having a Python class makes it easier to write importing, validating etc, code.

Module Contents

Classes

RefTempList

mixin for all classes that are a list of points with

DensityPoint

DensityList

just like a list, but with the ability to turn it into JSON

DynamicViscosityPoint

DynamicViscosityList

just like a list, but with the ability to turn it into JSON

KinematicViscosityPoint

KinematicViscosityList

just like a list, but with the ability to turn it into JSON

PourPoint

FlashPoint

InterfacialTensionPoint

InterfacialTensionList

just like a list, but with the ability to turn it into JSON

PhysicalProperties

class opendrift.models.openoil.adios.models.oil.physical_properties.RefTempList[source]

mixin for all classes that are a list of points with reference temperatures

validate()[source]

validater for anything that has a list of reference temps

e.g. density and viscosity

For viscosity it checks for shear rate as well.

class opendrift.models.openoil.adios.models.oil.physical_properties.DensityPoint[source]
density: opendrift.models.openoil.adios.models.common.measurement.Density
ref_temp: opendrift.models.openoil.adios.models.common.measurement.Temperature
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.DensityList[source]

Bases: opendrift.models.openoil.adios.models.common.utilities.JSON_List, RefTempList

just like a list, but with the ability to turn it into JSON

A regular list can only be converted to JSON if it has JSON-able objects in it.

Note: must be subclassed, and the item_type attribute set

Initialize self. See help(type(self)) for accurate signature.

item_type
class opendrift.models.openoil.adios.models.oil.physical_properties.DynamicViscosityPoint[source]
viscosity: opendrift.models.openoil.adios.models.common.measurement.DynamicViscosity
ref_temp: opendrift.models.openoil.adios.models.common.measurement.Temperature
shear_rate: opendrift.models.openoil.adios.models.common.measurement.AngularVelocity
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.DynamicViscosityList[source]

Bases: opendrift.models.openoil.adios.models.common.utilities.JSON_List, RefTempList

just like a list, but with the ability to turn it into JSON

A regular list can only be converted to JSON if it has JSON-able objects in it.

Note: must be subclassed, and the item_type attribute set

Initialize self. See help(type(self)) for accurate signature.

item_type
class opendrift.models.openoil.adios.models.oil.physical_properties.KinematicViscosityPoint[source]
viscosity: opendrift.models.openoil.adios.models.common.measurement.KinematicViscosity
ref_temp: opendrift.models.openoil.adios.models.common.measurement.Temperature
shear_rate: opendrift.models.openoil.adios.models.common.measurement.AngularVelocity
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.KinematicViscosityList[source]

Bases: opendrift.models.openoil.adios.models.common.utilities.JSON_List, RefTempList

just like a list, but with the ability to turn it into JSON

A regular list can only be converted to JSON if it has JSON-able objects in it.

Note: must be subclassed, and the item_type attribute set

Initialize self. See help(type(self)) for accurate signature.

item_type
class opendrift.models.openoil.adios.models.oil.physical_properties.PourPoint[source]
measurement: opendrift.models.openoil.adios.models.common.measurement.Temperature
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.FlashPoint[source]
measurement: opendrift.models.openoil.adios.models.common.measurement.Temperature
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.InterfacialTensionPoint[source]
tension: opendrift.models.openoil.adios.models.common.measurement.InterfacialTension
ref_temp: opendrift.models.openoil.adios.models.common.measurement.Temperature
method: str
class opendrift.models.openoil.adios.models.oil.physical_properties.InterfacialTensionList[source]

Bases: opendrift.models.openoil.adios.models.common.utilities.JSON_List, RefTempList

just like a list, but with the ability to turn it into JSON

A regular list can only be converted to JSON if it has JSON-able objects in it.

Note: must be subclassed, and the item_type attribute set

Initialize self. See help(type(self)) for accurate signature.

item_type
class opendrift.models.openoil.adios.models.oil.physical_properties.PhysicalProperties[source]
pour_point: PourPoint
flash_point: FlashPoint
densities: DensityList
kinematic_viscosities: KinematicViscosityList
dynamic_viscosities: DynamicViscosityList
interfacial_tension_air: InterfacialTensionList
interfacial_tension_water: InterfacialTensionList
interfacial_tension_seawater: InterfacialTensionList