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
- N2float or xarray.DataArray
The buoyancy frequency.
- f0float
Coriolis parameter.
- betafloat
Meridional gradient of the Coriolis parameter for a beta-plane approximation.
- Frhsxarray.DataArray
The Fourier transform of the right-hand side of the Omega equation. The last two dimensions should be the meridional and zonal wavenumber.
- kxxarray.DataArray
Zonal wavenumber.
- kyxarray.DataArray
Meridional wavenumber.
- dZfloat or xarray.DataArray
Vertical distance between grid. This should take constant value(s) for best numerical percision.
- dZ0float or xarray.DataArray, optional
Top vertical distance between grids.
- dZ1float or xarray.DataArray, optional
Bottom vertical distance between grids.
- zdimstr, optional
Dimension name of the vertical axis of Frhs.
- dimlist, optional
List of the xarray.DataArray output.
- coorddict, optional
Dictionary of the xarray.DataArray output.
- Returns
- waxarray.DataArray
The inverted ageostrophic vertical velocity.