-
Notifications
You must be signed in to change notification settings - Fork 145
/
netcdf_utilities_mod.f90
2599 lines (1847 loc) · 96.4 KB
/
netcdf_utilities_mod.f90
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
! DART software - Copyright UCAR. This open source software is provided
! by UCAR, "as is", without charge, subject to all terms of use at
! http://www.image.ucar.edu/DAReS/DART/DART_download
module netcdf_utilities_mod
!> a module to streamline the code that calls netcdf routines.
!>
!> calling code should NOT have to use the netcdf module, nor see
!> any netcdf ID values, types, lengths, etc. this code does error
!> checking and reports the offending call, filename, and user-supplied
!> context (often the 'routine' variable with the calling subroutine name).
!>
!> isolates access to the netcdf libs to routines inside this module.
!>
!> routines in this file are prefixed with nc_ and attempt to say
!> in english what they do. the intent is someone who does not know
!> anything about netcdf can still use these.
!>
!> The 'put_var' and 'get_var' routines take optional start, count,
!> stride, and map variables.
!>
use types_mod, only : r4, r8, digits12, i2, i4, i8, PI, MISSING_R8, MISSING_I
use utilities_mod, only : error_handler, E_DBG, E_MSG, E_ALLMSG, E_WARN, E_ERR
use netcdf
implicit none
private
public :: nc_check, &
nc_add_global_attribute, &
nc_get_global_attribute, &
nc_add_attribute_to_variable, &
nc_get_attribute_from_variable, &
nc_define_dimension, &
nc_define_unlimited_dimension, &
nc_get_dimension_size, &
nc_define_character_variable, &
nc_define_integer_variable, &
nc_define_real_variable, &
nc_define_double_variable, &
nc_define_integer_scalar, &
nc_define_real_scalar, &
nc_define_double_scalar, &
nc_global_attribute_exists, &
nc_variable_attribute_exists, &
nc_dimension_exists, &
nc_variable_exists, &
nc_put_variable, &
nc_get_variable, &
nc_get_variable_info, &
nc_add_global_creation_time, &
nc_get_variable_num_dimensions, &
nc_get_variable_dimension_names, &
nc_get_variable_size, &
nc_open_file_readonly, &
nc_open_file_readwrite, &
nc_create_file, &
nc_close_file, &
nc_begin_define_mode, &
nc_end_define_mode, &
nc_synchronize_file, &
NF90_MAX_NAME, NF90_MAX_VAR_DIMS
! note here that you only need to distinguish between
! r4 (float) and r8 (double) when defining or adding
! a new variable or attribute. the get and query routines
! will coerce the values to the destination precision correctly.
interface nc_add_global_attribute
module procedure nc_add_global_char_att
module procedure nc_add_global_int_att
module procedure nc_add_global_float_att
module procedure nc_add_global_double_att
module procedure nc_add_global_float_array_att
module procedure nc_add_global_double_array_att
end interface
interface nc_get_global_attribute
module procedure nc_get_global_char_att
module procedure nc_get_global_int_att
module procedure nc_get_global_float_att
module procedure nc_get_global_double_att
module procedure nc_get_global_float_array_att
module procedure nc_get_global_double_array_att
end interface
interface nc_add_attribute_to_variable
module procedure nc_add_char_att_to_var
module procedure nc_add_int_array_att_to_var
module procedure nc_add_int_att_to_var
module procedure nc_add_float_att_to_var
module procedure nc_add_double_att_to_var
module procedure nc_add_float_array_att_to_var
module procedure nc_add_double_array_att_to_var
end interface
interface nc_get_attribute_from_variable
module procedure nc_get_char_att_from_var
module procedure nc_get_int_array_att_from_var
module procedure nc_get_int_att_from_var
module procedure nc_get_float_att_from_var
module procedure nc_get_double_att_from_var
module procedure nc_get_float_array_att_from_var
module procedure nc_get_double_array_att_from_var
end interface
interface nc_define_character_variable
module procedure nc_define_var_char_1d
module procedure nc_define_var_char_Nd
end interface
interface nc_define_integer_variable
module procedure nc_define_var_int_1d
module procedure nc_define_var_int_Nd
end interface
interface nc_define_real_variable
module procedure nc_define_var_real_1d
module procedure nc_define_var_real_Nd
end interface
interface nc_define_double_variable
module procedure nc_define_var_double_1d
module procedure nc_define_var_double_Nd
end interface
interface nc_put_variable
module procedure nc_put_char_1d
module procedure nc_put_char_2d
module procedure nc_put_int_0d
module procedure nc_put_int_1d
module procedure nc_put_int_2d
module procedure nc_put_int_3d
module procedure nc_put_int_4d
module procedure nc_put_real_0d
module procedure nc_put_real_1d
module procedure nc_put_real_2d
module procedure nc_put_real_3d
module procedure nc_put_real_4d
module procedure nc_put_double_0d
module procedure nc_put_double_1d
module procedure nc_put_double_2d
module procedure nc_put_double_3d
module procedure nc_put_double_4d
end interface
interface nc_get_variable
module procedure nc_get_short_0d
module procedure nc_get_short_1d
module procedure nc_get_short_2d
module procedure nc_get_short_3d
module procedure nc_get_int_0d
module procedure nc_get_int_1d
module procedure nc_get_int_2d
module procedure nc_get_int_3d
module procedure nc_get_int_4d
module procedure nc_get_real_0d
module procedure nc_get_real_1d
module procedure nc_get_real_2d
module procedure nc_get_real_3d
module procedure nc_get_real_4d
module procedure nc_get_double_0d
module procedure nc_get_double_1d
module procedure nc_get_double_2d
module procedure nc_get_double_3d
module procedure nc_get_double_4d
end interface
interface nc_get_variable_size
module procedure nc_get_variable_size_1d
module procedure nc_get_variable_size_Nd
end interface
character(len=*), parameter :: source = 'netcdf_utilities_mod.f90'
character(len=512) :: msgstring1
!> make a derived type that is (ncid, filename)
!> store filename on file open, delete it on file close. cache the
!> last N filenames - look them up on error and stop
!> having to keep the filename around.
! NOTE this is the max number of concurrently
! open netcdf files on a single task.
integer, parameter :: MAX_NCFILES = 50
integer, parameter :: FH_EMPTY = -1
type ncinfo_type
integer :: file_handle = FH_EMPTY
character(len=256) :: file_name = ''
end type
! for now hardcode max size. could make it allocatable
! and extend it if you need more open slots
type(ncinfo_type) :: ncinfo(MAX_NCFILES)
! do we need one of these?
!namelist /netcdf_utilities_nml/
contains
!------------------------------------------------------------------
!> check return code from previous call. on error, print and stop.
!> if you want to continue after an error don't use this call.
subroutine nc_check(istatus, subr_name, context, context2, filename, ncid)
integer, intent(in) :: istatus
character(len=*), intent(in) :: subr_name
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: context2
character(len=*), intent(in), optional :: filename
integer, intent(in), optional :: ncid
character(len=256) :: saved_filename
if (istatus == nf90_noerr) return
! something wrong. construct an error string and call the handler.
msgstring1 = nf90_strerror(istatus)
! context is optional, but is very useful if specified.
if (present(context)) then
msgstring1 = trim(context) // ': ' // trim(msgstring1)
endif
! you can give this routine a file handle and it will try
! to extract the filename from it.
if (.not. present(filename) .and. present(ncid)) then
call find_name_from_fh(ncid, saved_filename)
else if (present(filename)) then
saved_filename = filename
else
saved_filename = ''
endif
! this does not return
call error_handler(E_ERR, subr_name, msgstring1, source, &
text2=context2, text3=saved_filename)
end subroutine nc_check
!------------------------------------------------------------------
!--------------------------------------------------------------------
! global attribute section
subroutine nc_add_global_char_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
character(len=*), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_char_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_char_att
!--------------------------------------------------------------------
subroutine nc_add_global_int_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
integer, intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_int_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_int_att
!--------------------------------------------------------------------
subroutine nc_add_global_float_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(r4), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_float_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_float_att
!--------------------------------------------------------------------
subroutine nc_add_global_double_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(digits12), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_double_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_double_att
!--------------------------------------------------------------------
subroutine nc_add_global_float_array_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(r4), intent(in) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_float_array_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_float_array_att
!--------------------------------------------------------------------
subroutine nc_add_global_double_array_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(digits12), intent(in) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_global_double_array_att'
integer :: ret
ret = nf90_put_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'adding the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_add_global_double_array_att
!------------------------------------------------------------------
subroutine nc_get_global_char_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
character(len=*), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_char_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_char_att
!--------------------------------------------------------------------
subroutine nc_get_global_int_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
integer, intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_int_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_int_att
!--------------------------------------------------------------------
subroutine nc_get_global_float_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(r4), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_float_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_float_att
!--------------------------------------------------------------------
subroutine nc_get_global_double_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(digits12), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_double_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_double_att
!--------------------------------------------------------------------
subroutine nc_get_global_float_array_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(r4), intent(out) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_float_array_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_float_array_att
!--------------------------------------------------------------------
subroutine nc_get_global_double_array_att(ncid, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: attname
real(digits12), intent(out) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_global_double_array_att'
integer :: ret
ret = nf90_get_att(ncid, NF90_GLOBAL, attname, val)
call nc_check(ret, routine, 'getting the global attribute: '//trim(attname), context, filename, ncid)
end subroutine nc_get_global_double_array_att
!--------------------------------------------------------------------
! attributes on specific variables section
subroutine nc_add_char_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
character(len=*), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_char_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_char_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_int_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
integer, intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_int_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_int_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_int_array_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
integer, intent(in) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_int_array_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_int_array_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_float_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(r4), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_float_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_float_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_double_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(digits12), intent(in) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_double_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_double_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_float_array_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(r4), intent(in) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_float_array_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_float_array_att_to_var
!--------------------------------------------------------------------
subroutine nc_add_double_array_att_to_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(digits12), intent(in) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_add_double_array_att_to_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_put_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'adding the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_add_double_array_att_to_var
!--------------------------------------------------------------------
subroutine nc_get_char_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
character(len=*), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_char_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_char_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_int_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
integer, intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_int_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_int_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_int_array_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
integer, intent(out) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_int_array_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_int_array_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_float_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(r4), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_float_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_float_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_double_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(digits12), intent(out) :: val
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_double_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_double_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_float_array_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(r4), intent(out) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_float_array_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_float_array_att_from_var
!--------------------------------------------------------------------
subroutine nc_get_double_array_att_from_var(ncid, varname, attname, val, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: attname
real(digits12), intent(out) :: val(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_get_double_array_att_from_var'
integer :: ret, varid
ret = nf90_inq_varid(ncid, varname, varid)
call nc_check(ret, routine, 'inquire variable id for '//trim(varname), context, filename, ncid)
ret = nf90_get_att(ncid, varid, attname, val)
call nc_check(ret, routine, 'getting the attribute: '//trim(attname)//' to variable: '//trim(varname), context, filename, ncid)
end subroutine nc_get_double_array_att_from_var
!--------------------------------------------------------------------
!--------------------------------------------------------------------
! dimensions section
subroutine nc_define_dimension(ncid, dimname, dimlen, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: dimname
integer, intent(in) :: dimlen
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_dimension'
integer :: ret, dimid
ret = nf90_def_dim(ncid, dimname, dimlen, dimid)
call nc_check(ret, routine, 'define dimension '//trim(dimname), context, filename, ncid)
end subroutine nc_define_dimension
!--------------------------------------------------------------------
subroutine nc_define_unlimited_dimension(ncid, dimname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: dimname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_unlimited_dimension'
integer :: ret, dimid
ret = nf90_def_dim(ncid, dimname, NF90_UNLIMITED, dimid)
call nc_check(ret, routine, 'define unlimited dimension '//trim(dimname), context, filename, ncid)
end subroutine nc_define_unlimited_dimension
!--------------------------------------------------------------------
function nc_get_dimension_size(ncid, dimname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: dimname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
integer :: nc_get_dimension_size
character(len=*), parameter :: routine = 'nc_get_dimension_size'
integer :: ret, dimid
ret = nf90_inq_dimid(ncid, dimname, dimid)
call nc_check(ret, routine, 'inq dimid '//trim(dimname), context, filename, ncid)
ret = nf90_inquire_dimension(ncid, dimid, len=nc_get_dimension_size)
call nc_check(ret, routine, 'inquire dimension '//trim(dimname), context, filename, ncid)
end function nc_get_dimension_size
!--------------------------------------------------------------------
!--------------------------------------------------------------------
! defining variables section
!> unfortunately, the scalar versions of these routines cannot be
!> overloaded with the Nd versions. the optional arguments make
!> the signatures (combinations of arguments) inseperable.
!> it's less common to define scalars in netcdf files, so those ones
!> get a separate entry point.
!--------------------------------------------------------------------
subroutine nc_define_var_char_1d(ncid, varname, dimname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: dimname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_var_char_1d'
integer :: ret, dimid, varid
ret = nf90_inq_dimid(ncid, dimname, dimid)
call nc_check(ret, routine, 'inquire dimension id for dim '//trim(dimname), context, filename, ncid)
ret = nf90_def_var(ncid, varname, nf90_char, dimid, varid)
call nc_check(ret, routine, 'define character variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_var_char_1d
!--------------------------------------------------------------------
subroutine nc_define_var_char_Nd(ncid, varname, dimnames, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: dimnames(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_var_char_Nd'
integer :: ret, dimid1, dimid2, dimid3, varid
if (size(dimnames) >= 1) then
ret = nf90_inq_dimid(ncid, dimnames(1), dimid1)
call nc_check(ret, routine, 'inquire dimension id for dim '//trim(dimnames(1)), context, filename, ncid)
endif
if (size(dimnames) >= 2) then
ret = nf90_inq_dimid(ncid, dimnames(2), dimid2)
call nc_check(ret, routine, 'inquire dimension id for dim '//trim(dimnames(2)), context, filename, ncid)
endif
if (size(dimnames) >= 3) then
ret = nf90_inq_dimid(ncid, dimnames(3), dimid3)
call nc_check(ret, routine, 'inquire dimension id for dim '//trim(dimnames(3)), context, filename, ncid)
endif
if (size(dimnames) >= 4) then
call error_handler(E_ERR, routine, 'only 1d, 2d and 3d character variables supported', &
source, text2='variable '//trim(varname))
endif
if (size(dimnames) == 1) then
ret = nf90_def_var(ncid, varname, nf90_char, dimid1, varid=varid)
else if (size(dimnames) == 2) then
ret = nf90_def_var(ncid, varname, nf90_char, dimids=(/ dimid1, dimid2 /), varid=varid)
else if (size(dimnames) == 3) then
ret = nf90_def_var(ncid, varname, nf90_char, dimids=(/ dimid1, dimid2, dimid3 /), varid=varid)
endif
call nc_check(ret, routine, 'define character variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_var_char_Nd
!--------------------------------------------------------------------
subroutine nc_define_integer_scalar(ncid, varname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_integer_scalar'
integer :: ret, varid
ret = nf90_def_var(ncid, varname, nf90_int, varid=varid)
call nc_check(ret, routine, 'define scalar integer variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_integer_scalar
!--------------------------------------------------------------------
subroutine nc_define_var_int_1d(ncid, varname, dimname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: dimname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_var_int_1d'
integer :: ret, dimid, varid
ret = nf90_inq_dimid(ncid, dimname, dimid)
call nc_check(ret, routine, 'inquire dimension id for dim '//trim(dimname), context, filename, ncid)
ret = nf90_def_var(ncid, varname, nf90_int, dimid, varid)
call nc_check(ret, routine, 'define integer variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_var_int_1d
!--------------------------------------------------------------------
! fortran supports up to 7 dimensional arrays. but in this set of
! routines we only go up to 4D arrays.
subroutine nc_define_var_int_Nd(ncid, varname, dimnames, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in) :: dimnames(:)
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_var_int_Nd'
integer :: i, ret, ndims, varid, dimids(NF90_MAX_VAR_DIMS)
ndims = size(dimnames)
if (ndims > 4) then
call error_handler(E_ERR, routine, 'only 1d, 2d, 3d and 4d integer variables supported', &
source, text2='variable '//trim(varname))
endif
do i=1, ndims
write(msgstring1,*)'"'//trim(varname)//'" inquire dimension id for dim "'//trim(dimnames(i))//'"'
ret = nf90_inq_dimid(ncid, dimnames(i), dimids(i))
call nc_check(ret, routine, msgstring1, context, filename, ncid)
enddo
ret = nf90_def_var(ncid, varname, nf90_int, dimids(1:ndims), varid=varid)
call nc_check(ret, routine, 'define integer variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_var_int_Nd
!--------------------------------------------------------------------
subroutine nc_define_real_scalar(ncid, varname, context, filename)
integer, intent(in) :: ncid
character(len=*), intent(in) :: varname
character(len=*), intent(in), optional :: context
character(len=*), intent(in), optional :: filename
character(len=*), parameter :: routine = 'nc_define_real_scalar'
integer :: ret, varid
ret = nf90_def_var(ncid, varname, nf90_real, varid=varid)
call nc_check(ret, routine, 'define scalar real variable '//trim(varname), context, filename, ncid)
end subroutine nc_define_real_scalar
!--------------------------------------------------------------------
subroutine nc_define_var_real_1d(ncid, varname, dimname, context, filename)