earthkit.meteo.vertical.relative_geopotential_thickness_on_hybrid_levels

earthkit.meteo.vertical.relative_geopotential_thickness_on_hybrid_levels(t: ArrayLike, q: ArrayLike, sp: ArrayLike, A: ArrayLike, B: ArrayLike, alpha_top: Literal['ifs', 'arpege'] = 'ifs', vertical_dim: int = 0) → ArrayLike
earthkit.meteo.vertical.relative_geopotential_thickness_on_hybrid_levels(t: earthkit.data.FieldList, q: earthkit.data.FieldList, sp: earthkit.data.FieldList, A: ArrayLike | None = None, B: ArrayLike | None = None, alpha_top: Literal['ifs', 'arpege'] = 'ifs', vertical_dim: int = 0) → earthkit.data.FieldList

Compute the geopotential thickness between the surface and hybrid full-levels.

Parameters:

  • t (array-like | FieldList) – Temperature on hybrid full-levels (K). See the concrete implementations for details.

  • q (array-like | FieldList) – Specific humidity on hybrid full-levels (kg/kg). Must have the same shape, level range and order as t.

  • sp (array-like | FieldList) – Surface pressure (Pa). See the concrete implementations for details.

  • A (array-like | None) – A-coefficients defining the hybrid levels. Must contain all the half-levels in ascending order with respect to the model level number. Can be None for FieldList/Field input if the coefficients can be resolved from the metadata of sp.

  • B (array-like | None, optional) – B-coefficients defining the hybrid levels. Must have the same size as A. Can be None for FieldList/Field input if the coefficients can be resolved from the metadata of sp.

  • alpha_top ({"ifs", "arpege"}, default "ifs") – Option to initialise alpha at the top of the model atmosphere. Default is "ifs". See pressure_on_hybrid_levels() for details.

  • vertical_dim (int, default 0) – Axis corresponding to the vertical coordinate in the input and output arrays. Default is 0. Cannot be specified for FieldList/Field data.

Returns:

Geopotential thickness (m2/s2) between the surface and hybrid full-levels. The axis corresponding to the vertical coordinate is defined by vertical_dim.

Return type:

array-like | FieldList

See also

pressure_on_hybrid_levels, relative_geopotential_thickness_on_hybrid_levels_from_alpha_delta

Implementations

relative_geopotential_thickness_on_hybrid_levels() calls one of the following implementations depending on the type of the input arguments:

The function returns an object of the same type as the input arguments.