API¶

xomega¶

xomega.xomega.w_rigid(N2, f0, beta, Frhs, kx, ky, dZ, dZ0=None, dZ1=None, zdim='Zl', dim=None, coord=None)[source]¶

Inverts the Omega equation given by Giordani and Planton (2000) to get the balanced vertical velocity (\(w_b\)) for rigid-lid boundary conditions given the right-hand side fo the equation.

Parameters:

N2 : float or xarray.DataArray: The buoyancy frequency.
f0 : float: Coriolis parameter.
beta : float: Meridional gradient of the Coriolis parameter for a beta-plane approximation.
Frhs : xarray.DataArray: The Fourier transform of the right-hand side of the Omega equation. The last two dimensions should be the meridional and zonal wavenumber.
kx : xarray.DataArray: Zonal wavenumber.
ky : xarray.DataArray: Meridional wavenumber.
dZ : float or xarray.DataArray: Vertical distance between grid. This should take constant value(s) for best numerical percision.
dZ0 : float or xarray.DataArray, optional: Top vertical distance between grids.
dZ1 : float or xarray.DataArray, optional: Bottom vertical distance between grids.
zdim : str, optional: Dimension name of the vertical axis of Frhs.
dim : list, optional: List of the xarray.DataArray output.
coord : dict, optional: Dictionary of the xarray.DataArray output.

Returns:

wa : xarray.DataArray: The quasi-geostrophic vertical velocity.