earthkit.meteo.vertical.geopotential_height_from_geometric_height

earthkit.meteo.vertical.geopotential_height_from_geometric_height(h: ArrayLike, R_earth: float = constants.R_earth) → ArrayLike
earthkit.meteo.vertical.geopotential_height_from_geometric_height(h: xarray.DataArray, R_earth: float = constants.R_earth) → xarray.DataArray
earthkit.meteo.vertical.geopotential_height_from_geometric_height(h: earthkit.data.FieldList, R_earth: float = constants.R_earth) → earthkit.data.FieldList

Compute the geopotential height from geometric height.

Parameters:

  • h (array-like | xarray.DataArray | FieldList) – Geometric height with respect to sea level (m).

  • R_earth (float, optional) – Average radius of the Earth (m). Default is earthkit.meteo.constants.R_earth.

Returns:

Geopotential height (m).

Return type:

array-like | xarray.DataArray | FieldList

The computation is based on the following formula:

\[gh = \frac{h \cdot R_{earth}}{R_{earth} + h}\]

where \(R_{earth}\) is the average radius of the Earth (see earthkit.meteo.constants.R_earth).

Implementations

geopotential_height_from_geometric_height() 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.