Commit 588fbff5 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update

parent 0bb6763d
......@@ -17,8 +17,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\item[{\tt gridtype}]
The type of the grid, one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
{\tt GRID\_LONLAT}, {\tt GRID\_LAMBERT}, {\tt GRID\_SPECTRAL},
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
\item[{\tt size}]
Number of gridpoints.
......@@ -124,8 +124,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
{\tt gridInqType} returns the type of the grid,
one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}
and {\tt GRID\_CELL}.
{\tt GRID\_LONLAT}, {\tt GRID\_LAMBERT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
......
......@@ -17,7 +17,7 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\item[{\tt zaxistype}]
The type of the Z-axis, one of the set of predefined {\CDI} Z-axis types.
The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
\item[{\tt size}]
Number of levels
......@@ -92,7 +92,7 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
{\tt zaxisInqType} returns the type of the Z-axis,
one of the set of predefined {\CDI} Z-axis types.
The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
......
......@@ -17,8 +17,8 @@ The function {\tt gridCreate} creates a horizontal Grid.
\item[{\tt gridtype}]
The type of the grid, one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
{\tt GRID\_LONLAT}, {\tt GRID\_LAMBERT}, {\tt GRID\_SPECTRAL},
{\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
\item[{\tt size}]
Number of gridpoints.
......@@ -124,8 +124,8 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
{\tt gridInqType} returns the type of the grid,
one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
{\tt GRID\_LONLAT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}
and {\tt GRID\_CELL}.
{\tt GRID\_LONLAT}, {\tt GRID\_LAMBERT}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
......
......@@ -17,7 +17,7 @@ The function {\tt zaxisCreate} creates a vertical Z-axis.
\item[{\tt zaxistype}]
The type of the Z-axis, one of the set of predefined {\CDI} Z-axis types.
The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
\item[{\tt size}]
Number of levels
......@@ -92,7 +92,7 @@ Z-axis ID, from a previous call to {\htmlref{\tt zaxisCreate}{zaxisCreate}}
{\tt zaxisInqType} returns the type of the Z-axis,
one of the set of predefined {\CDI} Z-axis types.
The valid {\CDI} Z-axis types are {\tt ZAXIS\_GENERIC}, {\tt ZAXIS\_SURFACE},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_HYBRID}, {\tt ZAXIS\_SIGMA}, {\tt ZAXIS\_PRESSURE}, {\tt ZAXIS\_HEIGHT},
{\tt ZAXIS\_DEPTH\_BELOW\_SEA} and {\tt ZAXIS\_DEPTH\_BELOW\_LAND}.
......
......@@ -43,6 +43,7 @@ data representation and level types are implemented: \\
100 & Isobaric level \\
103 & Altitude above mean sea level \\
105 & Height above ground \\
107 & Sigma level \\
109 & Hybrid level \\
110 & Layer between two hybrid levels \\
111 & Depth below land surface \\
......
......@@ -26,16 +26,16 @@ predefined constants:
\item[{\large\tt DATATYPE\_FLT64}] 64 bit floating point
\end{deflist}
\end{minipage}
\vspace*{3mm}
To define attributes, one of the following data types must be use:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
\begin{deflist}{{\large\tt DATATYPE\_TXT \ \ }}
\item[{\large\tt DATATYPE\_TXT}] Text
\item[{\large\tt DATATYPE\_INT}] Integer
\item[{\large\tt DATATYPE\_FLT}] Floating point
\end{deflist}
\end{minipage}
%\vspace*{3mm}
%
%To define attributes, one of the following data types must be use:
%
%\vspace*{3mm}
%\hspace*{8mm}\begin{minipage}{15cm}
%\begin{deflist}{{\large\tt DATATYPE\_TXT \ \ }}
%\item[{\large\tt DATATYPE\_TXT}] Text
%\item[{\large\tt DATATYPE\_INT}] Integer
%\item[{\large\tt DATATYPE\_FLT}] Floating point
%\end{deflist}
%\end{minipage}
......@@ -9,7 +9,8 @@ The following different Z-axis types are available:
\item[{\large\tt ZAXIS\_GENERIC }] Generic user defined level
\item[{\large\tt ZAXIS\_SURFACE }] Surface level
\item[{\large\tt ZAXIS\_HYBRID }] Hybrid level
\item[{\large\tt ZAXIS\_PRESSURE }] Isobaric pressure level in Pasal
\item[{\large\tt ZAXIS\_SIGMA }] Sigma level
\item[{\large\tt ZAXIS\_PRESSURE }] Isobaric pressure level in Pascal
\item[{\large\tt ZAXIS\_HEIGHT }] Height above ground in meters
\item[{\large\tt ZAXIS\_ALTITUDE }] Altitude above mean sea level in meters
\item[{\large\tt ZAXIS\_DEPTH\_BELOW\_SEA }] Depth below sea level in meters
......
......@@ -579,8 +579,8 @@ static void defineYvals(int gridID)
@Parameter
@Item gridtype The type of the grid, one of the set of predefined CDI grid types.
The valid CDI grid types are @func{GRID_GENERIC}, @func{GRID_GAUSSIAN},
@func{GRID_LONLAT}, @func{GRID_SPECTRAL}, @func{GRID_GME},
@func{GRID_CURVILINEAR} and @func{GRID_CELL}.
@func{GRID_LONLAT}, @func{GRID_LAMBERT}, @func{GRID_SPECTRAL},
@func{GRID_GME}, @func{GRID_CURVILINEAR} and @func{GRID_CELL}.
@Item size Number of gridpoints.
@Description
......@@ -1068,8 +1068,8 @@ The function @func{gridInqType} returns the type of a Grid.
@func{gridInqType} returns the type of the grid,
one of the set of predefined CDI grid types.
The valid CDI grid types are @func{GRID_GENERIC}, @func{GRID_GAUSSIAN},
@func{GRID_LONLAT}, @func{GRID_SPECTRAL}, @func{GRID_GME}, @func{GRID_CURVILINEAR}
and @func{GRID_CELL}.
@func{GRID_LONLAT}, @func{GRID_LAMBERT}, @func{GRID_SPECTRAL}, @func{GRID_GME},
@func{GRID_CURVILINEAR} and @func{GRID_CELL}.
@EndFunction
*/
......
......@@ -312,7 +312,7 @@ int zaxisSize(void)
@Parameter
@Item zaxistype The type of the Z-axis, one of the set of predefined CDI Z-axis types.
The valid CDI Z-axis types are @func{ZAXIS_GENERIC}, @func{ZAXIS_SURFACE},
@func{ZAXIS_HYBRID}, @func{ZAXIS_PRESSURE}, @func{ZAXIS_HEIGHT},
@func{ZAXIS_HYBRID}, @func{ZAXIS_SIGMA}, @func{ZAXIS_PRESSURE}, @func{ZAXIS_HEIGHT},
@func{ZAXIS_DEPTH_BELOW_SEA} and @func{ZAXIS_DEPTH_BELOW_LAND}.
@Item size Number of levels
......@@ -906,7 +906,7 @@ The function @func{zaxisInqType} returns the type of a Z-axis.
@func{zaxisInqType} returns the type of the Z-axis,
one of the set of predefined CDI Z-axis types.
The valid CDI Z-axis types are @func{ZAXIS_GENERIC}, @func{ZAXIS_SURFACE},
@func{ZAXIS_HYBRID}, @func{ZAXIS_PRESSURE}, @func{ZAXIS_HEIGHT},
@func{ZAXIS_HYBRID}, @func{ZAXIS_SIGMA}, @func{ZAXIS_PRESSURE}, @func{ZAXIS_HEIGHT},
@func{ZAXIS_DEPTH_BELOW_SEA} and @func{ZAXIS_DEPTH_BELOW_LAND}.
@EndFunction
......
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