f_quick_ref.tex 35 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
\chapter*{Quick Reference}
\addcontentsline{toc}{chapter}{Quick Reference}

4
This appendix provide a brief listing of the Fortran language bindings of the CDI library routines:
Uwe Schulzweida's avatar
Uwe Schulzweida committed
5

Uwe Schulzweida's avatar
Uwe Schulzweida committed
6
7
8
9
10
11
\section*{\tt \htmlref{cdiClearAdditionalKeys}{cdiClearAdditionalKeys}}

\begin{verbatim}
    SUBROUTINE cdiClearAdditionalKeys
\end{verbatim}

12
Clear the list of additional GRIB keys.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
13
14
15
16
17
18
19
20


\section*{\tt \htmlref{cdiDefAdditionalKey}{cdiDefAdditionalKey}}

\begin{verbatim}
    SUBROUTINE cdiDefAdditionalKey (CHARACTER*(*) string)
\end{verbatim}

21
Register an additional GRIB key which is read when file is opened.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
22
23


24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
\section*{\tt \htmlref{cdiDefAttFlt}{cdiDefAttFlt}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefAttFlt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER type, INTEGER len, DOUBLEPRECISION dp(*))
\end{verbatim}

Define a floating point attribute.


\section*{\tt \htmlref{cdiDefAttInt}{cdiDefAttInt}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefAttInt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER type, INTEGER len, INTEGER ip(*))
\end{verbatim}

Define an integer attribute.


\section*{\tt \htmlref{cdiDefAttTxt}{cdiDefAttTxt}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefAttTxt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER len, CHARACTER*(*) tp_cbuf)
\end{verbatim}

Define a text attribute.


54
55
56
57
58
59
60
\section*{\tt \htmlref{cdiDefKeyFloat}{cdiDefKeyFloat}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefKeyFloat (INTEGER cdiID, INTEGER varID, INTEGER key,
                                     DOUBLEPRECISION value)
\end{verbatim}

61
Define a float value from a key.
62
63


64
65
66
67
68
69
70
\section*{\tt \htmlref{cdiDefKeyInt}{cdiDefKeyInt}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefKeyInt (INTEGER cdiID, INTEGER varID, INTEGER key,
                                   INTEGER value)
\end{verbatim}

71
Define an integer value from a key.
72
73
74
75
76
77
78
79
80


\section*{\tt \htmlref{cdiDefKeyString}{cdiDefKeyString}}

\begin{verbatim}
    INTEGER FUNCTION cdiDefKeyString (INTEGER cdiID, INTEGER varID, INTEGER key,
                                      CHARACTER*(*) string)
\end{verbatim}

81
Define a string from a key.
82
83


84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
\section*{\tt \htmlref{cdiInqAtt}{cdiInqAtt}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqAtt (INTEGER cdiID, INTEGER varID, INTEGER attrnum,
                                CHARACTER*(*) name, INTEGER typep, INTEGER lenp)
\end{verbatim}

Get information about an attribute.


\section*{\tt \htmlref{cdiInqAttFlt}{cdiInqAttFlt}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqAttFlt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER mlen, DOUBLEPRECISION dp(*))
\end{verbatim}

Get the value(s) of a floating point attribute.


\section*{\tt \htmlref{cdiInqAttInt}{cdiInqAttInt}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqAttInt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER mlen, INTEGER ip(*))
\end{verbatim}

Get the value(s) of an integer attribute.


\section*{\tt \htmlref{cdiInqAttTxt}{cdiInqAttTxt}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqAttTxt (INTEGER cdiID, INTEGER varID, CHARACTER*(*) name,
                                   INTEGER mlen, CHARACTER*(*) tp_cbuf)
\end{verbatim}

Get the value(s) of a text attribute.


124
125
126
127
128
129
130
\section*{\tt \htmlref{cdiInqKeyInt}{cdiInqKeyInt}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqKeyInt (INTEGER cdiID, INTEGER varID, INTEGER key,
                                   INTEGER value)
\end{verbatim}

131
Get an integer value from a key.
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150


\section*{\tt \htmlref{cdiInqKeyLen}{cdiInqKeyLen}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqKeyLen (INTEGER cdiID, INTEGER varID, INTEGER key,
                                   INTEGER length)
\end{verbatim}

Get the length of the string representation of the key.


\section*{\tt \htmlref{cdiInqKeyString}{cdiInqKeyString}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqKeyString (INTEGER cdiID, INTEGER varID, INTEGER key,
                                      CHARACTER*(*) string, INTEGER length)
\end{verbatim}

151
Get a string from a key.
152
153


154
155
156
157
158
159
160
161
162
\section*{\tt \htmlref{cdiInqNatts}{cdiInqNatts}}

\begin{verbatim}
    INTEGER FUNCTION cdiInqNatts (INTEGER cdiID, INTEGER varID, INTEGER nattsp)
\end{verbatim}

Get number of attributes assigned to this variable.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
163
164
165
166
167
168
169
170
171
\section*{\tt \htmlref{gridCreate}{gridCreate}}

\begin{verbatim}
    INTEGER FUNCTION gridCreate (INTEGER gridtype, INTEGER size)
\end{verbatim}

Create a horizontal Grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
172
173
174
175
176
177
178
179
180
\section*{\tt \htmlref{gridDefDatatype}{gridDefDatatype}}

\begin{verbatim}
    SUBROUTINE gridDefDatatype (INTEGER gridID, INTEGER prec)
\end{verbatim}

Define the data type of a Grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
\section*{\tt \htmlref{gridDefNP}{gridDefNP}}

\begin{verbatim}
    SUBROUTINE gridDefNP (INTEGER gridID, INTEGER np)
\end{verbatim}

Define the number of parallels between a pole and the equator.


\section*{\tt \htmlref{gridDefNumber}{gridDefNumber}}

\begin{verbatim}
    SUBROUTINE gridDefNumber (INTEGER gridID, INTEGER number)
\end{verbatim}

Define the reference number for an unstructured grid.


199
200
201
202
203
204
205
206
207
\section*{\tt \htmlref{gridDefNvertex}{gridDefNvertex}}

\begin{verbatim}
    SUBROUTINE gridDefNvertex (INTEGER gridID, INTEGER nvertex)
\end{verbatim}

Define the number of vertex of a Gridbox.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
208
209
210
211
212
213
214
215
216
\section*{\tt \htmlref{gridDefPosition}{gridDefPosition}}

\begin{verbatim}
    SUBROUTINE gridDefPosition (INTEGER gridID, INTEGER position)
\end{verbatim}

Define the position of grid in the reference file.


217
218
219
220
221
222
223
224
225
\section*{\tt \htmlref{gridDefProj}{gridDefProj}}

\begin{verbatim}
    SUBROUTINE gridDefProj (INTEGER gridID, INTEGER projID)
\end{verbatim}

Define the projection ID of a Grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
\section*{\tt \htmlref{gridDefReference}{gridDefReference}}

\begin{verbatim}
    SUBROUTINE gridDefReference (INTEGER gridID, CHARACTER*(*) reference)
\end{verbatim}

Define the reference URI for an unstructured grid.


\section*{\tt \htmlref{gridDefUUID}{gridDefUUID}}

\begin{verbatim}
    SUBROUTINE gridDefUUID (INTEGER gridID, INTEGER*1(16) uuid)
\end{verbatim}

Define the UUID of an unstructured grid.


244
245
246
\section*{\tt \htmlref{gridDefXbounds}{gridDefXbounds}}

\begin{verbatim}
247
    SUBROUTINE gridDefXbounds (INTEGER gridID, DOUBLEPRECISION xbounds(*))
248
249
250
251
252
\end{verbatim}

Define the bounds of a X-axis.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
\section*{\tt \htmlref{gridDefXlongname}{gridDefXlongname}}

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

Define the longname of a X-axis.


\section*{\tt \htmlref{gridDefXname}{gridDefXname}}

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

Define the name of a X-axis.


\section*{\tt \htmlref{gridDefXsize}{gridDefXsize}}

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

Define the size of a X-axis.


\section*{\tt \htmlref{gridDefXunits}{gridDefXunits}}

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

Define the units of a X-axis.


\section*{\tt \htmlref{gridDefXvals}{gridDefXvals}}

\begin{verbatim}
    SUBROUTINE gridDefXvals (INTEGER gridID, DOUBLEPRECISION xvals(*))
\end{verbatim}

Define the values of a X-axis.


298
299
300
\section*{\tt \htmlref{gridDefYbounds}{gridDefYbounds}}

\begin{verbatim}
301
    SUBROUTINE gridDefYbounds (INTEGER gridID, DOUBLEPRECISION ybounds(*))
302
303
304
305
306
\end{verbatim}

Define the bounds of a Y-axis.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
\section*{\tt \htmlref{gridDefYlongname}{gridDefYlongname}}

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

Define the longname of a Y-axis.


\section*{\tt \htmlref{gridDefYname}{gridDefYname}}

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

Define the name of a Y-axis.


\section*{\tt \htmlref{gridDefYsize}{gridDefYsize}}

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

Define the size of a Y-axis.


\section*{\tt \htmlref{gridDefYunits}{gridDefYunits}}

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

Define the units of a Y-axis.


\section*{\tt \htmlref{gridDefYvals}{gridDefYvals}}

\begin{verbatim}
    SUBROUTINE gridDefYvals (INTEGER gridID, DOUBLEPRECISION yvals(*))
\end{verbatim}

Define the values of a Y-axis.


\section*{\tt \htmlref{gridDestroy}{gridDestroy}}

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

Destroy a horizontal Grid.


\section*{\tt \htmlref{gridDuplicate}{gridDuplicate}}

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

Duplicate a Grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
370
371
372
373
374
375
376
377
378
\section*{\tt \htmlref{gridInqDatatype}{gridInqDatatype}}

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

Get the data type of a Grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
\section*{\tt \htmlref{gridInqNP}{gridInqNP}}

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

Get the number of parallels between a pole and the equator.


\section*{\tt \htmlref{gridInqNumber}{gridInqNumber}}

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

Get the reference number to an unstructured grid.


397
398
399
400
401
402
403
404
405
\section*{\tt \htmlref{gridInqNvertex}{gridInqNvertex}}

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

Get the number of vertex of a Gridbox.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
406
407
408
409
410
411
412
413
414
\section*{\tt \htmlref{gridInqPosition}{gridInqPosition}}

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

Get the position of grid in the reference file.


415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
\section*{\tt \htmlref{gridInqProj}{gridInqProj}}

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

Get the projection ID of a Grid.


\section*{\tt \htmlref{gridInqProjType}{gridInqProjType}}

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

Get the projection type.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
\section*{\tt \htmlref{gridInqReference}{gridInqReference}}

\begin{verbatim}
    INTEGER FUNCTION gridInqReference (INTEGER gridID, CHARACTER*(*) reference)
\end{verbatim}

Get the reference URI to an unstructured grid.


\section*{\tt \htmlref{gridInqSize}{gridInqSize}}

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

Get the size of a Grid.


\section*{\tt \htmlref{gridInqType}{gridInqType}}

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

Get the type of a Grid.


460
461
462
\section*{\tt \htmlref{gridInqUUID}{gridInqUUID}}

\begin{verbatim}
Thomas Jahns's avatar
Thomas Jahns committed
463
    SUBROUTINE gridInqUUID (INTEGER gridID, INTEGER*1(16) uuid)
464
465
466
467
468
\end{verbatim}

Get the UUID of an unstructured grid.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
469
470
471
472
473
474
475
476
477
\section*{\tt \htmlref{gridInqXIsc}{gridInqXIsc}}

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

Find out whether X-coordinate is of type CHAR.


478
479
480
\section*{\tt \htmlref{gridInqXbounds}{gridInqXbounds}}

\begin{verbatim}
481
    INTEGER FUNCTION gridInqXbounds (INTEGER gridID, DOUBLEPRECISION xbounds(*))
482
483
484
485
486
\end{verbatim}

Get the bounds of a X-axis.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
487
\section*{\tt \htmlref{gridInqXlongname}{gridInqXlongname}}
488
489

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
490
    SUBROUTINE gridInqXlongname (INTEGER gridID, CHARACTER*(*) xlongname)
491
492
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
493
Get the longname of a X-axis.
494
495


Uwe Schulzweida's avatar
Uwe Schulzweida committed
496
\section*{\tt \htmlref{gridInqXname}{gridInqXname}}
497
498

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
499
    SUBROUTINE gridInqXname (INTEGER gridID, CHARACTER*(*) xname)
500
501
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
502
Get the name of a X-axis.
503
504


Uwe Schulzweida's avatar
Uwe Schulzweida committed
505
\section*{\tt \htmlref{gridInqXsize}{gridInqXsize}}
506
507

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
508
    INTEGER FUNCTION gridInqXsize (INTEGER gridID)
509
510
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
511
Get the size of a X-axis.
512
513


Uwe Schulzweida's avatar
Uwe Schulzweida committed
514
\section*{\tt \htmlref{gridInqXunits}{gridInqXunits}}
515
516

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
517
    SUBROUTINE gridInqXunits (INTEGER gridID, CHARACTER*(*) xunits)
518
519
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
520
Get the units of a X-axis.
521
522


Uwe Schulzweida's avatar
Uwe Schulzweida committed
523
\section*{\tt \htmlref{gridInqXval}{gridInqXval}}
524
525

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
526
    DOUBLEPRECISION FUNCTION gridInqXval (INTEGER gridID, INTEGER index)
527
528
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
529
Get one value of a X-axis.
530
531


Uwe Schulzweida's avatar
Uwe Schulzweida committed
532
\section*{\tt \htmlref{gridInqXvals}{gridInqXvals}}
533
534

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
535
    INTEGER FUNCTION gridInqXvals (INTEGER gridID, DOUBLEPRECISION xvals(*))
536
537
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
538
Get all values of a X-axis.
539
540


Uwe Schulzweida's avatar
Uwe Schulzweida committed
541
542
543
544
545
546
547
548
549
\section*{\tt \htmlref{gridInqYIsc}{gridInqYIsc}}

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

Find out whether Y-coordinate is of type CHAR.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
550
\section*{\tt \htmlref{gridInqYbounds}{gridInqYbounds}}
551
552

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
553
    INTEGER FUNCTION gridInqYbounds (INTEGER gridID, DOUBLEPRECISION ybounds(*))
554
555
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
556
Get the bounds of a Y-axis.
557
558


Uwe Schulzweida's avatar
Uwe Schulzweida committed
559
\section*{\tt \htmlref{gridInqYlongname}{gridInqYlongname}}
560
561

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
562
    SUBROUTINE gridInqYlongname (INTEGER gridID, CHARACTER*(*) ylongname)
563
564
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
565
Get the longname of a Y-axis.
566
567


Uwe Schulzweida's avatar
Uwe Schulzweida committed
568
\section*{\tt \htmlref{gridInqYname}{gridInqYname}}
569
570

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
571
    SUBROUTINE gridInqYname (INTEGER gridID, CHARACTER*(*) yname)
572
573
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
574
Get the name of a Y-axis.
575
576


Uwe Schulzweida's avatar
Uwe Schulzweida committed
577
\section*{\tt \htmlref{gridInqYsize}{gridInqYsize}}
578
579

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
580
    INTEGER FUNCTION gridInqYsize (INTEGER gridID)
581
582
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
583
Get the size of a Y-axis.
584
585


Uwe Schulzweida's avatar
Uwe Schulzweida committed
586
\section*{\tt \htmlref{gridInqYunits}{gridInqYunits}}
587
588

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
589
    SUBROUTINE gridInqYunits (INTEGER gridID, CHARACTER*(*) yunits)
590
591
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
592
Get the units of a Y-axis.
593
594


Uwe Schulzweida's avatar
Uwe Schulzweida committed
595
\section*{\tt \htmlref{gridInqYval}{gridInqYval}}
596
597

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
598
    DOUBLEPRECISION FUNCTION gridInqYval (INTEGER gridID, INTEGER index)
599
600
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
601
Get one value of a Y-axis.
602
603


Uwe Schulzweida's avatar
Uwe Schulzweida committed
604
\section*{\tt \htmlref{gridInqYvals}{gridInqYvals}}
605
606

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
607
    INTEGER FUNCTION gridInqYvals (INTEGER gridID, DOUBLEPRECISION yvals(*))
608
609
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
610
Get all values of a Y-axis.
611
612


Uwe Schulzweida's avatar
Uwe Schulzweida committed
613
\section*{\tt \htmlref{streamClose}{streamClose}}
614
615

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
616
    SUBROUTINE streamClose (INTEGER streamID)
617
618
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
619
Close an open dataset.
620
621


Uwe Schulzweida's avatar
Uwe Schulzweida committed
622
\section*{\tt \htmlref{streamDefByteorder}{streamDefByteorder}}
623
624

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
625
    SUBROUTINE streamDefByteorder (INTEGER streamID, INTEGER byteorder)
626
627
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
628
Define the byteorder.
629
630


Uwe Schulzweida's avatar
Uwe Schulzweida committed
631
\section*{\tt \htmlref{streamDefCompLevel}{streamDefCompLevel}}
632
633

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
634
    SUBROUTINE streamDefCompLevel (INTEGER streamID, INTEGER complevel)
635
636
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
637
Define compression level.
638
639


Uwe Schulzweida's avatar
Uwe Schulzweida committed
640
\section*{\tt \htmlref{streamDefCompType}{streamDefCompType}}
641
642

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
643
    SUBROUTINE streamDefCompType (INTEGER streamID, INTEGER comptype)
644
645
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
646
Define compression type.
647
648


Uwe Schulzweida's avatar
Uwe Schulzweida committed
649
\section*{\tt \htmlref{streamDefTimestep}{streamDefTimestep}}
650
651

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
652
    INTEGER FUNCTION streamDefTimestep (INTEGER streamID, INTEGER tsID)
653
654
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
655
Define time step.
656
657


Uwe Schulzweida's avatar
Uwe Schulzweida committed
658
\section*{\tt \htmlref{streamDefVlist}{streamDefVlist}}
659
660

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
661
    SUBROUTINE streamDefVlist (INTEGER streamID, INTEGER vlistID)
662
663
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
664
Define the Vlist for a stream.
665
666


Uwe Schulzweida's avatar
Uwe Schulzweida committed
667
\section*{\tt \htmlref{streamInqByteorder}{streamInqByteorder}}
668
669

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
670
    INTEGER FUNCTION streamInqByteorder (INTEGER streamID)
671
672
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
673
Get the byteorder.
674
675


Uwe Schulzweida's avatar
Uwe Schulzweida committed
676
\section*{\tt \htmlref{streamInqCompLevel}{streamInqCompLevel}}
677
678

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
679
    INTEGER FUNCTION streamInqCompLevel (INTEGER streamID)
680
681
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
682
Get compression level.
683
684


Uwe Schulzweida's avatar
Uwe Schulzweida committed
685
\section*{\tt \htmlref{streamInqCompType}{streamInqCompType}}
686
687

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
688
    INTEGER FUNCTION streamInqCompType (INTEGER streamID)
689
690
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
691
Get compression type.
692
693


Uwe Schulzweida's avatar
Uwe Schulzweida committed
694
\section*{\tt \htmlref{streamInqFiletype}{streamInqFiletype}}
695
696

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
697
    INTEGER FUNCTION streamInqFiletype (INTEGER streamID)
698
699
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
700
Get the filetype.
701
702


Uwe Schulzweida's avatar
Uwe Schulzweida committed
703
\section*{\tt \htmlref{streamInqTimestep}{streamInqTimestep}}
704
705

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
706
    INTEGER FUNCTION streamInqTimestep (INTEGER streamID, INTEGER tsID)
707
708
\end{verbatim}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
Get time step.


\section*{\tt \htmlref{streamInqVlist}{streamInqVlist}}

\begin{verbatim}
    INTEGER FUNCTION streamInqVlist (INTEGER streamID)
\end{verbatim}

Get the Vlist of a stream.


\section*{\tt \htmlref{streamOpenRead}{streamOpenRead}}

\begin{verbatim}
    INTEGER FUNCTION streamOpenRead (CHARACTER*(*) path)
\end{verbatim}

Open a dataset for reading.


\section*{\tt \htmlref{streamOpenWrite}{streamOpenWrite}}

\begin{verbatim}
    INTEGER FUNCTION streamOpenWrite (CHARACTER*(*) path, INTEGER filetype)
\end{verbatim}

Create a new dataset.


\section*{\tt \htmlref{streamReadVar}{streamReadVar}}

\begin{verbatim}
    SUBROUTINE streamReadVar (INTEGER streamID, INTEGER varID,
                              DOUBLEPRECISION data(*), INTEGER nmiss)
\end{verbatim}

Read a variable.


\section*{\tt \htmlref{streamReadVarSlice}{streamReadVarSlice}}

\begin{verbatim}
    SUBROUTINE streamReadVarSlice (INTEGER streamID, INTEGER varID, INTEGER levelID,
                                   DOUBLEPRECISION data(*), INTEGER nmiss)
\end{verbatim}

Read a horizontal slice of a variable.


\section*{\tt \htmlref{streamSync}{streamSync}}

\begin{verbatim}
    SUBROUTINE streamSync (INTEGER streamID)
\end{verbatim}

Synchronize an Open Dataset to Disk.


\section*{\tt \htmlref{streamWriteVar}{streamWriteVar}}

\begin{verbatim}
    SUBROUTINE streamWriteVar (INTEGER streamID, INTEGER varID,
                               DOUBLEPRECISION data(*), INTEGER nmiss)
\end{verbatim}

Write a variable.


\section*{\tt \htmlref{streamWriteVarSlice}{streamWriteVarSlice}}

\begin{verbatim}
    SUBROUTINE streamWriteVarSlice (INTEGER streamID, INTEGER varID, INTEGER levelID,
                                    DOUBLEPRECISION data(*), INTEGER nmiss)
\end{verbatim}

Write a horizontal slice of a variable.


\section*{\tt \htmlref{subtypeCreate}{subtypeCreate}}

\begin{verbatim}
    INTEGER FUNCTION subtypeCreate (INTEGER subtype)
\end{verbatim}

Create a variable subtype.


\section*{\tt \htmlref{subtypeDefActiveIndex}{subtypeDefActiveIndex}}

\begin{verbatim}
    SUBROUTINE subtypeDefActiveIndex (INTEGER subtypeID, INTEGER index)
\end{verbatim}

803
Set the currently active index of a subtype (e.g. current tile index).
Uwe Schulzweida's avatar
Uwe Schulzweida committed
804
805
806
807
808
809
810
811


\section*{\tt \htmlref{subtypeInqActiveIndex}{subtypeInqActiveIndex}}

\begin{verbatim}
    INTEGER FUNCTION subtypeInqActiveIndex (INTEGER subtypeID)
\end{verbatim}

812
Get the currently active index of a subtype (e.g. current tile index).
Uwe Schulzweida's avatar
Uwe Schulzweida committed
813
814


Uwe Schulzweida's avatar
Uwe Schulzweida committed
815
816
817
818
819
820
821
822
823
824
\section*{\tt \htmlref{subtypeInqAttribute}{subtypeInqAttribute}}

\begin{verbatim}
    INTEGER FUNCTION subtypeInqAttribute (INTEGER subtypeID, INTEGER index,
                                          CHARACTER*(*) key, INTEGER outValue)
\end{verbatim}

Inquire the value of a subtype attribute. Returns CDI_EINVAL if the attribute does not exist..


Uwe Schulzweida's avatar
Uwe Schulzweida committed
825
826
827
828
829
830
\section*{\tt \htmlref{subtypeInqSize}{subtypeInqSize}}

\begin{verbatim}
    INTEGER FUNCTION subtypeInqSize (INTEGER subtypeID)
\end{verbatim}

831
Get the size of a subtype (e.g. no. of tiles).
Uwe Schulzweida's avatar
Uwe Schulzweida committed
832
833
834
835
836
837
838
839
840


\section*{\tt \htmlref{subtypeInqTile}{subtypeInqTile}}

\begin{verbatim}
    INTEGER FUNCTION subtypeInqTile (INTEGER subtypeID, INTEGER tileindex,
                                     INTEGER attribute)
\end{verbatim}

841
Specialized version of subtypeInqSubEntry looking for tile/attribute pair.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864


\section*{\tt \htmlref{tableRead}{tableRead}}

\begin{verbatim}
    INTEGER FUNCTION tableRead (CHARACTER*(*) tablefile)
\end{verbatim}

read table of parameters from file in tabular format.


\section*{\tt \htmlref{tableWrite}{tableWrite}}

\begin{verbatim}
    SUBROUTINE tableWrite (CHARACTER*(*) filename, INTEGER tableID)
\end{verbatim}

write table of parameters to file in tabular format.


\section*{\tt \htmlref{taxisCreate}{taxisCreate}}

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
865
    INTEGER FUNCTION taxisCreate (INTEGER taxistype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
\end{verbatim}

Create a Time axis.


\section*{\tt \htmlref{taxisDefCalendar}{taxisDefCalendar}}

\begin{verbatim}
    SUBROUTINE taxisDefCalendar (INTEGER taxisID, INTEGER calendar)
\end{verbatim}

Define the calendar.


\section*{\tt \htmlref{taxisDefFdate}{taxisDefFdate}}

\begin{verbatim}
    SUBROUTINE taxisDefFdate (INTEGER taxisID, INTEGER date)
\end{verbatim}

Define the forecast reference date.


\section*{\tt \htmlref{taxisDefFtime}{taxisDefFtime}}

\begin{verbatim}
    SUBROUTINE taxisDefFtime (INTEGER taxisID, INTEGER time)
\end{verbatim}

Define the forecast reference time.


\section*{\tt \htmlref{taxisDefRdate}{taxisDefRdate}}

\begin{verbatim}
    SUBROUTINE taxisDefRdate (INTEGER taxisID, INTEGER date)
\end{verbatim}

Define the reference date.


\section*{\tt \htmlref{taxisDefRtime}{taxisDefRtime}}

\begin{verbatim}
    SUBROUTINE taxisDefRtime (INTEGER taxisID, INTEGER time)
\end{verbatim}

Define the reference time.


\section*{\tt \htmlref{taxisDefVdate}{taxisDefVdate}}

\begin{verbatim}
    SUBROUTINE taxisDefVdate (INTEGER taxisID, INTEGER date)
\end{verbatim}

Define the verification date.


\section*{\tt \htmlref{taxisDefVtime}{taxisDefVtime}}

\begin{verbatim}
    SUBROUTINE taxisDefVtime (INTEGER taxisID, INTEGER time)
\end{verbatim}

Define the verification time.


\section*{\tt \htmlref{taxisDestroy}{taxisDestroy}}

\begin{verbatim}
    SUBROUTINE taxisDestroy (INTEGER taxisID)
\end{verbatim}

Destroy a Time axis.


\section*{\tt \htmlref{taxisInqCalendar}{taxisInqCalendar}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqCalendar (INTEGER taxisID)
\end{verbatim}

Get the calendar.


\section*{\tt \htmlref{taxisInqFdate}{taxisInqFdate}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqFdate (INTEGER taxisID)
\end{verbatim}

Get the forecast reference date.


\section*{\tt \htmlref{taxisInqFtime}{taxisInqFtime}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqFtime (INTEGER taxisID)
\end{verbatim}

Get the forecast reference time.


\section*{\tt \htmlref{taxisInqRdate}{taxisInqRdate}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqRdate (INTEGER taxisID)
\end{verbatim}

Get the reference date.


\section*{\tt \htmlref{taxisInqRtime}{taxisInqRtime}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqRtime (INTEGER taxisID)
\end{verbatim}

Get the reference time.


\section*{\tt \htmlref{taxisInqVdate}{taxisInqVdate}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqVdate (INTEGER taxisID)
\end{verbatim}

Get the verification date.


\section*{\tt \htmlref{taxisInqVtime}{taxisInqVtime}}

\begin{verbatim}
    INTEGER FUNCTION taxisInqVtime (INTEGER taxisID)
\end{verbatim}

Get the verification time.


\section*{\tt \htmlref{vlistCat}{vlistCat}}

\begin{verbatim}
    SUBROUTINE vlistCat (INTEGER vlistID2, INTEGER vlistID1)
\end{verbatim}

Concatenate two variable lists.


\section*{\tt \htmlref{vlistCopy}{vlistCopy}}

\begin{verbatim}
    SUBROUTINE vlistCopy (INTEGER vlistID2, INTEGER vlistID1)
\end{verbatim}

Copy a variable list.


\section*{\tt \htmlref{vlistCopyFlag}{vlistCopyFlag}}

\begin{verbatim}
    SUBROUTINE vlistCopyFlag (INTEGER vlistID2, INTEGER vlistID1)
\end{verbatim}

Copy some entries of a variable list.


\section*{\tt \htmlref{vlistCopyVarName}{vlistCopyVarName}}

\begin{verbatim}
    CHARACTER(80) FUNCTION vlistCopyVarName (INTEGER vlistId, INTEGER varId)
\end{verbatim}

Safe and convenient version of vlistInqVarName.


\section*{\tt \htmlref{vlistCreate}{vlistCreate}}

\begin{verbatim}
    INTEGER FUNCTION vlistCreate
\end{verbatim}

Create a variable list.


\section*{\tt \htmlref{vlistDefTaxis}{vlistDefTaxis}}

\begin{verbatim}
    SUBROUTINE vlistDefTaxis (INTEGER vlistID, INTEGER taxisID)
\end{verbatim}

Define the time axis of a variable list.


\section*{\tt \htmlref{vlistDefVar}{vlistDefVar}}

\begin{verbatim}
    INTEGER FUNCTION vlistDefVar (INTEGER vlistID, INTEGER gridID, INTEGER zaxisID,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1064
                                  INTEGER timetype)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
\end{verbatim}

Create a new variable.


\section*{\tt \htmlref{vlistDefVarCode}{vlistDefVarCode}}

\begin{verbatim}
    SUBROUTINE vlistDefVarCode (INTEGER vlistID, INTEGER varID, INTEGER code)
\end{verbatim}

Define the code number of a Variable.


\section*{\tt \htmlref{vlistDefVarDatatype}{vlistDefVarDatatype}}

\begin{verbatim}
    SUBROUTINE vlistDefVarDatatype (INTEGER vlistID, INTEGER varID, INTEGER datatype)
\end{verbatim}

Define the data type of a Variable.


\section*{\tt \htmlref{vlistDefVarDblKey}{vlistDefVarDblKey}}

\begin{verbatim}
    SUBROUTINE vlistDefVarDblKey (INTEGER vlistID, INTEGER varID, CHARACTER*(*) name,
                                  DOUBLEPRECISION value)
\end{verbatim}

Set an arbitrary keyword/double value pair for GRIB API.


\section*{\tt \htmlref{vlistDefVarExtra}{vlistDefVarExtra}}

\begin{verbatim}
    SUBROUTINE vlistDefVarExtra (INTEGER vlistID, INTEGER varID, CHARACTER*(*) extra)
\end{verbatim}

Define extra information of a Variable.


\section*{\tt \htmlref{vlistDefVarIntKey}{vlistDefVarIntKey}}

\begin{verbatim}
    SUBROUTINE vlistDefVarIntKey (INTEGER vlistID, INTEGER varID, CHARACTER*(*) name,
                                  INTEGER value)
\end{verbatim}

Set an arbitrary keyword/integer value pair for GRIB API.


\section*{\tt \htmlref{vlistDefVarLongname}{vlistDefVarLongname}}

\begin{verbatim}
    SUBROUTINE vlistDefVarLongname (INTEGER vlistID, INTEGER varID,
                                    CHARACTER*(*) longname)
\end{verbatim}

Define the long name of a Variable.


\section*{\tt \htmlref{vlistDefVarMissval}{vlistDefVarMissval}}

\begin{verbatim}
    SUBROUTINE vlistDefVarMissval (INTEGER vlistID, INTEGER varID,
                                   DOUBLEPRECISION missval)
\end{verbatim}

Define the missing value of a Variable.


\section*{\tt \htmlref{vlistDefVarName}{vlistDefVarName}}

\begin{verbatim}
    SUBROUTINE vlistDefVarName (INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}

Define the name of a Variable.


\section*{\tt \htmlref{vlistDefVarParam}{vlistDefVarParam}}

\begin{verbatim}
    SUBROUTINE vlistDefVarParam (INTEGER vlistID, INTEGER varID, INTEGER param)
\end{verbatim}

Define the parameter number of a Variable.


\section*{\tt \htmlref{vlistDefVarStdname}{vlistDefVarStdname}}

\begin{verbatim}
    SUBROUTINE vlistDefVarStdname (INTEGER vlistID, INTEGER varID,
                                   CHARACTER*(*) stdname)
\end{verbatim}

Define the standard name of a Variable.


\section*{\tt \htmlref{vlistDefVarTiles}{vlistDefVarTiles}}

\begin{verbatim}
    INTEGER FUNCTION vlistDefVarTiles (INTEGER vlistID, INTEGER gridID,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1169
                                       INTEGER zaxisID, INTEGER timetype,
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
                                       INTEGER tilesetID)
\end{verbatim}

Create a new tile-based variable.


\section*{\tt \htmlref{vlistDefVarUnits}{vlistDefVarUnits}}

\begin{verbatim}
    SUBROUTINE vlistDefVarUnits (INTEGER vlistID, INTEGER varID, CHARACTER*(*) units)
\end{verbatim}

Define the units of a Variable.


\section*{\tt \htmlref{vlistDestroy}{vlistDestroy}}

\begin{verbatim}
    SUBROUTINE vlistDestroy (INTEGER vlistID)
\end{verbatim}

Destroy a variable list.


\section*{\tt \htmlref{vlistDuplicate}{vlistDuplicate}}

\begin{verbatim}
    INTEGER FUNCTION vlistDuplicate (INTEGER vlistID)
\end{verbatim}

Duplicate a variable list.


\section*{\tt \htmlref{vlistHasVarKey}{vlistHasVarKey}}

\begin{verbatim}
    INTEGER FUNCTION vlistHasVarKey (INTEGER vlistID, INTEGER varID,
                                     CHARACTER*(*) name)
\end{verbatim}

1210
returns 1 if meta-data key was read, 0 otherwise.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321


\section*{\tt \htmlref{vlistInqTaxis}{vlistInqTaxis}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqTaxis (INTEGER vlistID)
\end{verbatim}

Get the time axis of a variable list.


\section*{\tt \htmlref{vlistInqVarCode}{vlistInqVarCode}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarCode (INTEGER vlistID, INTEGER varID)
\end{verbatim}

Get the code number of a Variable.


\section*{\tt \htmlref{vlistInqVarDatatype}{vlistInqVarDatatype}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarDatatype (INTEGER vlistID, INTEGER varID)
\end{verbatim}

Get the data type of a Variable.


\section*{\tt \htmlref{vlistInqVarDblKey}{vlistInqVarDblKey}}

\begin{verbatim}
    DOUBLEPRECISION FUNCTION vlistInqVarDblKey (INTEGER vlistID, INTEGER varID,
                                                CHARACTER*(*) name)
\end{verbatim}

raw access to GRIB meta-data.


\section*{\tt \htmlref{vlistInqVarExtra}{vlistInqVarExtra}}

\begin{verbatim}
    SUBROUTINE vlistInqVarExtra (INTEGER vlistID, INTEGER varID, CHARACTER*(*) extra)
\end{verbatim}

Get extra information of a Variable.


\section*{\tt \htmlref{vlistInqVarIntKey}{vlistInqVarIntKey}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarIntKey (INTEGER vlistID, INTEGER varID,
                                        CHARACTER*(*) name)
\end{verbatim}

raw access to GRIB meta-data.


\section*{\tt \htmlref{vlistInqVarLongname}{vlistInqVarLongname}}

\begin{verbatim}
    SUBROUTINE vlistInqVarLongname (INTEGER vlistID, INTEGER varID,
                                    CHARACTER*(*) longname)
\end{verbatim}

Get the long name of a Variable.


\section*{\tt \htmlref{vlistInqVarMissval}{vlistInqVarMissval}}

\begin{verbatim}
    DOUBLEPRECISION FUNCTION vlistInqVarMissval (INTEGER vlistID, INTEGER varID)
\end{verbatim}

Get the missing value of a Variable.


\section*{\tt \htmlref{vlistInqVarName}{vlistInqVarName}}

\begin{verbatim}
    SUBROUTINE vlistInqVarName (INTEGER vlistID, INTEGER varID, CHARACTER*(*) name)
\end{verbatim}

Get the name of a Variable.


\section*{\tt \htmlref{vlistInqVarParam}{vlistInqVarParam}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarParam (INTEGER vlistID, INTEGER varID)
\end{verbatim}

Get the parameter number of a Variable.


\section*{\tt \htmlref{vlistInqVarStdname}{vlistInqVarStdname}}

\begin{verbatim}
    SUBROUTINE vlistInqVarStdname (INTEGER vlistID, INTEGER varID,
                                   CHARACTER*(*) stdname)
\end{verbatim}

Get the standard name of a Variable.


\section*{\tt \htmlref{vlistInqVarSubtype}{vlistInqVarSubtype}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarSubtype (INTEGER vlistID, INTEGER varID)
\end{verbatim}

1322
Return subtype ID for a given variable.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1323
1324


1325
1326
1327
1328
1329
1330
1331
1332
1333
\section*{\tt \htmlref{vlistInqVarTsteptype}{vlistInqVarTsteptype}}

\begin{verbatim}
    INTEGER FUNCTION vlistInqVarTsteptype (INTEGER vlistID, INTEGER varID)
\end{verbatim}

Get the timestep type of a Variable.


Uwe Schulzweida's avatar
Uwe Schulzweida committed
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
\section*{\tt \htmlref{vlistInqVarUnits}{vlistInqVarUnits}}

\begin{verbatim}
    SUBROUTINE vlistInqVarUnits (INTEGER vlistID, INTEGER varID, CHARACTER*(*) units)
\end{verbatim}

Get the units of a Variable.


\section*{\tt \htmlref{vlistMerge}{vlistMerge}}

\begin{verbatim}
    SUBROUTINE vlistMerge (INTEGER vlistID2, INTEGER vlistID1)
\end{verbatim}

Merge two variable lists.


\section*{\tt \htmlref{vlistNgrids}{vlistNgrids}}

\begin{verbatim}
    INTEGER FUNCTION vlistNgrids (INTEGER vlistID)
\end{verbatim}

Number of grids in a variable list.


\section*{\tt \htmlref{vlistNsubtypes}{vlistNsubtypes}}

\begin{verbatim}
    INTEGER FUNCTION vlistNsubtypes (INTEGER vlistID)
\end{verbatim}

Number of subtypes in a variable list.


\section*{\tt \htmlref{vlistNumber}{vlistNumber}}

\begin{verbatim}
    INTEGER FUNCTION vlistNumber (INTEGER vlistID)
\end{verbatim}

Number type in a variable list.


\section*{\tt \htmlref{vlistNvars}{vlistNvars}}

\begin{verbatim}
    INTEGER FUNCTION vlistNvars (INTEGER vlistID)
\end{verbatim}

Number of variables in a variable list.


\section*{\tt \htmlref{vlistNzaxis}{vlistNzaxis}}

\begin{verbatim}
    INTEGER FUNCTION vlistNzaxis (INTEGER vlistID)
\end{verbatim}

Number of zaxis in a variable list.
1395
1396


1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
\section*{\tt \htmlref{zaxisCreate}{zaxisCreate}}

\begin{verbatim}
    INTEGER FUNCTION zaxisCreate (INTEGER zaxistype, INTEGER size)
\end{verbatim}

Create a vertical Z-axis.


\section*{\tt \htmlref{zaxisDefLevel}{zaxisDefLevel}}

\begin{verbatim}
    SUBROUTINE zaxisDefLevel (INTEGER zaxisID, INTEGER levelID,
                              DOUBLEPRECISION levels)
\end{verbatim}

Define one level of a Z-axis.


\section*{\tt \htmlref{zaxisDefLevels}{zaxisDefLevels}}

\begin{verbatim}
1419
    SUBROUTINE zaxisDefLevels (INTEGER zaxisID, DOUBLEPRECISION levels(*))
1420
1421
1422
1423
1424
1425
1426
1427
\end{verbatim}

Define the levels of a Z-axis.


\section*{\tt \htmlref{zaxisDefLongname}{zaxisDefLongname}}

\begin{verbatim}
1428
    SUBROUTINE zaxisDefLongname (INTEGER zaxisID, CHARACTER*(*) longname_optional)
1429
1430
1431
1432
1433
1434
1435
1436
\end{verbatim}

Define the longname of a Z-axis.


\section*{\tt \htmlref{zaxisDefName}{zaxisDefName}}

\begin{verbatim}
1437
    SUBROUTINE zaxisDefName (INTEGER zaxisID, CHARACTER*(*) name_optional)
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
\end{verbatim}

Define the name of a Z-axis.


\section*{\tt \htmlref{zaxisDefNlevRef}{zaxisDefNlevRef}}

\begin{verbatim}
    SUBROUTINE zaxisDefNlevRef (INTEGER gridID, INTEGER nhlev)
\end{verbatim}

Define the number of half levels of a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefNumber}{zaxisDefNumber}}

\begin{verbatim}
    SUBROUTINE zaxisDefNumber (INTEGER gridID, INTEGER number)
\end{verbatim}

Define the reference number for a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefUUID}{zaxisDefUUID}}

\begin{verbatim}
1464
    SUBROUTINE zaxisDefUUID (INTEGER zaxisID, INTEGER*1(16) uuid)
1465
1466
1467
1468
1469
1470
1471
1472
\end{verbatim}

Define the UUID of a generalized Z-axis.


\section*{\tt \htmlref{zaxisDefUnits}{zaxisDefUnits}}

\begin{verbatim}
1473
    SUBROUTINE zaxisDefUnits (INTEGER zaxisID, CHARACTER*(*) units_optional)
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
\end{verbatim}

Define the units of a Z-axis.


\section*{\tt \htmlref{zaxisDestroy}{zaxisDestroy}}

\begin{verbatim}
    SUBROUTINE zaxisDestroy (INTEGER zaxisID)
\end{verbatim}

Destroy a vertical Z-axis.


\section*{\tt \htmlref{zaxisDuplicate}{zaxisDuplicate}}

\begin{verbatim}
    INTEGER FUNCTION zaxisDuplicate (INTEGER zaxisID)
\end{verbatim}

Duplicate a Z-axis.


1497
1498
1499
1500
1501
1502
1503
1504
1505
\section*{\tt \htmlref{zaxisInqCLen}{zaxisInqCLen}}

\begin{verbatim}
    INTEGER FUNCTION zaxisInqCLen (INTEGER zaxisID)
\end{verbatim}

Get maximal string length of character Z-axis.


1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
\section*{\tt \htmlref{zaxisInqLevel}{zaxisInqLevel}}

\begin{verbatim}
    DOUBLEPRECISION FUNCTION zaxisInqLevel (INTEGER zaxisID, INTEGER levelID)
\end{verbatim}

Get one level of a Z-axis.


\section*{\tt \htmlref{zaxisInqLevels}{zaxisInqLevels}}

\begin{verbatim}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1518
    INTEGER FUNCTION zaxisInqLevels (INTEGER zaxisID, DOUBLEPRECISION levels(*))
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
\end{verbatim}

Get all levels of a Z-axis.


\section*{\tt \htmlref{zaxisInqLongname}{zaxisInqLongname}}

\begin{verbatim}
    SUBROUTINE zaxisInqLongname (INTEGER zaxisID, CHARACTER*(*) longname)
\end{verbatim}

Get the longname of a Z-axis.


\section*{\tt \htmlref{zaxisInqName}{zaxisInqName}}

\begin{verbatim}
    SUBROUTINE zaxisInqName (INTEGER zaxisID, CHARACTER*(*) name)
\end{verbatim}

Get the name of a Z-axis.


\section*{\tt \htmlref{zaxisInqNlevRef}{zaxisInqNlevRef}}

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

Get the number of half levels of a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqNumber}{zaxisInqNumber}}

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

Get the reference number to a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqSize}{zaxisInqSize}}

\begin{verbatim}
    INTEGER FUNCTION zaxisInqSize (INTEGER zaxisID)
\end{verbatim}

Get the size of a Z-axis.


\section*{\tt \htmlref{zaxisInqStdname}{zaxisInqStdname}}

\begin{verbatim}
    SUBROUTINE zaxisInqStdname (INTEGER zaxisID, CHARACTER*(*) stdname)
\end{verbatim}

Get the standard name of a Z-axis.


\section*{\tt \htmlref{zaxisInqType}{zaxisInqType}}

\begin{verbatim}
    INTEGER FUNCTION zaxisInqType (INTEGER zaxisID)
\end{verbatim}

Get the type of a Z-axis.


\section*{\tt \htmlref{zaxisInqUUID}{zaxisInqUUID}}

\begin{verbatim}
1590
    SUBROUTINE zaxisInqUUID (INTEGER zaxisID, INTEGER*1(16) uuid)
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
\end{verbatim}

Get the UUID of a generalized Z-axis.


\section*{\tt \htmlref{zaxisInqUnits}{zaxisInqUnits}}

\begin{verbatim}
    SUBROUTINE zaxisInqUnits (INTEGER zaxisID, CHARACTER*(*) units)
\end{verbatim}

Get the units of a Z-axis.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1603
1604