f_grid.tex 17.8 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2


Uwe Schulzweida's avatar
Uwe Schulzweida committed
3
\subsection{Create a horizontal Grid: {\tt gridCreate}}
4
5
\index{gridCreate}
\label{gridCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
6

7
The function {\tt gridCreate} creates a horizontal Grid.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
8

Uwe Schulzweida's avatar
Uwe Schulzweida committed
9
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
10
11

\begin{verbatim}
12
    INTEGER FUNCTION gridCreate(INTEGER gridtype, INTEGER size)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
15
16
17
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridtype\ }
\item[{\tt gridtype}]
Uwe Schulzweida's avatar
Uwe Schulzweida committed
18
19
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},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
20
                     {\tt GRID\_LONLAT}, {\tt GRID\_LCC}, {\tt GRID\_SPECTRAL},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
21
                     {\tt GRID\_GME}, {\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
22
23
24
25
26
27
\item[{\tt size}]
Number of gridpoints.

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
28
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
29

30
{\tt gridCreate} returns an identifier to the Grid.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
31
32


Uwe Schulzweida's avatar
Uwe Schulzweida committed
33
\subsubsection*{Example}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
34

Uwe Schulzweida's avatar
Uwe Schulzweida committed
35
Here is an example using {\tt gridCreate} to create a regular lon/lat Grid:
36

Uwe Schulzweida's avatar
Uwe Schulzweida committed
37
38
\begin{lstlisting}[language=Fortran, backgroundcolor=\color{zebg}, basicstyle=\footnotesize]

Uwe Schulzweida's avatar
Uwe Schulzweida committed
39
40
    INCLUDE 'cdi.h'
       ...
Uwe Schulzweida's avatar
Uwe Schulzweida committed
41
42
43
44
45
    #define  NLON  12
    #define  NLAT   6
       ...
    REAL*8 lons(NLON) = (/0, 30, 60, 90, 120, 150, 180, 210, 240, 270, 300, 330/)
    REAL*8 lats(NLAT) = (/-75, -45, -15, 15, 45, 75/)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
46
47
    INTEGER gridID
       ...
Uwe Schulzweida's avatar
Uwe Schulzweida committed
48
49
50
    gridID = gridCreate(GRID_LONLAT, NLON*NLAT)
    CALL gridDefXsize(gridID, NLON)
    CALL gridDefYsize(gridID, NLAT)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
51
52
53
    CALL gridDefXvals(gridID, lons)
    CALL gridDefYvals(gridID, lats)
       ...
54
55
56
\end{lstlisting}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
57
\subsection{Destroy a horizontal Grid: {\tt gridDestroy}}
58
59
\index{gridDestroy}
\label{gridDestroy}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
60
\subsubsection*{Usage}
61
62
63

\begin{verbatim}
    SUBROUTINE gridDestroy(INTEGER gridID)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
64
65
\end{verbatim}

66
67
68
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
69
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
70
71
72
73

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
74

Uwe Schulzweida's avatar
Uwe Schulzweida committed
75
\subsection{Duplicate a horizontal Grid: {\tt gridDuplicate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
76
77
78
\index{gridDuplicate}
\label{gridDuplicate}

79
The function {\tt gridDuplicate} duplicates a horizontal Grid.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
80

Uwe Schulzweida's avatar
Uwe Schulzweida committed
81
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
82
83
84
85
86
87
88
89

\begin{verbatim}
    INTEGER FUNCTION gridDuplicate(INTEGER gridID)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
90
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
91
                    {\htmlref{\tt gridDuplicate}{gridDuplicate}} or {\htmlref{\tt vlistInqVarGrid}{vlistInqVarGrid}}.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
92
93
94
95

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
96
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
97

98
{\tt gridDuplicate} returns an identifier to the duplicated Grid.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
99
100
101



Uwe Schulzweida's avatar
Uwe Schulzweida committed
102
\subsection{Get the type of a Grid: {\tt gridInqType}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
103
104
105
106
107
\index{gridInqType}
\label{gridInqType}

The function {\tt gridInqType} returns the type of a Grid.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
108
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
109
110
111
112
113
114
115
116

\begin{verbatim}
    INTEGER FUNCTION gridInqType(INTEGER gridID)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
117
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
118
119
120
121

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
122
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
123
124

{\tt gridInqType} returns the type of the grid,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
125
126
one of the set of predefined {\CDI} grid types.
The valid {\CDI} grid types are {\tt GRID\_GENERIC}, {\tt GRID\_GAUSSIAN},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
127
{\tt GRID\_LONLAT}, {\tt GRID\_LCC}, {\tt GRID\_SPECTRAL}, {\tt GRID\_GME},
Uwe Schulzweida's avatar
Uwe Schulzweida committed
128
{\tt GRID\_CURVILINEAR} and {\tt GRID\_CELL}.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
129
130
131



Uwe Schulzweida's avatar
Uwe Schulzweida committed
132
\subsection{Get the size of a Grid: {\tt gridInqSize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
133
134
135
136
137
\index{gridInqSize}
\label{gridInqSize}

The function {\tt gridInqSize} returns the size of a Grid.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
138
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
139
140
141
142
143
144
145
146

\begin{verbatim}
    INTEGER FUNCTION gridInqSize(INTEGER gridID)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
147
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
148
149
150
151

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
152
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
153
154
155
156
157

{\tt gridInqSize} returns the number of grid points of a Grid.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
158
\subsection{Define the number of values of a X-axis: {\tt gridDefXsize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
159
160
161
162
163
\index{gridDefXsize}
\label{gridDefXsize}

The function {\tt gridDefXsize} defines the number of values of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
164
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
165
166
167
168
169
170
171
172

\begin{verbatim}
    SUBROUTINE gridDefXsize(INTEGER gridID, INTEGER xsize)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
173
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
174
175
176
177
178
179
180
\item[{\tt xsize}]
Number of values of a X-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
181
\subsection{Get the number of values of a X-axis: {\tt gridInqXsize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
182
183
184
185
186
\index{gridInqXsize}
\label{gridInqXsize}

The function {\tt gridInqXsize} returns the number of values of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
187
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
188
189
190
191
192
193
194
195

\begin{verbatim}
    SUBROUTINE gridInqXsize(INTEGER gridID)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
196
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
197
198
199
200

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
201
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
202
203
204
205
206

{\tt gridInqXsize} returns the number of values of a X-axis.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
207
\subsection{Define the number of values of a Y-axis: {\tt gridDefYsize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
208
209
210
211
212
\index{gridDefYsize}
\label{gridDefYsize}

The function {\tt gridDefYsize} defines the number of values of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
213
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
214
215
216
217
218
219
220
221

\begin{verbatim}
    SUBROUTINE gridDefYsize(INTEGER gridID, INTEGER ysize)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
222
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
223
224
225
226
227
228
229
\item[{\tt ysize}]
Number of values of a Y-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
230
\subsection{Get the number of values of a Y-axis: {\tt gridInqYsize}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
231
232
233
234
235
\index{gridInqYsize}
\label{gridInqYsize}

The function {\tt gridInqYsize} returns the number of values of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
236
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
237
238
239
240
241
242
243
244

\begin{verbatim}
    SUBROUTINE gridInqYsize(INTEGER gridID)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
245
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
246
247
248
249

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
250
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
251
252
253
254
255

{\tt gridInqYsize} returns the number of values of a Y-axis.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
256
\subsection{Define the values of a X-axis: {\tt gridDefXvals}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
257
258
259
260
261
\index{gridDefXvals}
\label{gridDefXvals}

The function {\tt gridDefXvals} defines all values of the X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
262
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
263
264

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
265
    SUBROUTINE gridDefXvals(INTEGER gridID, const REAL*8 xvals)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
266
267
268
269
270
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
271
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
272
273
274
275
276
277
278
\item[{\tt xvals}]
X-values of the grid

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
279
\subsection{Get all values of a X-axis: {\tt gridInqXvals}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
280
281
282
283
284
\index{gridInqXvals}
\label{gridInqXvals}

The function {\tt gridInqXvals} returns all values of the X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
285
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
286
287
288
289
290
291
292
293

\begin{verbatim}
    INTEGER FUNCTION gridInqXvals(INTEGER gridID, REAL*8 xvals)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
294
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
295
296
297
298
299
300
\item[{\tt xvals}]
X-values of the grid

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
301
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
302
303
304
305
306
307
308

Upon successful completion {\tt gridInqXvals} returns the number of values and
the values are stored in {\tt xvals}.
Otherwise, 0 is returned and {\tt xvals} is empty.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
309
\subsection{Define the values of a Y-axis: {\tt gridDefYvals}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
310
311
312
313
314
\index{gridDefYvals}
\label{gridDefYvals}

The function {\tt gridDefYvals} defines all values of the Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
315
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
316
317

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
318
    SUBROUTINE gridDefYvals(INTEGER gridID, const REAL*8 yvals)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
319
320
321
322
323
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
324
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
325
326
327
328
329
330
331
\item[{\tt yvals}]
Y-values of the grid

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
332
\subsection{Get all values of a Y-axis: {\tt gridInqYvals}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
333
334
335
336
337
\index{gridInqYvals}
\label{gridInqYvals}

The function {\tt gridInqYvals} returns all values of the Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
338
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
339
340
341
342
343
344
345
346

\begin{verbatim}
    INTEGER FUNCTION gridInqYvals(INTEGER gridID, REAL*8 yvals)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
347
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
348
349
350
351
352
353
\item[{\tt yvals}]
Y-values of the grid

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
354
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
355
356
357
358
359
360
361

Upon successful completion {\tt gridInqYvals} returns the number of values and
the values are stored in {\tt yvals}.
Otherwise, 0 is returned and {\tt yvals} is empty.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
362
\subsection{Define the bounds of a X-axis: {\tt gridDefXbounds}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
363
364
365
366
367
\index{gridDefXbounds}
\label{gridDefXbounds}

The function {\tt gridDefXbounds} defines all bounds of the X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
368
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
369
370

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
371
    SUBROUTINE gridDefXbounds(INTEGER gridID, const REAL*8 xbounds)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
372
373
374
375
376
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt xbounds\ }
\item[{\tt gridID}]
377
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
378
379
380
381
382
383
384
\item[{\tt xbounds}]
X-bounds of the grid

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
385
\subsection{Get the bounds of a X-axis: {\tt gridInqXbounds}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
386
387
388
389
390
\index{gridInqXbounds}
\label{gridInqXbounds}

The function {\tt gridInqXbounds} returns the bounds of the X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
391
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
392
393
394
395
396
397
398
399

\begin{verbatim}
    INTEGER FUNCTION gridInqXbounds(INTEGER gridID, REAL*8 xbounds)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt xbounds\ }
\item[{\tt gridID}]
400
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
401
402
403
404
405
406
\item[{\tt xbounds}]
X-bounds of the grid

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
407
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
408
409
410
411
412
413
414

Upon successful completion {\tt gridInqXbounds} returns the number of bounds and
the bounds are stored in {\tt xbounds}.
Otherwise, 0 is returned and {\tt xbounds} is empty.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
415
\subsection{Define the bounds of a Y-axis: {\tt gridDefYbounds}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
416
417
418
419
420
\index{gridDefYbounds}
\label{gridDefYbounds}

The function {\tt gridDefYbounds} defines all bounds of the Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
421
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
422
423

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
424
    SUBROUTINE gridDefYbounds(INTEGER gridID, const REAL*8 ybounds)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
425
426
427
428
429
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt ybounds\ }
\item[{\tt gridID}]
430
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
431
432
433
434
435
436
437
\item[{\tt ybounds}]
Y-bounds of the grid

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
438
\subsection{Get the bounds of a Y-axis: {\tt gridInqYbounds}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
439
440
441
442
443
\index{gridInqYbounds}
\label{gridInqYbounds}

The function {\tt gridInqYbounds} returns the bounds of the Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
444
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
445
446
447
448
449
450
451
452

\begin{verbatim}
    INTEGER FUNCTION gridInqYbounds(INTEGER gridID, REAL*8 ybounds)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt ybounds\ }
\item[{\tt gridID}]
453
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
454
455
456
457
458
459
\item[{\tt ybounds}]
Y-bounds of the grid

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
460
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
461
462
463
464
465
466
467

Upon successful completion {\tt gridInqYbounds} returns the number of bounds and
the bounds are stored in {\tt ybounds}.
Otherwise, 0 is returned and {\tt ybounds} is empty.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
468
\subsection{Define the name of a X-axis: {\tt gridDefXname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
469
470
471
472
473
\index{gridDefXname}
\label{gridDefXname}

The function {\tt gridDefXname} defines the name of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
474
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
475
476
477
478
479
480
481
482

\begin{verbatim}
    SUBROUTINE gridDefXname(INTEGER gridID, CHARACTER*(*) name)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
483
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
484
485
486
487
488
489
490
\item[{\tt name}]
Name of the X-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
491
\subsection{Get the name of a X-axis: {\tt gridInqXname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
492
493
494
495
496
\index{gridInqXname}
\label{gridInqXname}

The function {\tt gridInqXname} returns the name of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
497
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
498
499
500
501
502
503
504
505

\begin{verbatim}
    SUBROUTINE gridInqXname(INTEGER gridID, CHARACTER*(*) name)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
506
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
507
508
509
510
511
512
\item[{\tt name}]
Name of the X-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
513
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
514
515
516
517
518

{\tt gridInqXname} returns the name of the X-axis to the parameter name.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
519
\subsection{Define the longname of a X-axis: {\tt gridDefXlongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
520
521
522
523
524
\index{gridDefXlongname}
\label{gridDefXlongname}

The function {\tt gridDefXlongname} defines the longname of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
525
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
526
527
528
529
530
531
532
533

\begin{verbatim}
    SUBROUTINE gridDefXlongname(INTEGER gridID, CHARACTER*(*) longname)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt gridID}]
534
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
535
536
537
538
539
540
541
\item[{\tt longname}]
Longname of the X-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
542
\subsection{Get the longname of a X-axis: {\tt gridInqXlongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
543
544
545
546
547
\index{gridInqXlongname}
\label{gridInqXlongname}

The function {\tt gridInqXlongname} returns the longname of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
548
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
549
550
551
552
553
554
555
556

\begin{verbatim}
    SUBROUTINE gridInqXlongname(INTEGER gridID, CHARACTER*(*) longname)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt gridID}]
557
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
558
559
560
561
562
563
\item[{\tt longname}]
Longname of the X-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
564
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
565
566
567
568
569

{\tt gridInqXlongname} returns the longname of the X-axis to the parameter longname.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
570
\subsection{Define the units of a X-axis: {\tt gridDefXunits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
571
572
573
574
575
\index{gridDefXunits}
\label{gridDefXunits}

The function {\tt gridDefXunits} defines the units of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
576
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
577
578
579
580
581
582
583
584

\begin{verbatim}
    SUBROUTINE gridDefXunits(INTEGER gridID, CHARACTER*(*) units)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
585
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
586
587
588
589
590
591
592
\item[{\tt units}]
Units of the X-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
593
\subsection{Get the units of a X-axis: {\tt gridInqXunits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
594
595
596
597
598
\index{gridInqXunits}
\label{gridInqXunits}

The function {\tt gridInqXunits} returns the units of a X-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
599
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
600
601
602
603
604
605
606
607

\begin{verbatim}
    SUBROUTINE gridInqXunits(INTEGER gridID, CHARACTER*(*) units)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
608
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
609
610
611
612
613
614
\item[{\tt units}]
Units of the X-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
615
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
616
617
618
619
620

{\tt gridInqXunits} returns the units of the X-axis to the parameter units.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
621
\subsection{Define the name of a Y-axis: {\tt gridDefYname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
622
623
624
625
626
\index{gridDefYname}
\label{gridDefYname}

The function {\tt gridDefYname} defines the name of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
627
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
628
629
630
631
632
633
634
635

\begin{verbatim}
    SUBROUTINE gridDefYname(INTEGER gridID, CHARACTER*(*) name)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
636
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
637
638
639
640
641
642
643
\item[{\tt name}]
Name of the Y-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
644
\subsection{Get the name of a Y-axis: {\tt gridInqYname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
645
646
647
648
649
\index{gridInqYname}
\label{gridInqYname}

The function {\tt gridInqYname} returns the name of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
650
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
651
652
653
654
655
656
657
658

\begin{verbatim}
    SUBROUTINE gridInqYname(INTEGER gridID, CHARACTER*(*) name)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
659
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
660
661
662
663
664
665
\item[{\tt name}]
Name of the Y-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
666
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
667
668
669
670
671

{\tt gridInqYname} returns the name of the Y-axis to the parameter name.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
672
\subsection{Define the longname of a Y-axis: {\tt gridDefYlongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
673
674
675
676
677
\index{gridDefYlongname}
\label{gridDefYlongname}

The function {\tt gridDefYlongname} defines the longname of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
678
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
679
680
681
682
683
684
685
686

\begin{verbatim}
    SUBROUTINE gridDefYlongname(INTEGER gridID, CHARACTER*(*) longname)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt gridID}]
687
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
688
689
690
691
692
693
694
\item[{\tt longname}]
Longname of the Y-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
695
\subsection{Get the longname of a Y-axis: {\tt gridInqYlongname}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
696
697
698
699
700
\index{gridInqYlongname}
\label{gridInqYlongname}

The function {\tt gridInqYlongname} returns the longname of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
701
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
702
703
704
705
706
707
708
709

\begin{verbatim}
    SUBROUTINE gridInqXlongname(INTEGER gridID, CHARACTER*(*) longname)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt longname\ }
\item[{\tt gridID}]
710
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
711
712
713
714
715
716
\item[{\tt longname}]
Longname of the Y-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
717
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
718
719
720
721
722

{\tt gridInqYlongname} returns the longname of the Y-axis to the parameter longname.



Uwe Schulzweida's avatar
Uwe Schulzweida committed
723
\subsection{Define the units of a Y-axis: {\tt gridDefYunits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
724
725
726
727
728
\index{gridDefYunits}
\label{gridDefYunits}

The function {\tt gridDefYunits} defines the units of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
729
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
730
731
732
733
734
735
736
737

\begin{verbatim}
    SUBROUTINE gridDefYunits(INTEGER gridID, CHARACTER*(*) units)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
738
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
739
740
741
742
743
744
745
\item[{\tt units}]
Units of the Y-axis

\end{deflist}
\end{minipage}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
746
\subsection{Get the units of a Y-axis: {\tt gridInqYunits}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
747
748
749
750
751
\index{gridInqYunits}
\label{gridInqYunits}

The function {\tt gridInqYunits} returns the units of a Y-axis.

Uwe Schulzweida's avatar
Uwe Schulzweida committed
752
\subsubsection*{Usage}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
753
754
755
756
757
758
759
760

\begin{verbatim}
    SUBROUTINE gridInqYunits(INTEGER gridID, CHARACTER*(*) units)
\end{verbatim}

\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt gridID\ }
\item[{\tt gridID}]
761
Grid ID, from a previous call to {\htmlref{\tt gridCreate}{gridCreate}}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
762
763
764
765
766
767
\item[{\tt units}]
Units of the Y-axis

\end{deflist}
\end{minipage}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
768
\subsubsection*{Result}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
769
770
771

{\tt gridInqYunits} returns the units of the Y-axis to the parameter units.