earthkit.meteo.vertical.array.geopotential_on_hybrid_levels¶

earthkit.meteo.vertical.array.geopotential_on_hybrid_levels(t, q, zs, sp, A, B, alpha_top='ifs', vertical_dim=0)¶

Compute the geopotential on hybrid (IFS model) full-levels.

New in version 1.0.0

Parameters:

t (ArrayLike) – Temperature on hybrid full-levels (K). The axis corresponding to the vertical coordinate (hybrid levels) is defined by the vertical_dim parameter. The levels must be in ascending order with respect the model level number. Not all the levels must be present, but a contiguous level range including the bottom-most level must be used. E.g. if the vertical coordinate system has 137 model levels using only a subset of levels between e.g. 137-96 is allowed.
q (ArrayLike) – Specific humidity on hybrid full-levels (kg/kg). Must have the same shape, level range and order as t.
zs (ArrayLike) – Surface geopotential (m2/s2).
sp (ArrayLike) – Surface pressure (Pa).
A (ArrayLike) – A-coefficients defining the hybrid levels. Must contain all the half-levels in ascending order with respect to the model level number.
B (ArrayLike) – B-coefficients defining the hybrid levels. Must contain all the half-levels in ascending order with respect to the model level number. Must have the same size as A.
alpha_top ({"ifs", "arpege"}, default "ifs") – Option to initialise the alpha parameters (for details see below) on the top of the model atmosphere (first half-level in the vertical coordinate system). See earthkit.meteo.vertical.array.pressure_on_hybrid_levels() for details.
vertical_dim (int) – Axis corresponding to the vertical coordinate (model levels) in the input t and q arrays and also in the output array. Default is 0 (first axis).

Returns:

Geopotential (m2/s2) on hybrid full-levels. The axis corresponding to the vertical coordinate (hybrid levels) is defined by the vertical_dim parameter.

Return type:

ArrayLike