earthkit.meteo.vertical.array.height_on_hybrid_levels¶
- earthkit.meteo.vertical.array.height_on_hybrid_levels(t, q, zs, sp, A, B, alpha_top='ifs', h_type='geometric', h_reference='ground', vertical_dim=0)¶
Compute the height 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 thevertical_dimparameter. 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 ast.zs (
ArrayLike) – Surface geopotential (m2/s2). Not used whenh_typeis “geopotential” andh_referenceis “ground”.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 asA.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). Seepressure_on_hybrid_levels()for details.h_type (
{"geometric", "geopotential"}, default"geometric") –Type of height to compute. Default is “geometric”. Possible values are:
”geometric”: geometric height (m) with respect to
h_reference”geopotential”: geopotential height (m) with respect to
h_reference
See
geometric_height_from_geopotential()andgeopotential_height_from_geopotential()for details.h_reference (
{"ground", "sea"}, default"ground") –Reference level for the height calculation. Default is “ground”. Possible values are:
”ground”: height with respect to the ground/surface level
”sea”: height with respect to the sea level
vertical_dim (
int) – Axis corresponding to the vertical coordinate (hybrid full-levels) in the input arrays and also in the output array. Default is 0 (first axis).
- Returns:
Height (m) of hybrid full-levels with respect to
h_reference. The type of height is defined byh_type(“geometric” or “geopotential”). The axis corresponding to the vertical coordinate (hybrid levels) is defined by thevertical_dimparameter.- Return type:
ArrayLike
See also
hybrid_level_parameters,pressure_on_hybrid_levels,geopotential_on_hybrid_levels,relative_geopotential_thickness_on_hybrid_levelsNotes
The height is calculated from the geopotential on hybrid levels, which is computed from the
t,q,zsand the hybrid level definition (A,Bandsp). The computations are described in [IFS-CY49R1-Dynamics] Chapter 2, Section 2.2.1.Examples
/how-tos/hybrid_levels.ipynb