polaris.ocean.vertical.diagnostics.vert_pseudo_velocity_from_ds

polaris.ocean.vertical.diagnostics.vert_pseudo_velocity_from_ds(ds, src_var_name='vertVelocityTop', ds_vert=None)[source]

Compute a vertical pseudo-velocity at layer interfaces from a geometric vertical velocity such as vertVelocityTop, the inverse of vert_velocity_top_from_ds(). The specific volume is interpolated to interfaces in the same way.

Parameters:

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

  • src_var_name (str, optional) – The geometric vertical velocity at layer interfaces to convert, typically vertVelocityTop or vertAleTransportTop

  • 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:

pseudo_velocity (xarray.DataArray) – The vertical pseudo-velocity at layer interfaces, with the dimensions of src_var_name