earthkit.meteo.vertical.height_on_hybrid_levels

earthkit.meteo.vertical.height_on_hybrid_levels(t: ArrayLike, q: ArrayLike, zs: ArrayLike, sp: ArrayLike, A: ArrayLike, B: ArrayLike, alpha_top: Literal['ifs', 'arpege'] = 'ifs', h_type: Literal['geometric', 'geopotential'] = 'geometric', h_reference: Literal['ground', 'sea'] = 'ground', vertical_dim: int = 0) → ArrayLike
earthkit.meteo.vertical.height_on_hybrid_levels(t: earthkit.data.FieldList, q: earthkit.data.FieldList, zs: earthkit.data.FieldList, sp: earthkit.data.FieldList, A: ArrayLike | None = ..., B: ArrayLike | None = ..., alpha_top: Literal['ifs', 'arpege'] = 'ifs', h_type: Literal['geometric', 'geopotential'] = 'geometric', h_reference: Literal['ground', 'sea'] = 'ground') → earthkit.data.FieldList

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

Parameters:

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

  • q (ArrayLike | FieldList) – Specific humidity on hybrid full-levels (kg/kg). Must have the same shape, level range and order as t. See the concrete implementations for details.

  • zs (ArrayLike | FieldList) – Surface geopotential (m2/s2). Not used when h_type is "geopotential" and h_reference is "ground". See the concrete implementations for details.

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

  • A (array-like | None, optional) – 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 metadata (FieldList only).

  • B (array-like | None, optional) – 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. Can be None for FieldList/Field input if the coefficients can be resolved from metadata (FieldList only).

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

  • h_type ({"geometric", "geopotential"}, default "geometric") –

    Type of height to compute. Possible values are:

    • "geometric": geometric height (m) with respect to h_reference

    • "geopotential": geopotential height (m) with respect to h_reference

  • h_reference ({"ground", "sea"}, default "ground") –

    Reference level for the height calculation. Possible values are:

    • "ground": height with respect to the ground/surface level

    • "sea": height with respect to sea level

  • vertical_dim (int, default 0) – Axis corresponding to the vertical coordinate in the input and output arrays. Default is 0.

Returns:

Height (m) on hybrid full-levels with respect to h_reference. The type of height is defined by h_type. See the concrete implementations for details.

Return type:

array-like | FieldList

Implementations

height_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.