commit e133ea093858ab9096e82ceefcf61ecb372e9559
parent 79054702ca9982fd2ab718a2f917e4726df8c1cf
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Wed, 14 Nov 2018 09:56:19 +0100
Update of the htcp man page
Diffstat:
1 file changed, 6 insertions(+), 4 deletions(-)
diff --git a/doc/htcp.5.txt b/doc/htcp.5.txt
@@ -27,14 +27,16 @@ DESCRIPTION
*htcp* is a binary file format that describes properties on liquid water
content in suspension within clouds. The *les2htcp*(1) command can be used to
generate a *htcp* file from cloud properties resulting of a Large Eddy
-Simulation and saved in a Meso-NH like NetCDF file format [1].
+Simulation and saved in a "Meso-NH like" NetCDF file format [1].
The cloud properties are actually spatio temporal double precision floating
point data, structured in a 4D grid whose definition and spatial origin is
given by the _<definition>_ and the _<lower-pos>_ fields. The size of a grid
cell along the X and Y dimension is constant while the size along the Z axis
can be irregular. Is such case, the _<is-Z-irregular>_ header flag is set to 1
-and the cell sizes of each cell in Z are explicitly listed in _<voxel-size>_.
+and the sizes of the cells in Z are explicitly listed in _<voxel-size>_. Note
+that in *htcp*, the spatial dimensions are defined in meters, i.e. values
+listed in _<lower-pos>_ and _<voxel-size>_ are meters.
For a given property, the list of its spatio temporal data are linearly listed
along the X, Y, Z and time dimension, in that order. The address where its
@@ -48,7 +50,7 @@ Available cloud properties are:
* _<RCT>_: liquid water in suspension mixing ratio in kg of water per m^3 of
dry air.
* _<PABST>_: pressure in Pascal.
-* _<T>_: potential temperature in Kelvin.
+* _<T>_: temperature in Kelvin.
BINARY FILE FORMAT
------------------
@@ -90,7 +92,7 @@ significant bytes are stored first.
<RVT> ::= DOUBLE [ DOUBLE ... ] # Water vapor mixing ratio
<RCT> ::= DOUBLE [ DOUBLE ... ] # Liquid water in suspension mixing ratio
<PABST> ::= DOUBLE [ DOUBLE ... ] # Pressure
-<T> ::= DOUBLE [ DOUBLE ... ] # Potential temperature
+<T> ::= DOUBLE [ DOUBLE ... ] # Temperature
<padding> ::= [ BYTE ... ]
-------
