Commit d7284b39 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Added docu for operator gheight.

parent 10430ae1
Pipeline #4914 passed with stages
in 16 minutes and 37 seconds
......@@ -3,6 +3,10 @@
* Using CDI library version 1.9.9
* Version 1.9.9 release
2020-10-28 Uwe Schulzweida
* New operator gheight: Geopotential height
2020-10-26 Uwe Schulzweida
* Ymonstat: added support for option timestat_date
......
......@@ -287,6 +287,7 @@ Version 1.7.0 (28 October 2015):
* setmisstonn: Set missing value to nearest neightbor
* setmisstodis: Set missing value to the distance-weighted average of the nearest neighbors
* ap2pl: Interpolate 3D variables on hybrid sigma height coordinates to pressure levels
* gheight: Geopotential height
* vertstd1: Vertical standard deviation [Divisor is (n-1)]
* vertvar1: Vertical variance [Divisor is (n-1)]
* seasvar1: Seasonal variance [Divisor is (n-1)]
......
......@@ -594,6 +594,7 @@ Operator catalog:
Rotuv rotuvb Backward rotation
Mastrfu mastrfu Mass stream function
Derivepar sealevelpressure Sea level pressure
Derivepar gheight Geopotential height
Adisit adisit Potential temperature to in-situ temperature
Adisit adipot In-situ temperature to potential temperature
Rhopot rhopot Calculates potential density
......
@BeginModule
@NewPage
@Name = Derivepar
@Title = Sea level pressure
@Title = Derived model parameters
@Section = Miscellaneous
@Arguments = infile outfile
@Operators = sealevelpressure
@Operators = sealevelpressure gheight
@BeginDescription
This module contains operators that calculate derived model parameters. These are currently the parameters
sea level pressure and geopotential height. All necessary input parameters are identified by their GRIB1
code number or the NetCDF CF standard name.
Supported GRIB1 parameter tables are: WMO standard table number 2 and ECMWF local table number 128.
@BeginTable
@bold{CF standard name} & @bold{Units} & @bold{GRIB 1 code}
surface_air_pressure & Pa & 134
air_temperature & K & 130
specific_humidity & kg/kg & 133
surface_geopotential & m2 s-2 & 129
geopotential_height & m & 156
@EndTable
@EndDescription
@EndModule
......@@ -15,3 +33,14 @@ This operator computes the sea level pressure (air_pressure_at_sea_level). Requi
are surface_air_pressure, surface_geopotential and air_temperature on hybrid sigma pressure levels.
@EndDescription
@EndOperator
@BeginOperator_gheight
@Title = Geopotential height
@BeginDescription
This operator computes the geopotential height (geopotential_height) on model levels in metres. Required input fields
are surface_air_pressure, surface_geopotential, specific_humidity and air_temperature on hybrid sigma pressure levels.
Note, this procedure is an approximation, which doesn't take into account the effects of e.g. cloud ice and water, rain and snow.
@EndDescription
@EndOperator
......@@ -198,6 +198,7 @@ Derivepar(void *process)
{
cdoPrint("Found:");
// clang-format off
if (-1 != humID) cdoPrint(" %s -> %s", var_stdname(specific_humidity), varList1[humID].name);
if (-1 != tempID) cdoPrint(" %s -> %s", var_stdname(air_temperature), varList1[tempID].name);
if (-1 != psID) cdoPrint(" %s -> %s", var_stdname(surface_air_pressure), varList1[psID].name);
if (-1 != lnpsID) cdoPrint(" LOG(%s) -> %s", var_stdname(surface_air_pressure), varList1[lnpsID].name);
......
......@@ -5356,14 +5356,33 @@ static const char *MastrfuHelp[] = {
static const char *DeriveparHelp[] = {
"NAME",
" sealevelpressure - Sea level pressure",
" sealevelpressure, gheight - Derived model parameters",
"",
"SYNOPSIS",
" sealevelpressure infile outfile",
" <operator> infile outfile",
"",
"DESCRIPTION",
" This operator computes the sea level pressure (air_pressure_at_sea_level). Required input fields",
" are surface_air_pressure, surface_geopotential and air_temperature on hybrid sigma pressure levels.",
" This module contains operators that calculate derived model parameters. These are currently the parameters",
" sea level pressure and geopotential height. All necessary input parameters are identified by their GRIB1",
" code number or the NetCDF CF standard name.",
" Supported GRIB1 parameter tables are: WMO standard table number 2 and ECMWF local table number 128.",
" ",
" CF standard name & Units & GRIB 1 code ",
" surface_air_pressure & Pa & 134",
" air_temperature & K & 130",
" specific_humidity & kg/kg & 133",
" surface_geopotential & m2 s-2 & 129",
" geopotential_height & m & 156",
" ",
"",
"OPERATORS",
" sealevelpressure Sea level pressure",
" This operator computes the sea level pressure (air_pressure_at_sea_level). Required input fields",
" are surface_air_pressure, surface_geopotential and air_temperature on hybrid sigma pressure levels.",
" gheight Geopotential height",
" This operator computes the geopotential height (geopotential_height) on model levels in metres. Required input fields",
" are surface_air_pressure, surface_geopotential, specific_humidity and air_temperature on hybrid sigma pressure levels.",
" Note, this procedure is an approximation, which doesn't take into account the effects of e.g. cloud ice and water, rain and snow.",
nullptr
};
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment