Module `ocean_science_utilities.wavephysics.fluidproperties`

Expand source code

import xarray

from typing import Union

GRAVITATIONAL_ACCELERATION = 9.81
WATER_DENSITY = 1024.0
WATER_TEMPERATURE_DEGREES_C = 15.0
AIR_TEMPERATURE_DEGREES_C = 15.0
AIR_DENSITY = 1.225
KINEMATIC_VISCOSITY_WATER = 1.19e-6
KINEMATIC_VISCOSITY_AIR = 1.48e-5
VONKARMAN_CONSTANT = 0.4
SURFACE_TENSION_WATER = 0.073
SURFACE_TENSION_AIR = 0.0

_input_type = Union[xarray.DataArray, float]


class FluidProperties:
    def __init__(
        self,
        density: _input_type,
        temperature: _input_type,
        kinematic_viscosity: _input_type,
        vonkarman_constant: _input_type,
        surface_tension: _input_type,
    ):
        self.density = density
        self.temperature = temperature
        self.kinematic_viscosity = kinematic_viscosity
        self.vonkarman_constant = vonkarman_constant
        self.surface_tension = surface_tension

    @property
    def kinematic_surface_tension(self):
        return self.surface_tension / self.density


AIR = FluidProperties(
    density=AIR_DENSITY,
    temperature=AIR_TEMPERATURE_DEGREES_C,
    kinematic_viscosity=KINEMATIC_VISCOSITY_AIR,
    vonkarman_constant=VONKARMAN_CONSTANT,
    surface_tension=SURFACE_TENSION_AIR,
)

WATER = FluidProperties(
    density=WATER_DENSITY,
    temperature=WATER_TEMPERATURE_DEGREES_C,
    kinematic_viscosity=KINEMATIC_VISCOSITY_WATER,
    vonkarman_constant=VONKARMAN_CONSTANT,
    surface_tension=SURFACE_TENSION_WATER,
)

Classes

class FluidProperties (density: Union[xarray.core.dataarray.DataArray, float], temperature: Union[xarray.core.dataarray.DataArray, float], kinematic_viscosity: Union[xarray.core.dataarray.DataArray, float], vonkarman_constant: Union[xarray.core.dataarray.DataArray, float], surface_tension: Union[xarray.core.dataarray.DataArray, float])

Expand source code

class FluidProperties:
    def __init__(
        self,
        density: _input_type,
        temperature: _input_type,
        kinematic_viscosity: _input_type,
        vonkarman_constant: _input_type,
        surface_tension: _input_type,
    ):
        self.density = density
        self.temperature = temperature
        self.kinematic_viscosity = kinematic_viscosity
        self.vonkarman_constant = vonkarman_constant
        self.surface_tension = surface_tension

    @property
    def kinematic_surface_tension(self):
        return self.surface_tension / self.density

Instance variables

var kinematic_surface_tension

Expand source code

@property
def kinematic_surface_tension(self):
    return self.surface_tension / self.density