polaris.ocean.vertical.diagnostics.vert_velocity_top_from_ds

polaris.ocean.vertical.diagnostics.vert_velocity_top_from_ds(ds, ds_vert=None)[source]

Compute the geometric vertical velocity at layer interfaces, vertVelocityTop, from Omega’s VerticalPseudoVelocity. The specific volume is interpolated from layer midpoints to interfaces linearly in geometric height, and held constant above the top and below the bottom valid layer.

Parameters:

  • ds (xarray.Dataset) – An ocean dataset with MPAS-Ocean names, containing VerticalPseudoVelocity and SpecVol, along with the geometric layer thickness or the fields needed to compute it (see geom_thickness_from_ds())

  • ds_vert (xarray.Dataset, optional) – The vertical coordinate dataset, whose minLevelCell and maxLevelCell (one-based) mark the valid layers. All layers are valid if it is not given.

Returns:

vert_velocity_top (xarray.DataArray) – The geometric vertical velocity at layer interfaces, with the dimensions of VerticalPseudoVelocity