Commit a1fc8f40 by Uwe Schulzweida

### docu update

parent f575d4df
 ... ... @@ -78,6 +78,8 @@ Function catalog: gridInqXsize Get the number of values of a X-axis gridDefYsize Define the number of values of a Y-axis gridInqYsize Get the number of values of a Y-axis gridDefNP Define the number of parallels between a pole and the equator gridInqNP Get the number of parallels between a pole and the equator gridDefXvals Define the values of a X-axis gridInqXvals Get all values of a X-axis gridDefYvals Define the values of a Y-axis ... ...
 ... ... @@ -66,6 +66,8 @@ gridDefXsize grid gridInqXsize grid gridDefYsize grid gridInqYsize grid gridDefNP grid gridInqNP grid gridDefXvals grid gridInqXvals grid gridDefYvals grid ... ...
 ... ... @@ -19,7 +19,7 @@ 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\_LCC}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}, {\tt GRID\_UNSTRUCTURED} and {\tt GRID\_REFERENCE} {\tt GRID\_REFERENCE}. \item[{\tt size}] Number of gridpoints. ... ... @@ -145,7 +145,7 @@ The function {\tt gridInqSize} returns the size of a Grid. \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}} Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \end{deflist} \end{minipage} ... ... @@ -188,7 +188,7 @@ The function {\tt gridInqXsize} returns the number of values of a X-axis. \subsubsection*{Usage} \begin{verbatim} void gridInqXsize(int gridID); int gridInqXsize(int gridID); \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} ... ... @@ -237,7 +237,7 @@ The function {\tt gridInqYsize} returns the number of values of a Y-axis. \subsubsection*{Usage} \begin{verbatim} void gridInqYsize(int gridID); int gridInqYsize(int gridID); \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} ... ... @@ -254,6 +254,57 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \subsection{Define the number of parallels between a pole and the equator: {\tt gridDefNP}} \index{gridDefNP} \label{gridDefNP} The function {\tt gridDefNP} defines the number of parallels between a pole and the equator of a Gaussian grid. \subsubsection*{Usage} \begin{verbatim} void gridDefNP(int gridID, int np); \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \item[{\tt np}] Number of parallels between a pole and the equator. \end{deflist} \end{minipage} \subsection{Get the number of parallels between a pole and the equator: {\tt gridInqNP}} \index{gridInqNP} \label{gridInqNP} The function {\tt gridInqNP} returns the number of parallels between a pole and the equator of a Gaussian grid. \subsubsection*{Usage} \begin{verbatim} int gridInqNP(int gridID); \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \end{deflist} \end{minipage} \subsubsection*{Result} {\tt gridInqNP} returns the number of parallels between a pole and the equator. \subsection{Define the values of a X-axis: {\tt gridDefXvals}} \index{gridDefXvals} \label{gridDefXvals} ... ...
 ... ... @@ -15,6 +15,21 @@ Create a horizontal Grid \ifpdfoutput{}{(\ref{gridCreate})} \section*{\tt \ifpdf \hyperref[gridDefNP]{gridDefNP} \else gridDefNP \fi } \begin{verbatim} void gridDefNP(int gridID, int np); \end{verbatim} Define the number of parallels between a pole and the equator \ifpdfoutput{}{(\ref{gridDefNP})} \section*{\tt \ifpdf \hyperref[gridDefXbounds]{gridDefXbounds} ... ... @@ -225,6 +240,21 @@ Duplicate a horizontal Grid \ifpdfoutput{}{(\ref{gridDuplicate})} \section*{\tt \ifpdf \hyperref[gridInqNP]{gridInqNP} \else gridInqNP \fi } \begin{verbatim} int gridInqNP(int gridID); \end{verbatim} Get the number of parallels between a pole and the equator \ifpdfoutput{}{(\ref{gridInqNP})} \section*{\tt \ifpdf \hyperref[gridInqSize]{gridInqSize} ... ... @@ -308,7 +338,7 @@ gridInqXsize \fi } \begin{verbatim} void gridInqXsize(int gridID); int gridInqXsize(int gridID); \end{verbatim} Get the number of values of a X-axis ... ... @@ -398,7 +428,7 @@ gridInqYsize \fi } \begin{verbatim} void gridInqYsize(int gridID); int gridInqYsize(int gridID); \end{verbatim} Get the number of values of a Y-axis ... ...
 ... ... @@ -19,7 +19,7 @@ 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\_LCC}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR}, {\tt GRID\_UNSTRUCTURED} and {\tt GRID\_REFERENCE} {\tt GRID\_REFERENCE}. \item[{\tt size}] Number of gridpoints. ... ... @@ -145,7 +145,7 @@ The function {\tt gridInqSize} returns the size of a Grid. \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}} Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \end{deflist} \end{minipage} ... ... @@ -188,7 +188,7 @@ The function {\tt gridInqXsize} returns the number of values of a X-axis. \subsubsection*{Usage} \begin{verbatim} SUBROUTINE gridInqXsize(INTEGER gridID) INTEGER FUNCTION gridInqXsize(INTEGER gridID) \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} ... ... @@ -237,7 +237,7 @@ The function {\tt gridInqYsize} returns the number of values of a Y-axis. \subsubsection*{Usage} \begin{verbatim} SUBROUTINE gridInqYsize(INTEGER gridID) INTEGER FUNCTION gridInqYsize(INTEGER gridID) \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} ... ... @@ -254,6 +254,57 @@ Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \subsection{Define the number of parallels between a pole and the equator: {\tt gridDefNP}} \index{gridDefNP} \label{gridDefNP} The function {\tt gridDefNP} defines the number of parallels between a pole and the equator of a Gaussian grid. \subsubsection*{Usage} \begin{verbatim} SUBROUTINE gridDefNP(INTEGER gridID, INTEGER np) \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \item[{\tt np}] Number of parallels between a pole and the equator. \end{deflist} \end{minipage} \subsection{Get the number of parallels between a pole and the equator: {\tt gridInqNP}} \index{gridInqNP} \label{gridInqNP} The function {\tt gridInqNP} returns the number of parallels between a pole and the equator of a Gaussian grid. \subsubsection*{Usage} \begin{verbatim} INTEGER FUNCTION gridInqNP(INTEGER gridID) \end{verbatim} \hspace*{4mm}\begin{minipage}[]{15cm} \begin{deflist}{\tt gridID\ } \item[{\tt gridID}] Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}. \end{deflist} \end{minipage} \subsubsection*{Result} {\tt gridInqNP} returns the number of parallels between a pole and the equator. \subsection{Define the values of a X-axis: {\tt gridDefXvals}} \index{gridDefXvals} \label{gridDefXvals} ... ...
 ... ... @@ -15,6 +15,21 @@ Create a horizontal Grid \ifpdfoutput{}{(\ref{gridCreate})} \section*{\tt \ifpdf \hyperref[gridDefNP]{gridDefNP} \else gridDefNP \fi } \begin{verbatim} SUBROUTINE gridDefNP(INTEGER gridID, INTEGER np) \end{verbatim} Define the number of parallels between a pole and the equator \ifpdfoutput{}{(\ref{gridDefNP})} \section*{\tt \ifpdf \hyperref[gridDefXbounds]{gridDefXbounds} ... ... @@ -225,6 +240,21 @@ Duplicate a horizontal Grid \ifpdfoutput{}{(\ref{gridDuplicate})} \section*{\tt \ifpdf \hyperref[gridInqNP]{gridInqNP} \else gridInqNP \fi } \begin{verbatim} INTEGER FUNCTION gridInqNP(INTEGER gridID) \end{verbatim} Get the number of parallels between a pole and the equator \ifpdfoutput{}{(\ref{gridInqNP})} \section*{\tt \ifpdf \hyperref[gridInqSize]{gridInqSize} ... ... @@ -308,7 +338,7 @@ gridInqXsize \fi } \begin{verbatim} SUBROUTINE gridInqXsize(INTEGER gridID) INTEGER FUNCTION gridInqXsize(INTEGER gridID) \end{verbatim} Get the number of values of a X-axis ... ... @@ -398,7 +428,7 @@ gridInqYsize \fi } \begin{verbatim} SUBROUTINE gridInqYsize(INTEGER gridID) INTEGER FUNCTION gridInqYsize(INTEGER gridID) \end{verbatim} Get the number of values of a Y-axis ... ...
 ... ... @@ -508,7 +508,7 @@ void gridGenYvals(int gridtype, int ysize, double yfirst, double ylast, double y The valid CDI grid types are @func{GRID_GENERIC}, @func{GRID_GAUSSIAN}, @func{GRID_LONLAT}, @func{GRID_LCC}, @func{GRID_SPECTRAL}, @func{GRID_GME}, @func{GRID_CURVILINEAR}, @func{GRID_UNSTRUCTURED} and @func{GRID_REFERENCE} @func{GRID_REFERENCE}. @Item size Number of gridpoints. @Description ... ... @@ -1100,7 +1100,7 @@ int gridInqType(int gridID) @Prototype int gridInqSize(int gridID) @Parameter @Item gridID Grid ID, from a previous call to @fref{gridCreate} @Item gridID Grid ID, from a previous call to @fref{gridCreate}. @Description The function @func{gridInqSize} returns the size of a Grid. ... ... @@ -1275,7 +1275,7 @@ int gridInqPrec(int gridID) @Function gridInqXsize @Title Get the number of values of a X-axis @Prototype void gridInqXsize(int gridID) @Prototype int gridInqXsize(int gridID) @Parameter @Item gridID Grid ID, from a previous call to @fref{gridCreate}. ... ... @@ -1338,7 +1338,7 @@ void gridDefYsize(int gridID, int ysize) @Function gridInqYsize @Title Get the number of values of a Y-axis @Prototype void gridInqYsize(int gridID) @Prototype int gridInqYsize(int gridID) @Parameter @Item gridID Grid ID, from a previous call to @fref{gridCreate}. ... ... @@ -1368,10 +1368,11 @@ int gridInqYsize(int gridID) @Prototype void gridDefNP(int gridID, int np) @Parameter @Item gridID Grid ID, from a previous call to @fref{gridCreate}. @Item np Number of parallels between a pole and the equator @Item np Number of parallels between a pole and the equator. @Description The function @func{gridDefNP} defines the number of parallels between a pole and the equator. The function @func{gridDefNP} defines the number of parallels between a pole and the equator of a Gaussian grid. @EndFunction */ ... ... @@ -1390,7 +1391,7 @@ void gridDefNP(int gridID, int np) @Function gridInqNP @Title Get the number of parallels between a pole and the equator @Prototype void gridInqNP(int gridID) @Prototype int gridInqNP(int gridID) @Parameter @Item gridID Grid ID, from a previous call to @fref{gridCreate}. ... ... @@ -1414,7 +1415,6 @@ int gridInqNP(int gridID) return (gridptr->np); } /* @Function @Title ... ...
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!