earthkit.meteo.vertical.geopotential_from_geopotential_height¶
- earthkit.meteo.vertical.geopotential_from_geopotential_height(gh: ArrayLike) ArrayLike¶
- earthkit.meteo.vertical.geopotential_from_geopotential_height(gh: xarray.DataArray) xarray.DataArray
- earthkit.meteo.vertical.geopotential_from_geopotential_height(gh: earthkit.data.FieldList) earthkit.data.FieldList
Compute geopotential from geopotential height.
- Parameters:
gh (
array-like | xarray.DataArray | FieldList) – Geopotential height (m).- Returns:
Geopotential (m2/s2).
- Return type:
array-like | xarray.DataArray | FieldList
The computation is based on the following definition:
\[z = gh \cdot g\]where \(g\) is the gravitational acceleration on the surface of the Earth (see
earthkit.meteo.constants.g).Implementations¶
geopotential_from_geopotential_height()calls one of the following implementations depending on the type of the input arguments:earthkit.meteo.vertical.array.geopotential_from_geopotential_height()for array-likeearthkit.meteo.vertical.xarray.geopotential_from_geopotential_height()for xarray.DataArrayearthkit.meteo.vertical.fieldlist.geopotential_from_geopotential_height()for FieldList
The function returns an object of the same type as the input arguments.