xwmt.compute module

xwmt.compute module#

xwmt.compute.calc_hlamdot_tendency(grid, datadict, h=None)#

Wrapper functions to determine h times lambda_dot (vertically extensive tendency)

h is the cell-center thickness metric, forwarded to hlamdot_from_Jlam for the interfacial-flux case.

xwmt.compute.hlamdot_from_Jlam(grid, Jlam, dim, h=None)#

Calculation of hlamdot (cell-depth integral of scalar tendency) from interfacial fluxes.

Parameters:

  • grid (xgcm.Grid)

  • Jlam (xr.DataArray) – Interfacial flux of the tracer.

  • dim (str) – Axis along which to difference (e.g. “Z”).

  • h (xr.DataArray, optional) – Cell-center thickness metric. If None, it is looked up from the grid metrics.