-
Notifications
You must be signed in to change notification settings - Fork 1
/
lats.c
1178 lines (1010 loc) · 35.9 KB
/
lats.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
298
299
300
301
302
303
304
305
306
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
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
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
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
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
803
804
805
806
807
808
809
810
811
812
813
814
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
858
859
860
861
862
863
864
865
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
/* -*-Mode: C;-*-
* Module: LATS user API
*
* Copyright: 1996, Regents of the University of California
* This software may not be distributed to others without
* permission of the author.
*
* Author: Bob Drach, Lawrence Livermore National Laboratory
*
* Version: $Id: lats.c,v 1.3 1997/02/14 20:11:52 fiorino Exp fiorino $
*
* Revision History:
*
* $Log: lats.c,v $
* Revision 1.4 2015/06/17 jfpainter
* stop truncating time when time frequency (hence units) are large.
* Revision 1.3 1997/02/14 20:11:52 fiorino
* before latsmode change
*
* Revision 1.2 1997/01/17 00:38:03 fiorino
* with latsTimeCmp bug diagnostics
*
* Revision 1.1 1997/01/03 00:30:15 fiorino
* Initial revision
*
* Revision 1.16 1996/12/18 22:06:20 fiorino
* initialize fltpnt in gagmap.c to cover c90 compiler problem
* added support for climatological and 365-day calendars in GrADS
*
* Revision 1.15 1996/11/11 22:39:18 drach
* - Added function to set the basetime (lats_basetime)
*
* Revision 1.14 1996/10/22 19:05:02 fiorino
* latsgrib bug in .ctl creator
*
* Revision 1.13 1996/10/21 17:20:15 drach
* - Fixed LATS_MONTHLY_TABLE_COMP option
*
* Revision 1.12 1996/10/10 23:15:43 drach
* - lats_create filetype changed to convention, with options LATS_PCMDI,
* LATS_GRADS_GRIB, and LATS_COARDS.
* - monthly data defaults to 16-bit compression
* - LATS_MONTHLY_TABLE_COMP option added to override 16-bit compression
* - AMIP II standard parameter file
* - parameter file incorporates GRIB center and subcenter
* - if time delta is positive, check that (new_time - old_time)=integer*delta
*
* Revision 1.11 1996/08/27 19:40:21 drach
* - Corrected generation of basetime string for climatologies
*
* Revision 1.10 1996/08/20 18:34:06 drach
* - lats_create has a new argument: calendar
* - lats_grid: longitude, latitude dimension vectors are now double
* precision (double, C).
* - lats_vert_dim: vector of levels is now double precision (double,
* C). lats_vert_dim need not be called for single-value/surface
* dimensions, if defined in the parameter table. Multi-valued vertical
* dimensions, such as pressure levels, must be defined with
* lats_vert_dim.
* - lats_var: set level ID to 0 for implicitly defined surface
* dimension.
* - lats_write: level value is double precision (double, C).
* - lats_parmtab: replaces routine lats_vartab.
* - FORTRAN latserropt added: allows program to set error handling
* options.
* - The parameter file format changed.
*
* Revision 1.9 1996/07/12 00:36:25 drach
* - (GRIB) use undefined flag only when set via lats_miss_XX
* - (GRIB) use delta when checking for missing data
* - (GRIB) define maximum and default precision
* - fixed lats_vartab to work correctly.
* - Added report of routine names, vertical dimension types
*
* Revision 1.8 1996/06/27 01:07:02 drach
* - Added QC weights calculation
*
* Revision 1.7 1996/05/25 00:27:47 drach
* - Added tables for vertical dimension types, time statistics, originating
* centers, and quality control marks
* - Modified signatures of lats_create and lats_vert_dim
*
* Revision 1.6 1996/05/11 00:08:01 fiorino
* - Added COARDS compliance
*
* Revision 1.5 1996/05/10 22:44:38 drach
* - Initial version before GRIB driver added:
* - Made grids, vertical dimensions file-independent
*
* Revision 1.4 1996/05/04 01:11:09 drach
* - Added name, units to lats_vert_dim
* - Added missing data attribute (latsnc.c)
*
* Revision 1.3 1996/05/03 18:59:23 drach
* - Moved vertical dimension definition from lats_var to lats_vert_dim
* - Changed lats_miss_double to lats_miss_float
* - Made time dimension file-dependent, revised lats_write accordingly
* - Added lats_var_nc, lats_vert_dim_nc
* - Allow GRIB-only compilation
* - Added FORTRAN interface
*
* Revision 1.2 1996/04/25 23:32:03 drach
* - Added checks for correct number of times, levels written
* - Stubbed in statistics routines
*
* Revision 1.1 1996/04/25 00:52:59 drach
* Initial repository version
*
*
*/
#define _POSIX_SOURCE 1
#define MAX(a,b) ((a)>(b)?(a):(b))
#include <stdlib.h>
#include <math.h>
#include <stdio.h>
#include <malloc.h>
#include <string.h>
#include "latsint.h"
#include "latstime.h"
char *_lats_routine_name_ = (char *)0;
static int latsParmTableCreated = 0; /* 1 iff parameter table has been created */
/* Set the basetime for file 'fileid' Return 1 on success, 0 on failure */
int lats_basetime(int fileid, int year, int month, int day, int hour) {
latsFile *file;
latsCompTime time;
_lats_routine_name_ = "lats_basetime";
if((file = latsFileLookup(fileid))==0) {
return 0;
}
if(file->latsmode != LATS_MODE_DEFINE && file->ntimewritten > 0){
latsError("LATS (lats.c) --> lats_basetime calls must precede any lats_write call");
return 0;
}
/*mf---
check if climo field for GRIB options
set year to 2 it will be overwritten in latsgrib.c by GRADS_CLIM_YEAR
---mf*/
if(!(file->calendar & cdStandardCal) &&
file->type == LATS_GRIB &&
file->frequency != LATS_FIXED) {
year=2;
}
/* Check that basetime not set yet */
if(file->basetimeset==1) {
latsError("LATS (lats.c) --> Basetime must be set at most once before any data is written, file %s", file->path);
return 0;
}
/* Check valid time */
if(month<1 || month>12){
latsError("LATS (lats.c) --> Invalid month: %d, file %s", month, file->path);
return 0;
}
/*mf 970121 --- year 0 not supported ---mf*/
if(file->frequency != LATS_FIXED) {
if(year <= 0) {
latsError("LATS (lats.c) --> Invalid year: %d, file %s year <0 NOT Supported", year, file->path);
return 0;
}
} else {
/*mf --- set year to 1 for fixed data --- mf*/
year=1;
}
if(day<1 || day>31){
latsError("LATS (lats.c) --> Invalid day: %d, file %s",day, file->path);
return 0;
}
if(hour<0 || hour>23){
latsError("LATS (lats.c) --> Invalid hour: %d, file %s",hour, file->path);
return 0;
}
time.year = year;
time.month = month;
time.day = day;
time.hour = (double)hour;
file->btime.year = year;
file->btime.month = month;
file->btime.day = day;
file->time.hour = (double)hour;
/* Generate base time */
/* Non-climatology base time */
if(file->calendar & cdStandardCal){
sprintf(file->latstimeunits,"%s since %d-%d-%d %d",
(file->frequency == LATS_YEARLY ? "years" :
file->frequency == LATS_MONTHLY ? "months" :
file->frequency == LATS_WEEKLY ? "days" :
file->frequency == LATS_DAILY ? "days" : "hours"),
time.year, time.month, time.day, hour);
}
/* Climatology base time */
else {
sprintf(file->latstimeunits,"%s since %d-%d %d",
(file->frequency == LATS_MONTHLY ? "months" :
file->frequency == LATS_WEEKLY ? "days" :
file->frequency == LATS_DAILY ? "days" : "hours"),
time.month, time.day, hour);
}
strncpy(file->timeunits, file->latstimeunits, LATS_MAX_RELUNITS); file->timeunits[LATS_MAX_RELUNITS-1]='\0';
if(file->convention == LATS_COARDS && file->frequency == LATS_MONTHLY){
sprintf(file->timeunits, "days since %d-%d-%d %d",
time.year, time.month, time.day, hour);
}
file->basetimeset = 1;
return 1; /* Success */
}
/* Close file with ID 'fileid'. Return 1 on success, 0 on failure. */
int lats_close(int fileid) {
latsFile *file;
int ierr;
double timevalue;
cdCompTime lasttime;
_lats_routine_name_ = "lats_close";
if((file = latsFileLookup(fileid))==0)
return 0;
/* Number of time increments for GrADS control file */
file->ndelta = file->ntimewritten;
/* Calculate global statistics */
latsStatFile(file);
ierr = (file->type == LATS_GRIB ? lats_close_grib(file) : lats_close_nc(file));
if(latsFileDeleteEntry(fileid)==0)
return 0;
return ierr;
}
/* Create file with pathname 'path'. Return file ID on success, 0 on failure. */
int lats_create(char* path, int convention, int calendar, int frequency, int delta, char* center, char* model, char* comments) {
latsFile *file;
char *defaultParmFile;
latsCenter *cent;
char tempname[LATS_MAX_COMMENTS];
char tmppath[LATS_MAX_PATH];
char *extension;
latsCompressionType compressiontype;
latsFileType filetype;
_lats_routine_name_ = "lats_create";
/* Validity checks */
if(convention != LATS_PCMDI &&
convention != LATS_GRADS_GRIB &&
convention != LATS_GRIB_ONLY &&
convention != LATS_COARDS){
latsError("LATS (lats.c) --> Invalid file convention: %d", convention);
return 0;
}
if(frequency != LATS_YEARLY &&
frequency != LATS_MONTHLY &&
frequency != LATS_WEEKLY &&
frequency != LATS_DAILY &&
frequency != LATS_HOURLY &&
frequency != LATS_FORECAST_HOURLY &&
frequency != LATS_FIXED &&
frequency != LATS_MONTHLY_TABLE_COMP){
latsError("LATS (lats.c) --> Invalid frequency: %d", frequency);
return 0;
}
if(calendar != LATS_STANDARD &&
calendar != LATS_JULIAN &&
calendar != LATS_NOLEAP &&
calendar != LATS_360 &&
calendar != LATS_CLIM &&
calendar != LATS_CLIMLEAP &&
calendar != LATS_CLIM360){
latsError("LATS (lats.c) --> Invalid calendar: %d", calendar);
return 0;
}
if(convention == LATS_COARDS && calendar != LATS_STANDARD){
latsError("LATS (lats.c) --> COARDS data must be written with the standard Gregorian calendar, file %s", path);
return 0;
}
if( (convention == LATS_GRADS_GRIB || convention == LATS_GRIB_ONLY)
&& !(calendar == LATS_STANDARD
|| calendar == LATS_NOLEAP
|| calendar == LATS_CLIM
|| calendar == LATS_CLIMLEAP ) )
{
latsError("LATS (lats.c) --> GRADS/GRIB data must be written with: 1) the standard Gregorian; 2) 365 day ; or 3) climatology calendar , file %s", path);
return 0;
}
if( (frequency == LATS_FORECAST_HOURLY) && !(calendar == LATS_STANDARD) ) {
latsError("LATS (lats.c) --> Forecast hourly data must written with the standard Gregorian calendar (LATS_STANDARD), file %s", path);
return 0;
}
if(convention == LATS_GRADS_GRIB && delta <= 0){
latsError("LATS (lats.c) --> GRADS_GRIB data must be written with nonzero delta, file %s", path);
return 0;
}
/* Map weekly data to daily */
if(frequency == LATS_WEEKLY){
frequency = LATS_DAILY;
delta *= 7;
}
/* Set the file type */
switch(convention){
case LATS_PCMDI:
case LATS_COARDS:
filetype = LATS_NETCDF;
break;
case LATS_GRADS_GRIB:
filetype = LATS_GRIB;
break;
case LATS_GRIB_ONLY:
filetype = LATS_GRIB;
break;
}
/* Override parameter table compression values for monthly data */
compressiontype = (frequency == LATS_MONTHLY ? LATS_FIXED_COMP : LATS_TABLE_COMP);
if (frequency == LATS_MONTHLY_TABLE_COMP) frequency = LATS_MONTHLY;
/* Set the correct file extension */
latsCpyTrim(tmppath, path, LATS_MAX_PATH-4);
extension = (filetype==LATS_NETCDF ? ".nc" : ".grb");
if(strcmp(extension, tmppath + MAX(0,strlen(tmppath)-strlen(extension))) != 0)
strcat(tmppath,extension);
/* Create file entry, add to file list */
if((file = latsFileAddEntry(tmppath)) == 0)
return 0;
/* Create the parameter table, if necessary */
if(latsParmTableCreated == 0){
if((defaultParmFile = getenv("LATS_PARMS")) == NULL) {
if(latsParmCreateDefaultTable()==0)
return 0;
}
else {
if(latsParmCreateTable(defaultParmFile)==0)
return 0;
}
latsParmTableCreated = 1;
}
/* Lookup center for GRIB */
if(filetype == LATS_GRIB){
latsCpyLower(tempname, center, LATS_MAX_COMMENTS);
if((cent = latsCenterLookup(tempname))==0){
latsError("LATS (lats.c) --> Center not found in center table: %s, file %s", tempname, tmppath);
return 0;
}
file->centerid = cent->gribid;
file->grib_center = cent->grib_center;
file->grib_subcenter = cent->grib_subcenter;
}
else
file->centerid = file->grib_center = file->grib_subcenter = -1;
file->type = filetype;
file->calendar = calendar;
file->frequency = frequency;
file->delta = delta;
file->convention = convention;
file->compressiontype = compressiontype;
strncpy(file->center, center, LATS_MAX_COMMENTS); file->center[LATS_MAX_COMMENTS-1]='\0';
strncpy(file->model, model, LATS_MAX_COMMENTS); file->model[LATS_MAX_COMMENTS-1]='\0';
strncpy(file->comments, comments, LATS_MAX_COMMENTS); file->comments[LATS_MAX_COMMENTS-1]='\0';
/*mf set latsmode to DEFINE mf*/
file->latsmode = LATS_MODE_DEFINE;
return (filetype == LATS_GRIB ? lats_create_grib(file) : lats_create_nc(file));
}
/* Set the error options. `erropt' is a logical
combination of flags LATS_EXIT_ON_ERROR and
LATS_REPORT_ERROR. */
void lats_erropt(int erropt){
lats_fatal = (erropt & LATS_EXIT_ON_ERROR);
lats_verbose = (erropt & LATS_REPORT_ERRORS);
}
#define LATS_TORAD (3.14159265359/180.0) /* Degrees to radians */
/* Define a grid. The longitude vector 'lons' */
/* has length 'nlon', latitude vector 'lats' has length 'nlat'. Return 1 on success, */
/* 0 on failure. */
int lats_grid(char *name, int gridtype, int nlon, double lons[], int nlat, double lats[]) {
latsFile *file;
latsGrid *grid;
latsMonotonicity monolon, monolat;
int i, j;
double *tlon, *plat;
_lats_routine_name_ = "lats_grid";
/* Validity checks */
if(gridtype != LATS_GAUSSIAN &&
gridtype != LATS_LINEAR &&
gridtype != LATS_GENERIC){
latsError("LATS (lats.c) --> Invalid grid type: %d, grid %s", gridtype, name);
return 0;
}
if(nlon <= 0 || nlat <= 0){
latsError("LATS (lats.c) --> Number of longitudes: %d, and number of latitudes: %d must be positive, grid %s",
nlon, nlat, name);
return 0;
}
if((monolon=latsCheckMono(nlon, lons))==0 || (monolat=latsCheckMono(nlat, lats))==0){
latsError("LATS (lats.c) --> Longitude and latitude vectors must be monotonic, grid %s",
name);
return 0;
}
if(fabs((double)(lons[nlon-1]-lons[0])) >= 360.0){
latsError("LATS (lats.c) --> Longitude vector must not wrap around, grid %s", name);
return 0;
}
if(fabs((double)(lats[nlat-1]))>90.0 || fabs((double)lats[0])>90.0){
latsError("LATS (lats.c) --> Latitude values must be in the range -90 to 90");
return 0;
}
if((grid = latsGridAddEntry(name)) == 0)
return 0;
/* Create the grid */
latsCpyTrim(grid->name, name, LATS_MAX_NAME);
grid->type = gridtype;
if((grid->lats = (double *)malloc(nlat*sizeof(double)))==NULL){
latsError("LATS (lats.c) --> Allocating latitude vector memory, nlat=%d",nlat);
return 0;
}
grid->nlat = nlat;
memcpy(grid->lats, lats, nlat*sizeof(double));
if((grid->lons = (double *)malloc(nlon*sizeof(double)))==NULL){
latsError("LATS (lats.c) --> Allocating longitude vector memory, nlon=%d",nlon);
return 0;
}
grid->nlon = nlon;
memcpy(grid->lons, lons, nlon*sizeof(double));
/* Calculate longitude weights */
if(((grid->wlons = (double *)malloc(nlon*sizeof(double)))==NULL) ||
((tlon = (double *)malloc(nlon*sizeof(double)))==NULL)){
latsError("LATS (lats.c) --> Allocating longitude weight vector, nlon=%d",nlon);
return 0;
}
tlon[0] = (lons[0] + lons[nlon-1] + 360.0)/2.0;
for(i=1; i<nlon; i++){
tlon[i] = (lons[i-1] + lons[i])/2.0;
}
if(monolon == LATS_INCREASING){
grid->wlons[0] = tlon[1]-tlon[0]+360.0;
for(i=1; i<nlon-1; i++){
grid->wlons[i] = tlon[i+1]-tlon[i];
}
grid->wlons[nlon-1] = tlon[0] - tlon[nlon-1];
}
else {
grid->wlons[0] = tlon[0]-tlon[1];
for(i=1; i<nlon-1; i++){
grid->wlons[i] = tlon[i]-tlon[i+1];
}
grid->wlons[nlon-1] = tlon[nlon-1]-tlon[0]+360.0;
}
/* Calculate latitude weights */
if(((grid->wlats = (double *)malloc(nlat*sizeof(double)))==NULL) ||
((plat = (double *)malloc((nlat+1)*sizeof(double)))==NULL)){
latsError("LATS (lats.c) --> Allocating latitude weight vector, nlat=%d",nlat);
return 0;
}
plat[0] = (monolat==LATS_INCREASING ? -90.0 : 90.0);
for(j=1; j<nlat; j++){
plat[j] = (lats[j-1] + lats[j])/2.0;
}
plat[nlat] = (monolat==LATS_INCREASING ? 90.0 : -90.0);
for(j=0; j<nlat; j++){
grid->wlats[j] = fabs(sin(LATS_TORAD*(double)plat[j+1]) - sin(LATS_TORAD*(double)plat[j]));
}
free(tlon);
free(plat);
return grid->id;
}
/* Set the quality control:
qcopt = LATS_QC_ON iff turn on quality control calculations
qcopt = 0 iff turn off QC calcs */
void lats_qcopt(qcopt){
lats_qc = (qcopt & LATS_QC_ON);
}
/* Define a variable to be written to file with ID 'fileid'. */
/* 'gridid' is the grid identifier, 'levid' is the vertical dimension identifier. */
/* Return the variable ID on success, 0 on failure. */
int lats_var(int fileid, char* varname, int datatype, int timestat, int gridid, int levid, char* comments) {
latsFile *file;
latsVar *var;
latsVertDim *vertdim;
latsParm *parm;
latsParmQC *qc;
latsGrid *grid;
latsTimeStatEntry *stat;
double levdelta, delta, *levvalue;
int i, nlev, nprev, ierr;
size_t qcalloc;
_lats_routine_name_ = "lats_var";
/* Lookup the parameter */
if((parm = latsParmLookup(varname))==0){
latsError("LATS (lats.c) --> Variable %s: not in the variable table, file ID %d", varname, fileid);
return 0;
}
/* Validity checks */
if(datatype != LATS_FLOAT &&
datatype != LATS_INT){
latsError("LATS (lats.c) --> Datatype: %d, must be LATS_FLOAT or LATS_INT, file %d, var %s",
datatype, fileid, varname);
return 0;
}
if(datatype != parm->datatype){
latsError("LATS (lats.c) --> Variable %s, file ID %d: datatype %s does not match predefined datatype",
varname, fileid, (datatype == LATS_FLOAT ? "LATS_FLOAT" : "LATS_INT"));
return 0;
}
if(parm->id>255 | parm->id<1) {
latsError("LATS (lats.c) --> Variable %s, file ID %d: GRIB parameter id %d is invalid, must be >1 and < 255",
fileid, parm->id);
return 0;
}
/* Create the variable */
if((var = latsVarAddEntry(fileid, varname))==0)
return 0;
file = var->file;
/* mode check */
if(file->latsmode != LATS_MODE_DEFINE){
latsError("LATS (lats.c) --> lats_var calls MUST PRECEDE ANY lats_write call");
return 0;
}
if(file->frequency != LATS_FIXED &&
timestat != LATS_AVERAGE &&
timestat != LATS_INSTANT &&
timestat != LATS_ACCUM &&
timestat != LATS_OTHER_TIME_STAT){
latsError("LATS (lats.c) --> Time statistic: %d must be LATS_AVERAGE, LATS_INSTANT, or LATS_ACCUM, file %d, var %s",
timestat, fileid, varname);
return 0;
}
/* Lookup the time statistic for non-fixed variables */
/*mf ----
961212
bug fix -- LATS_FIXED now handled properly
if(file->type == LATS_GRIB && file->frequency != LATS_FIXED &&
---mf*/
if(file->type == LATS_GRIB &&
(stat = latsTimeStatLookup(file->frequency, file->delta, timestat))==0){
latsError("LATS (lats.c) --> Time statistic not defined: frequency = %s, delta = %d, timestat = %s, for variable %s",
(file->frequency == LATS_YEARLY ? "year" :
file->frequency == LATS_MONTHLY ? "month" :
file->frequency == LATS_WEEKLY ? "week" :
file->frequency == LATS_DAILY ? "day" : "hour"),
file->delta,
(timestat == LATS_AVERAGE ? "average" :
timestat == LATS_INSTANT ? "instant" :
timestat == LATS_ACCUM ? "accum" : "other"),
varname);
return 0;
}
/* Check level ID */
if(levid == 0) {
vertdim = (latsVertDim *)0;
nlev = 0;
levdelta = 1.0e20;
}
else if(levid>0) {
nprev = file->nvertdim;
if((vertdim = latsFileVertLookup(file, levid))==0){
latsError("LATS (lats.c) --> Vertical dimension not found, ID: %d, file %s, variable %s",
levid, file->path, var->name);
return 0;
}
/* If the lookup added the vertical dimension to */
/* the file vertlist, create it in the file. */
/*mf 970822
abort if trying to use more than one vertical dimension for GrADS_GRIB
mf*/
if(file->convention == LATS_GRADS_GRIB && file->nvertdim > 1) {
latsError("LATS (lats.c) --> For LATS_GRADS_GRIB convention,\nvertdim can only be called once; define a vertical dimension that includes all levels\nVertical Dim ID: %d, file %s, variable %s",levid, file->path, var->name);
return 0;
}
if(nprev<file->nvertdim &&
(file->type == LATS_GRIB ? lats_vert_dim_grib(file, vertdim) :
lats_vert_dim_nc(file, vertdim))==0)
return 0;
nlev = vertdim->nlev;
levdelta = vertdim->delta;
/* Warning if changing the default surface type*/
if(parm->levelset==1 && strcmp(vertdim->type->name,parm->verttype->name)){
latsWarning("Overriding default level type %s, for variable %s",
parm->verttype->name, varname);
}
}
else {
latsError("LATS (lats.c) --> Level dimension: %d, invalid, variable %s, file %s",
levid, varname, file->path);
return 0;
}
/* levs must be monotonic */
if(parm->levelset == 1 && nlev > 1){
latsError("LATS (lats.c) --> Variable %s, file ID %d: number of levels: %d, must be 0 or 1 for single-level (surface) variable",varname, fileid, nlev);
return 0;
}
/*
if(vertdim && strcmp(parm->levunits,vertdim->units)!=0){
latsError("Defined level units (%s), differs from prescribed units (%s), variable %s, file %s",
parm->levunits, vertdim->units, var->name, file->path);
}
*/
/* Override table compression values for 'fixed compression' file */
/* Note: Use var->scalefac instead of parm->scalefac, since other */
/* non-fixed-compression variables may point to parm !!! */
if(file->compressiontype == LATS_FIXED_COMP){
var->scalefac = -999;
var->precision = LATS_FIXED_COMPRESSION_NBITS;
}
else {
var->scalefac = parm->scalefac;
var->precision = parm->precision;
}
var->parm = parm;
strncpy(var->comments, comments, LATS_MAX_COMMENTS); var->comments[LATS_MAX_COMMENTS-1]='\0';
var->levdelta = levdelta;
var->nlev = nlev;
var->levs = (vertdim ? vertdim->levs : (double *)0);
/*mf---
961212
bug fix -- LATS_FIXED now properly processed ...
var->timestat = (file->frequency == LATS_FIXED ? (latsTimeStatEntry *)0 : stat);
---mf*/
var->timestat = stat;
var->tstat = timestat;
var->vertdim = vertdim;
/* Declare the grid for this file, if necessary */
nprev = file->ngrid;
if((grid = latsFileGridLookup(file, gridid))==0)
return 0;
if(nprev < file->ngrid){
ierr = (file->type == LATS_GRIB ? lats_grid_grib(file, grid) : lats_grid_nc(file, grid));
if(ierr == 0)
return 0;
}
var->grid = grid;
/* Fill QC table: at most one entry for every level */
if(lats_qc){
qcalloc = (var->levs ? var->nlev : 1);
if((var->qctable = (latsParmQC **)calloc(qcalloc,sizeof(latsParmQC *)))==0){
latsError("LATS (lats.c) --> Creating quality control table, variable %s", var->name);
return 0;
}
/* Explicit vertical dimension? */
if(var->levs){
for(i=0; i<var->nlev; i++){
if((qc = latsQCLookup(var->name, var->vertdim->type->name, var->levs[i], levdelta)))
var->qctable[i] = qc;
else
var->qctable[i] = (latsParmQC *)0;
}
}
/* Implicit vertical dimension? */
else if(parm->levelset == 1){
if((qc = latsQCLookup(var->name, parm->verttype->name, LATS_DEFAULT_QC_VALUE, 0.0)))
var->qctable[0] = qc;
else
var->qctable[0] = (latsParmQC *)0;
}
else { /* No associated level, look for empty string*/
if((qc = latsQCLookup(var->name, "", LATS_DEFAULT_QC_VALUE, 0.0)))
var->qctable[0] = qc;
else
var->qctable[0] = (latsParmQC *)0;
}
}
return (file->type == LATS_GRIB ? lats_var_grib(file, var, grid, vertdim) : lats_var_nc(file, var, grid, vertdim));
}
/* Declare the missing data value for a floating-point variable. */
/* Return 1 on success, 0 on failure*/
int lats_miss_float(int fileid, int varid, float missing, float delta){
latsVar *var;
latsFile *file;
_lats_routine_name_ = "lats_miss_float";
if((file = latsFileLookup(fileid))==0) {
return 0;
}
if(file->latsmode != LATS_MODE_DEFINE){
latsError("LATS (lats.c) --> lats_miss_float calls must precede any lats_write call");
return 0;
}
if((var = latsVarLookup(fileid, varid))==0)
return 0;
if(var->parm->datatype != LATS_FLOAT){
latsError("LATS (lats.c) --> Missing data value for variable %s declared as float, but variable is not floating-point",
var->name);
return 0;
}
if(delta < 0.0){
latsError("LATS (lats.c) --> Missing delta value = %f, must be nonnegative",delta);
return 0;
}
var->missing.f = missing;
var->missingdelta = delta;
var->hasmissing = 1;
return 1;
}
/* Declare the missing data value for an integer variable. */
/* Return 1 on success, 0 on failure*/
int lats_miss_int(int fileid, int varid, int missing){
latsVar *var;
latsFile *file;
_lats_routine_name_ = "lats_miss_int";
if((file = latsFileLookup(fileid))==0) {
return 0;
}
if(file->latsmode != LATS_MODE_DEFINE){
latsError("LATS (lats.c) --> lats_miss_int calls must precede any lats_write call");
return 0;
}
if((var = latsVarLookup(fileid, varid))==0)
return 0;
if(var->parm->datatype != LATS_INT){
latsError("LATS (lats.c) --> Missing data value for variable %s declared as integer, but variable is not an integer",
var->name);
return 0;
}
var->missing.i = missing;
var->hasmissing = 1;
return 1;
}
/* Specify an alternate parameter table. */
int lats_parmtab(char* table_path) {
_lats_routine_name_ = "lats_parmtab";
if(latsParmCreateTable(table_path)==0)
return 0;
else{
latsParmTableCreated = 1;
return 1;
}
}
/* Define a vertical dimension */
int lats_vert_dim(char* name, char* levtype, int nlev, double levs[]) {
latsFile *file;
latsVertDim *vertdim,*vertdim_check;
latsVertType *verttype;
latsMonotonicity mono;
double levdelta, delta;
int i;
char *units;
char *defaultParmFile;
_lats_routine_name_ = "lats_vert_dim";
/*mf mode check
if(file->latsmode != LATS_MODE_DEFINE){
latsError("LATS (lats.c) --> lats_vert_dim calls must precede any lats_write call");
return 0;
}
*/
/* Create the parameter table, if necessary */
if(latsParmTableCreated == 0){
if((defaultParmFile = getenv("LATS_PARMS")) == NULL) {
if(latsParmCreateDefaultTable()==0)
return 0;
}
else {
if(latsParmCreateTable(defaultParmFile)==0)
return 0;
}
latsParmTableCreated = 1;
}
if((verttype = latsVertTypeLookup(levtype))==0){
latsVertTypeList();
latsError("LATS (lats.c) --> Vertical dimension type not found: %s, vertical dimension %s", levtype, name);
return 0;
}
if(nlev <= 0){
latsError("LATS (lats.c) --> Vertical dimension: %s, length: %d, must be positive",
name, nlev);
return 0;
}
if(nlev>0 && (mono = latsCheckMono(nlev, levs))==0){
latsError("LATS (lats.c) --> Vertical dimension: %s: must be strictly monotonic, increasing or decreasing",
name);
return 0;
}
/* Determine lookup fudge factor for level values */
if(mono == LATS_INCREASING){
levdelta = 1.0e20;
for(i=0; i<nlev-1; i++){
delta = levs[i+1] - levs[i];
levdelta = (levdelta < delta) ? levdelta : delta;
}
}
else if(mono == LATS_DECREASING){
levdelta = 1.0e20;
for(i=0; i<nlev-1; i++){
delta = levs[i] - levs[i+1];
levdelta = (levdelta < delta) ? levdelta : delta;
}
}
else
/* Singleton level, make sure delta is positive, */
/* otherwise lookup will fail. */
levdelta = ((delta=fabs((double)levs[0])) > 0.0 ? delta : 1.0);
levdelta *= LATS_DELTA_FACTOR;
if((vertdim = latsVertAddEntry(name))==0)
return 0;
vertdim->delta = levdelta;
vertdim->nlev = nlev;
vertdim->vncid = vertdim->ncid = -1;
vertdim->type = verttype;
latsCpyTrim(vertdim->name, name, LATS_MAX_NAME);
if((vertdim->levs = (double *)malloc(nlev*sizeof(double)))==0){
latsError("LATS (lats.c) --> Allocating memory for vertical dimension: %s, length %d",
name, nlev);
return 0;
}
memcpy(vertdim->levs, levs, nlev*sizeof(double));
return vertdim->id;
}
/* Write a horizontal lon-lat section 'data' to file with ID 'fileid', */
/* variable with ID 'varid'. Return 1 on success, 0 on failure. */
int lats_write(int fileid, int varid, double lev, int year, int month, int day, int hour, void* data) {
latsFile *file;
latsVar *var;
int ierr, levindex, timeindex, ihour;
latsCompTime time;
cdCompTime cdtime;
int timecmp;
double old_time, new_time;
int idel, ndels;
static int monthdays[12]={31,29,31,30,31,30,31,31,30,31,30,31};
static char monthnames[12][4]={"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"};
_lats_routine_name_ = "lats_write";
/* Lookup the file and variable */
if((var = latsVarLookup(fileid, varid))==0)
return 0;
file = var->file;
/*mf - put lats in DATA mode mf*/
file->latsmode=LATS_MODE_DATA;
/* Validity checks */
/* jfp 2015.06.17: really what this does is to truncate the time.
Uncomment if that's what you want to do...
switch(file->frequency){
case LATS_HOURLY:
break;
case LATS_FORECAST_HOURLY:
break;
case LATS_DAILY:
case LATS_WEEKLY:
hour = 0;
break;
case LATS_MONTHLY:
day = 1;
hour = 0;
break;
case LATS_YEARLY:
month = 1;
day = 1;
hour = 0;
break;
case LATS_FIXED:
year = 1;
month = 1;
day = 1;
hour = 0;
break;
}
*/
/*mf---
check if climo field for GRIB options
set year to 2, but it will be overwritten in latsgrib.c by GRADS_CLIM_YEAR
---mf*/
if(!(file->calendar & cdStandardCal) &&
file->type == LATS_GRIB &&
file->frequency != LATS_FIXED) {
year=2;
}
/*
* time QC
*/
if(file->frequency != LATS_FORECAST_HOURLY) {
if(year <= 0){
latsError("LATS (lats.c) --> \n Invalid year: %d, file %s year <= 0 NOT Supported\n if climatology use year 2 in lats_write", year, file->path);
}
if(month<1 || month>12){
latsError("LATS (lats.c) --> Invalid month: %d, file %s, variable %s",
month, file->path, var->name);
return 0;
}
if(day<1 || day>31){
latsError("LATS (lats.c) --> Invalid day: %d, file %s, variable %s",
day, file->path, var->name);
return 0;
}
if(hour<0 || hour>23){
latsError("LATS (lats.c) --> Invalid hour: %d, file %s, variable %s",
hour, file->path, var->name);
return 0;