ageostrophic_wind¶
-
metpy.calc.ageostrophic_wind(heights, f, dx, dy, u, v, dim_order='yx')[source]¶ Calculate the ageostrophic wind given from the heights or geopotential.
- Parameters
heights ((M, N) ndarray) – The height or geopotential field.
f (array_like) – The coriolis parameter. This can be a scalar to be applied everywhere or an array of values.
dx (
pint.Quantity) – The grid spacing(s) in the x-direction. If an array, there should be one item less than the size of heights along the applicable axis.dy (
pint.Quantity) – The grid spacing(s) in the y-direction. If an array, there should be one item less than the size of heights along the applicable axis.u ((M, N)
pint.Quantity) – The u wind field.v ((M, N)
pint.Quantity) – The u wind field.
- Returns
A 2-item tuple of arrays,
pint.Quantity– A tuple of the u-component and v-component of the ageostrophic wind.
Notes
If inputs have more than two dimensions, they are assumed to have either leading dimensions of (x, y) or trailing dimensions of (y, x), depending on the value of
dim_order.The order of the inputs will be changed in 1.0 to be (heights, u, v, f, dx, dy). To updated to the new format, use from metpy.future import ageostrophic_wind.