earthkit.meteo.vertical.pressure_on_hybrid_levels

earthkit.meteo.vertical.pressure_on_hybrid_levels(sp: ArrayLike, A: ArrayLike, B: ArrayLike, levels: ArrayLike | None = None, alpha_top: Literal['ifs', 'arpege'] = 'ifs', output: Literal['full', 'half', 'delta', 'alpha', 'level'] | list | tuple = 'full', vertical_dim: int = 0) → ArrayLike | tuple[ArrayLike, ...]
earthkit.meteo.vertical.pressure_on_hybrid_levels(sp: earthkit.data.FieldList, A: ArrayLike | None = None, B: ArrayLike | None = None, levels: ArrayLike | None = None, alpha_top: Literal['ifs', 'arpege'] = 'ifs', output: Literal['full', 'half', 'delta', 'alpha'] | list | tuple = 'full') → FieldList | tuple[FieldList, ...]

Compute pressure and related parameters on hybrid (IFS model) levels.

Parameters:

  • 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 (from the top of the atmosphere toward the surface). If the total number of (full) model levels is \(NLEV\), A must contain \(NLEV+1\) values, one for each half-level. See [IFS-CY49R1-Dynamics] Chapter 2, Section 2.2.1. for details. Can be None for FieldList/Field input if the coefficients can be resolved from the metadata of sp.

  • B (array-like | None) – 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 and ordering as A. See [IFS-CY49R1-Dynamics] Chapter 2, Section 2.2.1. for details. Can be None for FieldList/Field input if the coefficients can be resolved from metadata of sp.

  • levels (array-like | None, default None) – Specify the hybrid full-levels to return. Must be contiguous range of levels in either ascending or descending order. Following the IFS convention model level numbering starts at 1 at the top of the atmosphere and increasing toward the surface. If None (default), all the levels are returned in the order defined by the A and B coefficients (i.e. ascending order with respect to the model level number). If only half-levels are requested in output the levels are interpreted as half-level numbers (so 0 is a valid half-level number corresponding to the top of the atmosphere).

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

  • output (str | list | tuple, default "full") – Output data to return. See the concrete implementations for details.

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

Returns:

See the concrete implementations for details.

Return type:

array-like | tuple[array-like, ] | FieldList | tuple[FieldList, ]

See also

hybrid_level_parameters, relative_geopotential_thickness_on_hybrid_levels

Implementations

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