vlist.c 38.7 KB
Newer Older
Uwe Schulzweida's avatar
Uwe Schulzweida committed
1
2
3
4
5
6
7
8
9
#if defined (HAVE_CONFIG_H)
#  include "config.h"
#endif

#include "dmemory.h"
#include "cdi.h"
#include "stream_int.h"
#include "vlist.h"
#include "varscan.h"
10
#include "namespace.h"
11
#include "pio_util.h"
12
#include "resource_handle.h"
Thomas Jahns's avatar
Thomas Jahns committed
13
#include "vlist_var.h"
14
#include "pio_rpc.h"
Uwe Schulzweida's avatar
Uwe Schulzweida committed
15

16
static int VLIST_Debug = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
17
18
19
20
21
22

static void vlist_initialize(void);

#if  defined  (HAVE_LIBPTHREAD)
#  include <pthread.h>

23
static pthread_once_t  _vlist_init_thread = PTHREAD_ONCE_INIT;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
24

25
#  define VLIST_INIT()        \
26
  pthread_once(&_vlist_init_thread, vlist_initialize)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
27
28
29

#else

30
static int vlistIsInitialized = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
31

32
33
34
#  define VLIST_INIT()               \
  if ( _vlist_init == FALSE ) vlist_initialize()
#endif
Uwe Schulzweida's avatar
Uwe Schulzweida committed
35
36


37
38
39
/* FIXME: implementation incomplete, fix once leaf nodes are complete */
static int
vlist_compare(vlist_t *a, vlist_t *b)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
40
{
41
42
43
44
45
46
47
  int diff;
  diff = (a->nvars != b->nvars) || (a->ngrids != b->ngrids)
    || (a->nzaxis != b->nzaxis) || (a->instID != b->instID)
    || (a->modelID != b->modelID) || (a->tableID != b->tableID)
    || (a->varsAllocated != b->varsAllocated)
    || (a->ntsteps != b->ntsteps);
  return diff;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
48
49
}

50
51
static void
vlistPrintKernel(vlist_t *vlistptr);
52
#ifdef USE_MPI
53
static int  vlistGetSizeP ( void * vlistptr, MPI_Comm comm );
54
55
static void vlistPackP    ( void * vlistptr, void * buff, int size,
                            int *position, MPI_Comm comm );
56
static int  vlistTxCode(void *vlistptr);
57
#endif
58

59
60
resOps vlist_ops = {
  (valCompareFunc)vlist_compare,
61
  free,
62
63
64
  (valPrintFunc)vlistPrintKernel
#ifdef USE_MPI
  , vlistGetSizeP,
65
66
  vlistPackP,
  vlistTxCode
67
#endif
68
};
Uwe Schulzweida's avatar
Uwe Schulzweida committed
69
70


71
vlist_t *vlist_to_pointer(int code)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
72
{
73
  VLIST_INIT();
74
  return reshGetVal(code, &vlist_ops );
Uwe Schulzweida's avatar
Uwe Schulzweida committed
75
76
}

77
78
static
void vlist_init_entry(vlist_t *vlistptr)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
79
{
80
  vlistptr->self           = reshPut(vlistptr, &vlist_ops);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
81
82
83
84
85
86

  vlistptr->nlock          = 0;
  vlistptr->nvars          = 0;
  vlistptr->vars           = NULL;
  vlistptr->ngrids         = 0;
  vlistptr->nzaxis         = 0;
87
  vlistptr->taxisID        = CDI_UNDEFID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
88
89
90
91
92
  vlistptr->instID         = cdiDefaultInstID;
  vlistptr->modelID        = cdiDefaultModelID;
  vlistptr->tableID        = cdiDefaultTableID;
  vlistptr->varsAllocated  = 0;
  vlistptr->ntsteps        = CDI_UNDEFID;
93
  vlistptr->atts.nalloc    = MAX_ATTRIBUTES;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
94
  vlistptr->atts.nelems    = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
95
96
}

97
98
static
vlist_t *vlist_new_entry(void)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
99
{
100
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
101

102
  vlistptr = (vlist_t *)xmalloc(sizeof(vlist_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
103

104
  vlist_init_entry(vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
105
106
107
108

  return (vlistptr);
}

109
110
static
void vlist_delete_entry(vlist_t *vlistptr)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
111
{
112
113
114
  int idx, nsp;

  nsp = namespaceGetActive ();
Uwe Schulzweida's avatar
Uwe Schulzweida committed
115
116
117

  idx = vlistptr->self;

118
  reshRemove(idx, &vlist_ops );
Uwe Schulzweida's avatar
Uwe Schulzweida committed
119
120
121
122

  free(vlistptr);

  if ( VLIST_Debug )
123
    Message("Removed idx %d from vlist list", idx);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
124
125
}

126
127
static
void vlist_initialize(void)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
128
129
130
131
132
133
134
{
  char *env;

  env = getenv("VLIST_DEBUG");
  if ( env ) VLIST_Debug = atoi(env);
}

135
136
static
void vlist_copy(vlist_t *vlistptr2, vlist_t *vlistptr1)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
137
138
139
140
{
  int vlistID2;

  vlistID2 = vlistptr2->self;
141
  memcpy(vlistptr2, vlistptr1, sizeof(vlist_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
142
  vlistptr2->atts.nelems = 0;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
143
144
145
  vlistptr2->self = vlistID2;
}

146
147
static
void vlist_check_ptr(const char *caller, vlist_t *vlistptr)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
148
149
{
  if ( vlistptr == NULL )
150
    Errorc("vlist undefined!");
Uwe Schulzweida's avatar
Uwe Schulzweida committed
151
152
153
}

/*
154
@Function  vlistCreate
Uwe Schulzweida's avatar
Uwe Schulzweida committed
155
156
@Title     Create a variable list

157
@Prototype int vlistCreate(void)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
158

Uwe Schulzweida's avatar
Uwe Schulzweida committed
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
@Example
Here is an example using @func{vlistCreate} to create a variable list
and add a variable with @func{vlistDefVar}.

@Source
#include "cdi.h"
   ...
int vlistID, varID;
   ...
vlistID = vlistCreate();
varID = vlistDefVar(vlistID, gridID, zaxisID, TIME_VARIABLE);
   ...
streamDefVlist(streamID, vlistID);
   ...
vlistDestroy(vlistID);
   ...
@EndSource
Uwe Schulzweida's avatar
Uwe Schulzweida committed
176
177
@EndFunction
*/
178
int vlistCreate(void)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
179
180
{
  int vlistID = 0;
181
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
182

183
  VLIST_INIT();
Uwe Schulzweida's avatar
Uwe Schulzweida committed
184
185
186
187
188

  vlistptr = vlist_new_entry();

  vlistID = vlistptr->self;

189
  if ( vlistID >= 0 ) vlistLock(vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
190
191
192
193
194

  return (vlistID);
}

/*
195
@Function  vlistDestroy
196
@Title     Destroy a variable list
Uwe Schulzweida's avatar
Uwe Schulzweida committed
197

198
@Prototype void vlistDestroy(int vlistID)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
199
@Parameter
200
    @Item  vlistID  Variable list ID, from a previous call to @fref{vlistCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
201
202
203

@EndFunction
*/
204
void vlistDestroy(int vlistID)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
205
{
206
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
207
208
209

  vlistptr = vlist_to_pointer(vlistID);

210
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
211
212
213
214
215

  vlistUnlock(vlistID);

  if ( vlistptr->nlock > 0 )
    {
216
      Warning("vlist %d is locked!", vlistID);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
217
218
219
220
    }
  else
    {
      int nvars = vlistptr->nvars;
221
      int varID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
222

223
      vlistDelAtts(vlistID, CDI_GLOBAL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
224
225

      for ( varID = 0; varID < nvars; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
226
227
228
229
230
231
        {
          if ( vlistptr->vars[varID].levinfo )  free(vlistptr->vars[varID].levinfo);
          if ( vlistptr->vars[varID].name )     free(vlistptr->vars[varID].name);
          if ( vlistptr->vars[varID].longname ) free(vlistptr->vars[varID].longname);
          if ( vlistptr->vars[varID].stdname )  free(vlistptr->vars[varID].stdname);
          if ( vlistptr->vars[varID].units )    free(vlistptr->vars[varID].units);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
232

Thomas Jahns's avatar
Thomas Jahns committed
233
234
          vlistDelAtts(vlistID, varID);
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
235
236
237
238
239
240
241

      if ( vlistptr->vars ) free(vlistptr->vars);

      vlist_delete_entry(vlistptr);
    }
}

242

Uwe Schulzweida's avatar
Uwe Schulzweida committed
243
244
int vlistNlock(int vlistID)
{
245
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
246
247
248

  vlistptr = vlist_to_pointer(vlistID);

249
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
250
251
252
253

  return (vlistptr->nlock);
}

254

Uwe Schulzweida's avatar
Uwe Schulzweida committed
255
256
void vlistLock(int vlistID)
{
257
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
258
259
260

  vlistptr = vlist_to_pointer(vlistID);

261
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
262
263

  vlistptr->nlock++;
264
  /*  Message("vlistID %d nlock %d", vlistID, vlistptr->nlock); */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
265
266
}

267

Uwe Schulzweida's avatar
Uwe Schulzweida committed
268
269
void vlistUnlock(int vlistID)
{
270
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
271
272
273

  vlistptr = vlist_to_pointer(vlistID);

274
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
275
276

  vlistptr->nlock--;
277
  /*  Message("vlistID %d nlock %d", vlistID, vlistptr->nlock); */
Uwe Schulzweida's avatar
Uwe Schulzweida committed
278
279
280
281
282
283
284
285
}

/*
@Function  vlistCopy
@Title     Copy a variable list

@Prototype void vlistCopy(int vlistID2, int vlistID1)
@Parameter
286
287
    @Item  vlistID2  Target variable list ID
    @Item  vlistID1  Source variable list ID
Uwe Schulzweida's avatar
Uwe Schulzweida committed
288
289

@Description
290
The function @func{vlistCopy} copies all entries from vlistID1 to vlistID2.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
291
292
293
294
295

@EndFunction
*/
void vlistCopy(int vlistID2, int vlistID1)
{
296
  vlist_t *vlistptr1, *vlistptr2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
297
298
299
300

  vlistptr1 = vlist_to_pointer(vlistID1);
  vlistptr2 = vlist_to_pointer(vlistID2);

301
302
  vlist_check_ptr(__func__, vlistptr1);
  vlist_check_ptr(__func__, vlistptr2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
303
304
305

  vlist_copy(vlistptr2, vlistptr1);

306
  vlistCopyVarAtts(vlistID1, CDI_GLOBAL, vlistID2, CDI_GLOBAL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
307

Uwe Schulzweida's avatar
Uwe Schulzweida committed
308
309
310
311
312
  if ( vlistptr1->vars )
    {
      int nvars = vlistptr1->nvars;
      int nlevs, varID;

Uwe Schulzweida's avatar
Uwe Schulzweida committed
313
314
      vlistptr2->vars = (var_t *) malloc(nvars*sizeof(var_t));
      memcpy(vlistptr2->vars, vlistptr1->vars, nvars*sizeof(var_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
315
316

      for ( varID = 0; varID < nvars; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
317
318
319
        {
          if ( vlistptr1->vars[varID].name )
            vlistptr2->vars[varID].name = strdupx(vlistptr1->vars[varID].name);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
320

Thomas Jahns's avatar
Thomas Jahns committed
321
322
          if ( vlistptr1->vars[varID].longname )
            vlistptr2->vars[varID].longname = strdupx(vlistptr1->vars[varID].longname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
323

Thomas Jahns's avatar
Thomas Jahns committed
324
325
          if ( vlistptr1->vars[varID].stdname )
            vlistptr2->vars[varID].stdname = strdupx(vlistptr1->vars[varID].stdname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
326

Thomas Jahns's avatar
Thomas Jahns committed
327
328
          if ( vlistptr1->vars[varID].units )
            vlistptr2->vars[varID].units = strdupx(vlistptr1->vars[varID].units);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
329

Thomas Jahns's avatar
Thomas Jahns committed
330
331
332
333
          nlevs = vlistptr1->vars[varID].nlevs;
          vlistptr2->vars[varID].levinfo = (levinfo_t *) malloc(nlevs*sizeof(levinfo_t));
          memcpy(vlistptr2->vars[varID].levinfo,
                 vlistptr1->vars[varID].levinfo, nlevs*sizeof(levinfo_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
334

Thomas Jahns's avatar
Thomas Jahns committed
335
336
337
          vlistptr2->vars[varID].atts.nelems = 0;
          vlistCopyVarAtts(vlistID1, varID, vlistID2, varID);
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
338
339
340
341
342
343
344
345
346
347
348
    }

  vlistptr2->nlock = 0;
}

/*
@Function  vlistDuplicate
@Title     Duplicate a variable list

@Prototype int vlistDuplicate(int vlistID)
@Parameter
349
    @Item  vlistID  Variable list ID, from a previous call to @fref{vlistCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
350
351

@Description
352
The function @func{vlistDuplicate} duplicates the variable list from vlistID1.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
353
354

@Result
355
@func{vlistDuplicate} returns an identifier to the duplicated variable list.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
356
357
358
359
360
361

@EndFunction
*/
int vlistDuplicate(int vlistID)
{
  int vlistIDnew;
362
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
363
364
365

  vlistptr = vlist_to_pointer(vlistID);

366
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
367

368
  vlistIDnew = vlistCreate();
Uwe Schulzweida's avatar
Uwe Schulzweida committed
369
370
371
372
373
374
375
376
377
378

  vlistCopy(vlistIDnew, vlistID);

  return (vlistIDnew);
}


void vlistClearFlag(int vlistID)
{
  int varID, levID;
379
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
380
381
382
383
384
385
386

  vlistptr = vlist_to_pointer(vlistID);

  for ( varID = 0; varID < vlistptr->nvars; varID++ )
    {
      vlistptr->vars[varID].flag = FALSE;
      for ( levID = 0; levID < vlistptr->vars[varID].nlevs; levID++ )
Thomas Jahns's avatar
Thomas Jahns committed
387
388
389
        {
          vlistptr->vars[varID].levinfo[levID].flag = FALSE;
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
390
391
392
393
    }
}


394
int vlistInqZaxis(int vlistID, int zaxistype, int nlevels, double *levels, int lbounds, double *levels2,
Thomas Jahns's avatar
Thomas Jahns committed
395
                  int vctsize, const double *vct)
Uwe Schulzweida's avatar
Uwe Schulzweida committed
396
397
398
399
400
401
{
  int zaxisdefined;
  int nzaxis;
  int zaxisID = CDI_UNDEFID;
  int index;
  int zaxisglobdefined = 0;
402
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
403
404
405

  vlistptr = vlist_to_pointer(vlistID);

406
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
407
408
409
410
411
412
413
414

  zaxisdefined = 0;
  nzaxis = vlistptr->nzaxis;

  for ( index = 0; index < nzaxis; index++ )
    {
      zaxisID = vlistptr->zaxisIDs[index];

415
      if ( zaxisCompare(zaxisID, zaxistype, nlevels, lbounds, levels, NULL, NULL, 0) == 0 )
Thomas Jahns's avatar
Thomas Jahns committed
416
417
418
419
        {
          zaxisdefined = 1;
          break;
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
420
421
422
423
424
425
    }

  if ( ! zaxisdefined )
    {
      nzaxis = zaxisSize();
      for ( zaxisID = 0; zaxisID < nzaxis; zaxisID++ )
Thomas Jahns's avatar
Thomas Jahns committed
426
427
428
429
430
        if ( zaxisCompare(zaxisID, zaxistype, nlevels, lbounds, levels, NULL, NULL, 0) == 0 )
          {
            zaxisglobdefined = 1;
            break;
          }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
431
432
433
434
435
    }

  if ( ! zaxisdefined )
    {
      if ( ! zaxisglobdefined )
Thomas Jahns's avatar
Thomas Jahns committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
        {
          zaxisID = zaxisCreate(zaxistype, nlevels);
          zaxisDefLevels(zaxisID, levels);
          if ( lbounds )
            {
              zaxisDefLbounds(zaxisID, levels);
              zaxisDefUbounds(zaxisID, levels2);
            }

          if ( zaxistype == ZAXIS_HYBRID )
            {
              if ( vctsize > 0 )
                zaxisDefVct(zaxisID, vctsize, vct);
              else
                Warning("VCT missing");
            }
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467

      nzaxis = vlistptr->nzaxis;
      vlistptr->zaxisIDs[nzaxis] = zaxisID;
      vlistptr->nzaxis++;
    }

  return (zaxisID);
}

/*
@Function  vlistCopyFlag
@Title     Copy some entries of a variable list

@Prototype void vlistCopyFlag(int vlistID2, int vlistID1)
@Parameter
468
469
    @Item  vlistID2  Target variable list ID
    @Item  vlistID1  Source variable list ID
Uwe Schulzweida's avatar
Uwe Schulzweida committed
470
471

@Description
472
The function @func{vlistCopyFlag} copies all entries with a flag from vlistID1 to vlistID2.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
473
474
475
476
477

@EndFunction
*/
void vlistCopyFlag(int vlistID2, int vlistID1)
{
478
  vlist_t *vlistptr1, *vlistptr2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
479
480
481
482

  vlistptr1 = vlist_to_pointer(vlistID1);
  vlistptr2 = vlist_to_pointer(vlistID2);

483
484
  vlist_check_ptr(__func__, vlistptr1);
  vlist_check_ptr(__func__, vlistptr2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
485
486

  vlist_copy(vlistptr2, vlistptr1);
Thomas Jahns's avatar
Thomas Jahns committed
487

488
  vlistCopyVarAtts(vlistID1, CDI_GLOBAL, vlistID2, CDI_GLOBAL);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
489

Uwe Schulzweida's avatar
Uwe Schulzweida committed
490
491
492
493
494
495
496
497
498
499
500
501
  if ( vlistptr1->vars )
    {
      int nvars = vlistptr1->nvars;
      int nvars2 = 0, levID2;
      int nlevs, nlevs2, levID, varID, varID2;
      int gridID, zaxisID;
      int index;

      vlistptr2->ngrids = 0;
      vlistptr2->nzaxis = 0;

      for ( varID = 0; varID < nvars; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
502
        if ( vlistptr1->vars[varID].flag ) nvars2++;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
503
504

      vlistptr2->nvars = nvars2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
505
      if ( nvars2 > 0 )
Thomas Jahns's avatar
Thomas Jahns committed
506
        vlistptr2->vars  = (var_t *) malloc(nvars2*sizeof(var_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
507
      else
Thomas Jahns's avatar
Thomas Jahns committed
508
        vlistptr2->vars  = NULL;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
509
510
511

      varID2 = 0;
      for ( varID = 0; varID < nvars; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
        if ( vlistptr1->vars[varID].flag )
          {
            vlistptr2->vars[varID2].flag = FALSE;
            zaxisID = vlistptr1->vars[varID].zaxisID;
            gridID  = vlistptr1->vars[varID].gridID;

            memcpy(&vlistptr2->vars[varID2], &vlistptr1->vars[varID], sizeof(var_t));

            vlistptr1->vars[varID].fvarID = varID2;
            vlistptr2->vars[varID2].fvarID = varID;

            vlistptr2->vars[varID2].mvarID = varID2;

            if ( vlistptr1->vars[varID].name )
              vlistptr2->vars[varID2].name = strdupx(vlistptr1->vars[varID].name);

            if ( vlistptr1->vars[varID].longname )
              vlistptr2->vars[varID2].longname = strdupx(vlistptr1->vars[varID].longname);

            if ( vlistptr1->vars[varID].stdname )
              vlistptr2->vars[varID2].stdname = strdupx(vlistptr1->vars[varID].stdname);

            if ( vlistptr1->vars[varID].units )
              vlistptr2->vars[varID2].units = strdupx(vlistptr1->vars[varID].units);

            nlevs  = vlistptr1->vars[varID].nlevs;
            nlevs2 = 0;
            for ( levID = 0; levID < nlevs; levID++ )
              if ( vlistptr1->vars[varID].levinfo[levID].flag ) nlevs2++;

            vlistptr2->vars[varID2].levinfo = (levinfo_t *) malloc(nlevs2*sizeof(levinfo_t));

            vlistptr2->vars[varID2].atts.nelems = 0;
            vlistCopyVarAtts(vlistID1, varID, vlistID2, varID2);

            if ( nlevs != nlevs2 )
              {
                int zaxisType;
                int zaxisID2;
                int nvct = 0;
                int lbounds;
                double *levels;
                double *levels2;
                const double *vct = NULL;

                zaxisID = vlistptr1->vars[varID].zaxisID;
                levels = (double *) malloc(nlevs2*sizeof(double));
                levID2 = 0;
                for ( levID = 0; levID < nlevs; levID++ )
                  if ( vlistptr1->vars[varID].levinfo[levID].flag )
                    {
                      vlistptr1->vars[varID].levinfo[levID].flevelID = levID2;
                      vlistptr1->vars[varID].levinfo[levID].mlevelID = levID2;
                      levels[levID2++] = zaxisInqLevel(zaxisID, levID);
                    }

                zaxisType = zaxisInqType(zaxisID);

                if ( zaxisType == ZAXIS_HYBRID )
                  {
                    nvct = zaxisInqVctSize(zaxisID);
                    vct  = zaxisInqVctPtr(zaxisID);
                  }
                lbounds  = 0;     /* <------------ have to define */
                levels2  = NULL;  /* <------------ have to define */
                zaxisID2 = vlistInqZaxis(vlistID2, zaxisType, nlevs2, levels, lbounds, levels2, nvct, vct);
                free(levels);

                {
                  char ctemp[256];
                  zaxisInqName(zaxisID, ctemp);
                  zaxisDefName(zaxisID2, ctemp);
                  zaxisInqLongname(zaxisID, ctemp);
                  zaxisDefLongname(zaxisID2, ctemp);
                  zaxisInqUnits(zaxisID, ctemp);
                  zaxisDefUnits(zaxisID2, ctemp);
                }

                zaxisID = zaxisID2;
                vlistptr2->vars[varID2].zaxisID = zaxisID2;
                vlistptr2->vars[varID2].nlevs   = nlevs2;
              }

            for ( levID = 0; levID < nlevs2; levID++ )
              {
                vlistptr2->vars[varID2].levinfo[levID].flag  = FALSE;
                vlistptr2->vars[varID2].levinfo[levID].index = -1;
              }

            levID2 = 0;
            for ( levID = 0; levID < nlevs; levID++ )
              if ( vlistptr1->vars[varID].levinfo[levID].flag )
                {
                  vlistptr2->vars[varID2].levinfo[levID2].flevelID = levID;
                  vlistptr2->vars[varID2].levinfo[levID2].mlevelID = levID;
                  levID2++;
                }

            for ( index = 0; index <vlistptr2->ngrids; index++ )
              if (vlistptr2->gridIDs[index] == gridID ) break;

            if ( index == vlistptr2->ngrids )
              {
                vlistptr2->gridIDs[vlistptr2->ngrids++] = gridID;
                if (vlistptr2->ngrids >= MAX_GRIDS_PS )
                  Error("Internal Problem! More than %d grids.", MAX_GRIDS_PS);
              }

            for ( index = 0; index < vlistptr2->nzaxis; index++ )
              if ( vlistptr2->zaxisIDs[index] == zaxisID ) break;

            if ( index == vlistptr2->nzaxis )
              {
                vlistptr2->zaxisIDs[vlistptr2->nzaxis++] = zaxisID;
                if (vlistptr2->nzaxis >= MAX_ZAXES_PS )
                  Error("Internal Problem! More than %d zaxis.", MAX_ZAXES_PS);
              }

            varID2++;
          }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
632
633
634
635
636
637
638
639
640
    }
}

/*
@Function  vlistCat
@Title     Concatenate two variable lists

@Prototype void vlistCat(int vlistID2, int vlistID1)
@Parameter
641
642
    @Item  vlistID2  Target variable list ID
    @Item  vlistID1  Source variable list ID
Uwe Schulzweida's avatar
Uwe Schulzweida committed
643
644
645
646
647
648
649
650
651
652
653

@Description
Concatenate the variable list vlistID1 at the end of vlistID2.

@EndFunction
*/
void vlistCat(int vlistID2, int vlistID1)
{
  int nvars, nvars1, nvars2;
  int varID, varID2, nlevs;
  int index, gridID, zaxisID;
654
  vlist_t *vlistptr1, *vlistptr2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
655
656
657
658

  vlistptr1 = vlist_to_pointer(vlistID1);
  vlistptr2 = vlist_to_pointer(vlistID2);

659
660
  vlist_check_ptr(__func__, vlistptr1);
  vlist_check_ptr(__func__, vlistptr2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
661
662
663
664
665
666

  nvars1 = vlistptr1->nvars;
  nvars2 = vlistptr2->nvars;
  nvars = nvars1 + nvars2;
  vlistptr2->nvars = nvars;

Uwe Schulzweida's avatar
Uwe Schulzweida committed
667
668
  vlistptr2->vars = (var_t *) realloc(vlistptr2->vars, nvars*sizeof(var_t));
  memcpy(vlistptr2->vars+nvars2, vlistptr1->vars, nvars1*sizeof(var_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
669
670
671
672
673
674
675

  for ( varID = 0; varID < nvars1; varID++ )
    {
      varID2 = varID + nvars2;
      vlistptr1->vars[varID].fvarID = varID2;
      vlistptr2->vars[varID2].fvarID = varID;

676
677
678
      vlistptr1->vars[varID].mvarID = varID2;
      vlistptr2->vars[varID2].mvarID = varID;

679
      if ( vlistptr1->vars[varID].param < 0 )
Thomas Jahns's avatar
Thomas Jahns committed
680
681
682
683
684
685
        {
          int pnum, pcat, pdis;
          cdiDecodeParam(vlistptr1->vars[varID].param, &pnum, &pcat, &pdis);
          pnum=-(varID2+1);
          vlistptr2->vars[varID2].param = cdiEncodeParam(pnum, pcat, pdis);
        }
686

Uwe Schulzweida's avatar
Uwe Schulzweida committed
687
      if ( vlistptr1->vars[varID].name )
Thomas Jahns's avatar
Thomas Jahns committed
688
        vlistptr2->vars[varID2].name = strdupx(vlistptr1->vars[varID].name);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
689
690

      if ( vlistptr1->vars[varID].longname )
Thomas Jahns's avatar
Thomas Jahns committed
691
        vlistptr2->vars[varID2].longname = strdupx(vlistptr1->vars[varID].longname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
692
693

      if ( vlistptr1->vars[varID].stdname )
Thomas Jahns's avatar
Thomas Jahns committed
694
        vlistptr2->vars[varID2].stdname = strdupx(vlistptr1->vars[varID].stdname);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
695
696

      if ( vlistptr1->vars[varID].units )
Thomas Jahns's avatar
Thomas Jahns committed
697
        vlistptr2->vars[varID2].units = strdupx(vlistptr1->vars[varID].units);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
698
699

      nlevs = vlistptr1->vars[varID].nlevs;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
700
701
      vlistptr2->vars[varID2].levinfo = (levinfo_t *) malloc(nlevs*sizeof(levinfo_t));
      memcpy(vlistptr2->vars[varID2].levinfo, vlistptr1->vars[varID].levinfo, nlevs*sizeof(levinfo_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
702

703
704
705
      vlistptr2->vars[varID2].atts.nelems = 0;
      vlistCopyVarAtts(vlistID1, varID, vlistID2, varID2);

Uwe Schulzweida's avatar
Uwe Schulzweida committed
706
707
      gridID = vlistptr1->vars[varID].gridID;
      for ( index = 0; index < vlistptr2->ngrids; index++ )
Thomas Jahns's avatar
Thomas Jahns committed
708
        if ( gridID == vlistptr2->gridIDs[index] ) break;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
709
710

      if ( index == vlistptr2->ngrids )
Thomas Jahns's avatar
Thomas Jahns committed
711
712
713
714
715
        {
          vlistptr2->gridIDs[vlistptr2->ngrids++] = gridID;
          if ( vlistptr2->ngrids >= MAX_GRIDS_PS )
            Error("Internal Problem! More than %d grids.", MAX_GRIDS_PS);
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
716
717
718

      zaxisID = vlistptr1->vars[varID].zaxisID;
      for ( index = 0; index < vlistptr2->nzaxis; index++ )
Thomas Jahns's avatar
Thomas Jahns committed
719
        if ( zaxisID == vlistptr2->zaxisIDs[index] ) break;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
720
721

      if ( index == vlistptr2->nzaxis )
Thomas Jahns's avatar
Thomas Jahns committed
722
723
724
725
726
        {
          vlistptr2->zaxisIDs[vlistptr2->nzaxis++] = zaxisID;
          if ( vlistptr2->nzaxis >= MAX_ZAXES_PS )
            Error("Internal Problem! More than %d zaxis.", MAX_ZAXES_PS);
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
727
728
729
730
731
732
733
734
735
    }
}

/*
@Function  vlistMerge
@Title     Merge two variable lists

@Prototype void vlistMerge(int vlistID2, int vlistID1)
@Parameter
736
737
    @Item  vlistID2  Target variable list ID
    @Item  vlistID1  Source variable list ID
Uwe Schulzweida's avatar
Uwe Schulzweida committed
738
739

@Description
Uwe Schulzweida's avatar
Uwe Schulzweida committed
740
Merge the variable list vlistID1 to the variable list vlistID2.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
741
742
743
744
745
746
747
748
749
750
751

@EndFunction
*/
void vlistMerge(int vlistID2, int vlistID1)
{
  int nvars1, nvars2;
  int varID = 0, varID2, levID, nlevs, nlevs1, nlevs2;
  int index, zaxisID;
  int zaxisID1, zaxisID2;
  int *lvar;
  double *levels;
752
  vlist_t *vlistptr1, *vlistptr2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
753
754
755
756

  vlistptr1 = vlist_to_pointer(vlistID1);
  vlistptr2 = vlist_to_pointer(vlistID2);

757
758
  vlist_check_ptr(__func__, vlistptr1);
  vlist_check_ptr(__func__, vlistptr2);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
759
760
761
762
763
764
765

  nvars1 = vlistptr1->nvars;
  nvars2 = vlistptr2->nvars;

  if ( nvars1 == nvars2 )
    {
      for ( varID = 0; varID < nvars2; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
766
767
768
769
770
771
772
773
774
775
776
777
        {
          if ( vlistptr1->vars[varID].name && vlistptr2->vars[varID].name )
            {
              if ( strcmp(vlistptr1->vars[varID].name,
                          vlistptr2->vars[varID].name) != 0 ) break;
            }
          else
            {
              if ( vlistptr1->vars[varID].param != vlistptr2->vars[varID].param )
                break;
            }
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
778
779
780
781
782
    }

  if ( varID == nvars2 ) /* same variables in vlistID1 and vlistID2 */
    {
      for ( varID = 0; varID < nvars2; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
783
784
785
        {
          vlistptr1->vars[varID].fvarID = varID;
          vlistptr2->vars[varID].fvarID = varID;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
786

Thomas Jahns's avatar
Thomas Jahns committed
787
788
          vlistptr1->vars[varID].mvarID = varID;
          vlistptr2->vars[varID].mvarID = varID;
789

Thomas Jahns's avatar
Thomas Jahns committed
790
791
          nlevs1 = vlistptr1->vars[varID].nlevs;
          nlevs2 = vlistptr2->vars[varID].nlevs;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
792

Thomas Jahns's avatar
Thomas Jahns committed
793
          nlevs = nlevs1 + nlevs2;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
794

Thomas Jahns's avatar
Thomas Jahns committed
795
796
797
798
799
800
          vlistptr2->vars[varID].nlevs = nlevs;
          /*
          fprintf(stderr, "var %d %d %d %d %d\n", varID, nlevs1, nlevs2, nlevs, sizeof(levinfo_t));
          */
          vlistptr2->vars[varID].levinfo =
            (levinfo_t *) realloc(vlistptr2->vars[varID].levinfo, nlevs*sizeof(levinfo_t));
Uwe Schulzweida's avatar
Uwe Schulzweida committed
801

Thomas Jahns's avatar
Thomas Jahns committed
802
803
          memcpy(vlistptr2->vars[varID].levinfo+nlevs2,
                 vlistptr1->vars[varID].levinfo, nlevs1*sizeof(levinfo_t));
804

Thomas Jahns's avatar
Thomas Jahns committed
805
806
807
808
809
          for ( levID = 0; levID < nlevs1; levID++ )
            {
              vlistptr1->vars[varID].levinfo[levID].mlevelID = nlevs2 + levID;
            }
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
810
811
812
813
814

      lvar = (int *) malloc(nvars2*sizeof(int));
      for ( varID = 0; varID < nvars2; varID++ ) lvar[varID] = FALSE;

      for ( varID = 0; varID < nvars2; varID++ )
Thomas Jahns's avatar
Thomas Jahns committed
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
        {
          if ( lvar[varID] == TRUE ) continue;

          zaxisID1 = vlistptr1->vars[varID].zaxisID;
          zaxisID2 = vlistptr2->vars[varID].zaxisID;
          /*
          nlevs1 = vlistptr1->vars[varID].nlevs;
          nlevs2 = vlistptr2->vars[varID].nlevs;
          */
          nlevs1 = zaxisInqSize(zaxisID1);
          nlevs2 = zaxisInqSize(zaxisID2);
          /*
          fprintf(stderr, "zaxis %d %d %d %d\n", zaxisID1, zaxisID2, nlevs1, nlevs2);
          */
          nlevs = nlevs1 + nlevs2;

          zaxisID = zaxisDuplicate(zaxisID2);

          zaxisResize(zaxisID, nlevs);

          levels = (double *) malloc(nlevs1*sizeof(double));

          zaxisInqLevels(zaxisID1, levels);
          /*
          for ( levID = 0; levID < nlevs1; levID++ )
            fprintf(stderr, "%d %d %d %d %d %g\n", varID, levID, nlevs1, nlevs2, vlistptr2->vars[varID].nlevs, levels[levID]);
          */
          for ( levID = 0; levID < nlevs1; levID++ )
            zaxisDefLevel(zaxisID, nlevs2+levID, levels[levID]);

          free(levels);

          for ( index = 0; index < vlistptr2->nzaxis; index++ )
            if ( vlistptr2->zaxisIDs[index] == zaxisID2 )
              vlistptr2->zaxisIDs[index] = zaxisID;

          for ( varID2 = 0; varID2 < nvars2; varID2++ )
            if ( lvar[varID2] == FALSE && vlistptr2->vars[varID2].zaxisID == zaxisID2 )
              {
                vlistptr2->vars[varID2].zaxisID = zaxisID;
                lvar[varID2] = TRUE;
              }
        }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872

      free(lvar);
    }
  else
    {
      vlistCat(vlistID2, vlistID1);
    }
}

/*
@Function  vlistNvars
@Title     Number of variables in a variable list

@Prototype int vlistNvars(int vlistID)
@Parameter
873
    @Item  vlistID  Variable list ID, from a previous call to @fref{vlistCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
874
875

@Description
876
The function @func{vlistNvars} returns the number of variables in the variable list vlistID.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
877
878

@Result
879
@func{vlistNvars} returns the number of variables in a variable list.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
880
881
882
883
884

@EndFunction
*/
int vlistNvars(int vlistID)
{
885
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
886
887
888

  vlistptr = vlist_to_pointer(vlistID);

889
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
890
891
892
893

  return (vlistptr->nvars);
}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
894

Uwe Schulzweida's avatar
Uwe Schulzweida committed
895
896
897
int vlistNrecs(int vlistID)
{
  int varID, nrecs = 0;
898
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
899
900
901

  vlistptr = vlist_to_pointer(vlistID);

902
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
903
904
905
906
907
908
909
910

  for ( varID = 0; varID < vlistptr->nvars; varID++ )
    nrecs +=  vlistptr->vars[varID].nlevs;

  return (nrecs);
}


Uwe Schulzweida's avatar
Uwe Schulzweida committed
911
912
int vlistNumber(int vlistID)
{
913
  int varID, number, number2, datatype;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
914
915
916
917
  vlist_t *vlistptr;

  vlistptr = vlist_to_pointer(vlistID);

918
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
919

920
921
922
923
924
925
  datatype = vlistptr->vars[0].datatype;
  if (  datatype== DATATYPE_CPX32 || datatype == DATATYPE_CPX64 )
    number = CDI_COMP;
  else
    number = CDI_REAL;

Uwe Schulzweida's avatar
Uwe Schulzweida committed
926
  for ( varID = 1; varID < vlistptr->nvars; varID++ )
927
928
929
    {
      datatype = vlistptr->vars[varID].datatype;
      if ( datatype == DATATYPE_CPX32 || datatype == DATATYPE_CPX64 )
Thomas Jahns's avatar
Thomas Jahns committed
930
        number2 = CDI_COMP;
931
      else
Thomas Jahns's avatar
Thomas Jahns committed
932
        number2 = CDI_REAL;
933
934

      if ( number2 != number )
Thomas Jahns's avatar
Thomas Jahns committed
935
936
937
938
        {
          number = CDI_BOTH;
          break;
        }
939
    }
Uwe Schulzweida's avatar
Uwe Schulzweida committed
940
941
942
943

  return (number);
}

Uwe Schulzweida's avatar
Uwe Schulzweida committed
944
945
946
947
948
949
/*
@Function  vlistNgrids
@Title     Number of grids in a variable list

@Prototype int vlistNgrids(int vlistID)
@Parameter
950
    @Item  vlistID  Variable list ID, from a previous call to @fref{vlistCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
951
952

@Description
953
The function @func{vlistNgrids} returns the number of grids in the variable list vlistID.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
954
955

@Result
956
@func{vlistNgrids} returns the number of grids in a variable list.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
957
958
959
960
961

@EndFunction
*/
int vlistNgrids(int vlistID)
{
962
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
963
964
965

  vlistptr = vlist_to_pointer(vlistID);

966
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
967
968
969
970
971
972
973
974
975
976

  return (vlistptr->ngrids);
}

/*
@Function  vlistNzaxis
@Title     Number of zaxis in a variable list

@Prototype int vlistNzaxis(int vlistID)
@Parameter
977
    @Item  vlistID  Variable list ID, from a previous call to @fref{vlistCreate}
Uwe Schulzweida's avatar
Uwe Schulzweida committed
978
979

@Description
980
The function @func{vlistNzaxis} returns the number of zaxis in the variable list vlistID.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
981
982

@Result
983
@func{vlistNzaxis} returns the number of zaxis in a variable list.
Uwe Schulzweida's avatar
Uwe Schulzweida committed
984
985
986
987
988

@EndFunction
*/
int vlistNzaxis(int vlistID)
{
989
  vlist_t *vlistptr;
Uwe Schulzweida's avatar
Uwe Schulzweida committed
990
991
992

  vlistptr = vlist_to_pointer(vlistID);

993
  vlist_check_ptr(__func__, vlistptr);
Uwe Schulzweida's avatar
Uwe Schulzweida committed
994
995
996
997
998
999
1000

  return (vlistptr->nzaxis);
}


void vlistDefNtsteps(int vlistID, int nts)
{
For faster browsing, not all history is shown. View entire blame