Skip to content
GitLab
Commit c7ee60e9 authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

added docu for reference of an unstructured grid

parent 2fe49bd0
Hide whitespace changes
Inline Side-by-side
doc/tex/FUNCTIONS
View file @ c7ee60e9
......@@ -102,6 +102,14 @@ Function catalog:
gridInqYlongname Get the longname of a Y-axis
gridDefYunits Define the units of a Y-axis
gridInqYunits Get the units of a Y-axis
gridDefNumber Define the reference number for an unstructured grid
gridInqNumber Get the reference number to an unstructured grid
gridDefPosition Define the position of grid in the reference file
gridInqPosition Get the position of grid in the reference file
gridDefReference Define the reference URI for an unstructured grid
gridInqReference Get the reference URI to an unstructured grid
gridDefUUID Define the UUID for an unstructured grid
gridInqUUID Get the UUID to an unstructured grid
-------------------------------------------------------------
zaxis
-------------------------------------------------------------
......
doc/tex/Modules
View file @ c7ee60e9
......@@ -94,6 +94,14 @@ gridDefYunits grid
gridInqYunits grid
gridDefLambert grid
gridInqLambert grid
gridDefNumber grid
gridInqNumber grid
gridDefPosition grid
gridInqPosition grid
gridDefReference grid
gridInqReference grid
gridDefUUID grid
gridInqUUID grid
zaxisCreate zaxis
zaxisDestroy zaxis
zaxisDuplicate zaxis
......
doc/tex/c_grid.tex
View file @ c7ee60e9
......@@ -836,3 +836,195 @@ Units of the Y-axis. The caller must allocate space for the
{\tt gridInqYunits} returns the units of the Y-axis to the parameter units.
\subsection{Define the reference number for an unstructured grid: {\tt gridDefNumber}}
\index{gridDefNumber}
\label{gridDefNumber}
The function {\tt gridDefNumber} defines the reference number for an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefNumber(int gridID, const int number);
\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 number}]
Reference number for an unstructured grid.
\end{deflist}
\end{minipage}
\subsection{Get the reference number to an unstructured grid: {\tt gridInqNumber}}
\index{gridInqNumber}
\label{gridInqNumber}
The function {\tt gridInqNumber} returns the reference number to an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqNumber(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 gridInqNumber} returns the reference number to an unstructured grid.
\subsection{Define the position of grid in the reference file: {\tt gridDefPosition}}
\index{gridDefPosition}
\label{gridDefPosition}
The function {\tt gridDefPosition} defines the position of grid in the reference file.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefPosition(int gridID, const int position);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt position\ }
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt position}]
Position of grid in the reference file.
\end{deflist}
\end{minipage}
\subsection{Get the position of grid in the reference file: {\tt gridInqPosition}}
\index{gridInqPosition}
\label{gridInqPosition}
The function {\tt gridInqPosition} returns the position of grid in the reference file.
\subsubsection*{Usage}
\begin{verbatim}
int gridInqPosition(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 gridInqPosition} returns the position of grid in the reference file.
\subsection{Define the reference URI for an unstructured grid: {\tt gridDefReference}}
\index{gridDefReference}
\label{gridDefReference}
The function {\tt gridDefReference} defines the reference URI for an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefReference(int gridID, const char *reference);
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt reference\ }
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt reference}]
Reference URI for an unstructured grid.
\end{deflist}
\end{minipage}
\subsection{Get the reference URI to an unstructured grid: {\tt gridInqReference}}
\index{gridInqReference}
\label{gridInqReference}
The function {\tt gridInqReference} returns the reference URI to an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
char *gridInqReference(int gridID, char *reference);
\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 gridInqReference} returns the reference URI to an unstructured grid.
\subsection{Define the UUID for an unstructured grid: {\tt gridDefUUID}}
\index{gridDefUUID}
\label{gridDefUUID}
The function {\tt gridDefUUID} defines the UUID for an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
void gridDefUUID(int gridID, const char *uuid);
\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 uuid}]
UUID for an unstructured grid.
\end{deflist}
\end{minipage}
\subsection{Get the UUID to an unstructured grid: {\tt gridInqUUID}}
\index{gridInqUUID}
\label{gridInqUUID}
The function {\tt gridInqUUID} returns the UUID to an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
char *gridInqUUID(int gridID, char *uuid);
\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 gridInqUUID} returns the UUID to an unstructured grid.
doc/tex/c_quick_ref.tex
View file @ c7ee60e9
......@@ -31,6 +31,15 @@ Create a horizontal Grid.
Define the number of parallels between a pole and the equator.
\section*{\tt \htmlref{gridDefNumber}{gridDefNumber}}
\begin{verbatim}
void gridDefNumber (int gridID, int number);
\end{verbatim}
Define the reference number for an unstructured grid.
\section*{\tt \htmlref{gridDefNvertex}{gridDefNvertex}}
\begin{verbatim}
......@@ -40,6 +49,15 @@ Define the number of parallels between a pole and the equator.
Define the number of vertex of a Gridbox.
\section*{\tt \htmlref{gridDefPosition}{gridDefPosition}}
\begin{verbatim}
void gridDefPosition (int gridID, int position);
\end{verbatim}
Define the position of grid in reference for an unstructured grid.
\section*{\tt \htmlref{gridDefPrec}{gridDefPrec}}
\begin{verbatim}
......@@ -49,6 +67,24 @@ Define the number of vertex of a Gridbox.
Define the precision of a Grid.
\section*{\tt \htmlref{gridDefReference}{gridDefReference}}
\begin{verbatim}
void gridDefReference (int gridID, const char *reference);
\end{verbatim}
Define the reference URI for an unstructured grid.
\section*{\tt \htmlref{gridDefUUID}{gridDefUUID}}
\begin{verbatim}
void gridDefUUID (int gridID, const char *uuid_cbuf);
\end{verbatim}
Define the UUID of an unstructured grid.
\section*{\tt \htmlref{gridDefXbounds}{gridDefXbounds}}
\begin{verbatim}
......@@ -184,6 +220,15 @@ Duplicate a Grid.
Get the number of parallels between a pole and the equator.
\section*{\tt \htmlref{gridInqNumber}{gridInqNumber}}
\begin{verbatim}
int gridInqNumber (int gridID);
\end{verbatim}
Get the reference number to an unstructured grid.
\section*{\tt \htmlref{gridInqNvertex}{gridInqNvertex}}
\begin{verbatim}
......@@ -193,6 +238,15 @@ Get the number of parallels between a pole and the equator.
Get the number of vertex of a Gridbox.
\section*{\tt \htmlref{gridInqPosition}{gridInqPosition}}
\begin{verbatim}
int gridInqPosition (int gridID);
\end{verbatim}
Get the position of grid in reference to an unstructured grid.
\section*{\tt \htmlref{gridInqPrec}{gridInqPrec}}
\begin{verbatim}
......@@ -202,6 +256,15 @@ Get the number of vertex of a Gridbox.
Get the precision of a Grid.
\section*{\tt \htmlref{gridInqReference}{gridInqReference}}
\begin{verbatim}
int gridInqReference (int gridID, char *reference);
\end{verbatim}
Get the reference URI to an unstructured grid.
\section*{\tt \htmlref{gridInqSize}{gridInqSize}}
\begin{verbatim}
......@@ -220,6 +283,15 @@ Get the size of a Grid.
Get the type of a Grid.
\section*{\tt \htmlref{gridInqUUID}{gridInqUUID}}
\begin{verbatim}
char * gridInqUUID (int gridID, char *uuid_cbuf);
\end{verbatim}
Get the UUID of an unstructured grid.
\section*{\tt \htmlref{gridInqXbounds}{gridInqXbounds}}
\begin{verbatim}
......@@ -1112,13 +1184,13 @@ Define the longname of a Z-axis.
Define the name of a Z-axis.
\section*{\tt \htmlref{zaxisDefReference}{zaxisDefReference}}
\section*{\tt \htmlref{zaxisDefNumber}{zaxisDefNumber}}
\begin{verbatim}
void zaxisDefReference (int zaxisID, int refID);
void zaxisDefNumber (int gridID, int number);
\end{verbatim}
Define the reference of a generalized Z-axis.
Define the reference number for a generalized Z-axis.
\section*{\tt \htmlref{zaxisDefUUID}{zaxisDefUUID}}
......@@ -1127,7 +1199,7 @@ Define the reference of a generalized Z-axis.
void zaxisDefUUID (int zaxisID, const char *uuid_cbuf);
\end{verbatim}
Define the uuid of a generalized Z-axis.
Define the UUID of a generalized Z-axis.
\section*{\tt \htmlref{zaxisDefUnits}{zaxisDefUnits}}
......@@ -1193,13 +1265,13 @@ Get the longname of a Z-axis.
Get the name of a Z-axis.
\section*{\tt \htmlref{zaxisInqReference}{zaxisInqReference}}
\section*{\tt \htmlref{zaxisInqNumber}{zaxisInqNumber}}
\begin{verbatim}
int zaxisInqReference (int zaxisID);
int zaxisInqNumber (int gridID);
\end{verbatim}
Get the reference of a generalized Z-axis.
Get the reference number to a generalized Z-axis.
\section*{\tt \htmlref{zaxisInqSize}{zaxisInqSize}}
......@@ -1235,7 +1307,7 @@ Get the type of a Z-axis.
char * zaxisInqUUID (int zaxisID, char *uuid_cbuf);
\end{verbatim}
Get the reference of a generalized Z-axis.
Get the UUID of a generalized Z-axis.
\section*{\tt \htmlref{zaxisInqUnits}{zaxisInqUnits}}
......
doc/tex/c_ref.tex
View file @ c7ee60e9
......@@ -30,6 +30,66 @@ Define the number of parallels between a pole and the equator
\ifpdfoutput{}{(\ref{gridDefNP})}
\section*{\tt
\ifpdf
\hyperref[gridDefNumber]{gridDefNumber}
\else
gridDefNumber
\fi
}
\begin{verbatim}
void gridDefNumber(int gridID, const int number);
\end{verbatim}
Define the reference number for an unstructured grid
\ifpdfoutput{}{(\ref{gridDefNumber})}
\section*{\tt
\ifpdf
\hyperref[gridDefPosition]{gridDefPosition}
\else
gridDefPosition
\fi
}
\begin{verbatim}
void gridDefPosition(int gridID, const int position);
\end{verbatim}
Define the position of grid in the reference file
\ifpdfoutput{}{(\ref{gridDefPosition})}
\section*{\tt
\ifpdf
\hyperref[gridDefReference]{gridDefReference}
\else
gridDefReference
\fi
}
\begin{verbatim}
void gridDefReference(int gridID, const char *reference);
\end{verbatim}
Define the reference URI for an unstructured grid
\ifpdfoutput{}{(\ref{gridDefReference})}
\section*{\tt
\ifpdf
\hyperref[gridDefUUID]{gridDefUUID}
\else
gridDefUUID
\fi
}
\begin{verbatim}
void gridDefUUID(int gridID, const char *uuid);
\end{verbatim}
Define the UUID for an unstructured grid
\ifpdfoutput{}{(\ref{gridDefUUID})}
\section*{\tt
\ifpdf
\hyperref[gridDefXbounds]{gridDefXbounds}
......@@ -255,6 +315,51 @@ Get the number of parallels between a pole and the equator
\ifpdfoutput{}{(\ref{gridInqNP})}
\section*{\tt
\ifpdf
\hyperref[gridInqNumber]{gridInqNumber}
\else
gridInqNumber
\fi
}
\begin{verbatim}
int gridInqNumber(int gridID);
\end{verbatim}
Get the reference number to an unstructured grid
\ifpdfoutput{}{(\ref{gridInqNumber})}
\section*{\tt
\ifpdf
\hyperref[gridInqPosition]{gridInqPosition}
\else
gridInqPosition
\fi
}
\begin{verbatim}
int gridInqPosition(int gridID);
\end{verbatim}
Get the position of grid in the reference file
\ifpdfoutput{}{(\ref{gridInqPosition})}
\section*{\tt
\ifpdf
\hyperref[gridInqReference]{gridInqReference}
\else
gridInqReference
\fi
}
\begin{verbatim}
char *gridInqReference(int gridID, char *reference);
\end{verbatim}
Get the reference URI to an unstructured grid
\ifpdfoutput{}{(\ref{gridInqReference})}
\section*{\tt
\ifpdf
\hyperref[gridInqSize]{gridInqSize}
......@@ -285,6 +390,21 @@ Get the type of a Grid
\ifpdfoutput{}{(\ref{gridInqType})}
\section*{\tt
\ifpdf
\hyperref[gridInqUUID]{gridInqUUID}
\else
gridInqUUID
\fi
}
\begin{verbatim}
char *gridInqUUID(int gridID, char *uuid);
\end{verbatim}
Get the UUID to an unstructured grid
\ifpdfoutput{}{(\ref{gridInqUUID})}
\section*{\tt
\ifpdf
\hyperref[gridInqXbounds]{gridInqXbounds}
......
doc/tex/f_grid.tex
View file @ c7ee60e9
......@@ -836,3 +836,195 @@ Units of the Y-axis. The caller must allocate space for the
{\tt gridInqYunits} returns the units of the Y-axis to the parameter units.
\subsection{Define the reference number for an unstructured grid: {\tt gridDefNumber}}
\index{gridDefNumber}
\label{gridDefNumber}
The function {\tt gridDefNumber} defines the reference number for an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefNumber(INTEGER gridID, INTEGER number)
\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 number}]
Reference number for an unstructured grid.
\end{deflist}
\end{minipage}
\subsection{Get the reference number to an unstructured grid: {\tt gridInqNumber}}
\index{gridInqNumber}
\label{gridInqNumber}
The function {\tt gridInqNumber} returns the reference number to an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
INTEGER FUNCTION gridInqNumber(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 gridInqNumber} returns the reference number to an unstructured grid.
\subsection{Define the position of grid in the reference file: {\tt gridDefPosition}}
\index{gridDefPosition}
\label{gridDefPosition}
The function {\tt gridDefPosition} defines the position of grid in the reference file.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefPosition(INTEGER gridID, INTEGER position)
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt position\ }
\item[{\tt gridID}]
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt position}]
Position of grid in the reference file.
\end{deflist}
\end{minipage}
\subsection{Get the position of grid in the reference file: {\tt gridInqPosition}}
\index{gridInqPosition}
\label{gridInqPosition}
The function {\tt gridInqPosition} returns the position of grid in the reference file.
\subsubsection*{Usage}
\begin{verbatim}
INTEGER FUNCTION gridInqPosition(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 gridInqPosition} returns the position of grid in the reference file.
\subsection{Define the reference URI for an unstructured grid: {\tt gridDefReference}}
\index{gridDefReference}
\label{gridDefReference}
The function {\tt gridDefReference} defines the reference URI for an unstructured grid.
\subsubsection*{Usage}
\begin{verbatim}
SUBROUTINE gridDefReference(INTEGER gridID, CHARACTER*(*) reference)