-
Notifications
You must be signed in to change notification settings - Fork 12
/
ice_history_shared.F90
869 lines (738 loc) · 33.6 KB
/
ice_history_shared.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
! SVN:$Id: ice_history_shared.F90 925 2015-03-04 00:34:27Z eclare $
!=======================================================================
!
! Output files: netCDF or binary data, Fortran unformatted dumps
!
! The following variables are currently hard-wired as snapshots
! (instantaneous rather than time-averages):
! divu, shear, sig1, sig2, trsig, mlt_onset, frz_onset, hisnap, aisnap
!
! Options for histfreq: '1','h','d','m','y','x', where x means that
! output stream will not be used (recommended for efficiency).
! histfreq_n can be any nonnegative integer, where 0 means that the
! corresponding histfreq frequency will not be used.
! The flags (f_<field>) can be set to '1','h','d','m','y' or 'x', where
! n means the field will not be written. To output the same field at
! more than one frequency, for instance monthy and daily, set
! f_<field> = 'md'.
!
! authors Tony Craig and Bruce Briegleb, NCAR
! Elizabeth C. Hunke and William H. Lipscomb, LANL
! C. M. Bitz, UW
!
! 2012 Elizabeth Hunke split code from ice_history.F90
module ice_history_shared
use ice_kinds_mod
use ice_fileunits, only: nu_diag
use ice_domain_size, only: ncat, nilyr, nslyr, nblyr, max_nstrm
implicit none
save
private
public :: define_hist_field, accum_hist_field, icefields_nml, construct_filename
logical (kind=log_kind), public :: &
hist_avg ! if true, write averaged data instead of snapshots
character (len=char_len), public :: &
history_file , & ! output file for history
incond_file ! output file for snapshot initial conditions
character (len=char_len_long), public :: &
history_dir , & ! directory name for history file
incond_dir ! directory for snapshot initial conditions
integer, public :: &
history_deflate_level ! Deflation/compression level to use for
! netCDF4 output
logical, public :: &
history_parallel_io ! Use parallel write for netCDF4 output
integer, public :: &
history_chunksize_x ! NetCDF chunksize in x/lon dimension
integer, public :: &
history_chunksize_y ! NetCDF chunksize in y/lat dimension
character (len=char_len_long), public :: &
pointer_file ! input pointer file for restarts
!---------------------------------------------------------------
! Instructions for adding a field: (search for 'example')
! Here:
! (1) Add to frequency flags (f_<field>)
! (2) Add to namelist (here and also in ice_in)
! (3) Add to index list
! In init_hist:
! (4) Add define_hist_field call with vname, vdesc, vunit,
! and vcomment, vcellmeas, and conversion factor if necessary.
! (5) Add flag to broadcast list
! (6) Add accum_hist_field call with appropriate variable
!---------------------------------------------------------------
type, public :: ice_hist_field
character (len=16) :: vname ! variable name
character (len=16) :: vunit ! variable units
character (len=25) :: vcoord ! variable coordinates
character (len=16) :: vcellmeas ! variable cell measures
character (len=55) :: vdesc ! variable description
character (len=55) :: vcomment ! variable description
real (kind=dbl_kind) :: cona ! multiplicative conversion factor
real (kind=dbl_kind) :: conb ! additive conversion factor
character (len=1) :: vhistfreq ! frequency of history output
integer (kind=int_kind) :: vhistfreq_n ! number of vhistfreq intervals
end type
integer (kind=int_kind), parameter, public :: &
max_avail_hist_fields = 600 ! Max number of history fields
integer (kind=int_kind), public :: &
num_avail_hist_fields_tot = 0, & ! Current, total number of defined fields
num_avail_hist_fields_2D = 0, & ! Number of 2D fields
num_avail_hist_fields_3Dz = 0, & ! Number of 3D fields (vertical)
num_avail_hist_fields_3Dc = 0, & ! Number of 3D fields (categories)
num_avail_hist_fields_3Db = 0, & ! Number of 3D fields (vertical biology)
num_avail_hist_fields_4Di = 0, & ! Number of 4D fields (categories,vertical), ice
num_avail_hist_fields_4Ds = 0, & ! Number of 4D fields (categories,vertical), snow
num_avail_hist_fields_4Db = 0 ! Number of 4D fields (categories,vertical), ice-biology
integer (kind=int_kind), public :: & ! cumulative counts
n2D , & ! num_avail_hist_fields_2D
n3Dccum , & ! n2D + num_avail_hist_fields_3Dc
n3Dzcum , & ! n3Dccum + num_avail_hist_fields_3Dz
n3Dbcum , & ! n3Dzcum + num_avail_hist_fields_3Db
n4Dicum , & ! n3Dbcum + num_avail_hist_fields_4Di
n4Dscum , & ! n4Dicum + num_avail_hist_fields_4Ds
n4Dbcum , & ! n4Dscum + num_avail_hist_fields_4Db
nzlyr , & ! vertical dimension (temp variable)
nzlyrb ! vertical dimension of biology grid (temp variable)
! for now, ice and snow have same dimensions in netcdf
! could set nzilyr = nilyr + nslyr and write Tin+Tsn together into Tinz
integer (kind=int_kind), parameter, public :: &
nzilyr = nilyr, & ! vertical dimension (allows alternative grids)
nzslyr = nslyr, &
nzblyr = nblyr+2
type (ice_hist_field), dimension(max_avail_hist_fields), public :: &
avail_hist_fields
integer (kind=int_kind), parameter, public :: &
nvar = 12 , & ! number of grid fields that can be written
! excluding grid vertices
nvarz = 4 , & ! number of category/vertical grid fields written
ncat_hist = ncat ! number of ice categories written <= ncat
real (kind=real_kind), public :: time_beg(max_nstrm), & ! bounds for averaging
time_end(max_nstrm), &
time_bounds(2)
real (kind=dbl_kind), allocatable, public :: &
a2D (:,:,:,:) , & ! field accumulations/averages, 2D
a3Dz(:,:,:,:,:) , & ! field accumulations/averages, 3D vertical
a3Db(:,:,:,:,:) , & ! field accumulations/averages, 3D vertical biology
a3Dc(:,:,:,:,:) , & ! field accumulations/averages, 3D categories
a4Di(:,:,:,:,:,:), & ! field accumulations/averages, 4D categories,vertical, ice
a4Ds(:,:,:,:,:,:), & ! field accumulations/averages, 4D categories,vertical, snow
a4Db(:,:,:,:,:,:) ! field accumulations/averages, 4D categories,vertical, bio
real (kind=dbl_kind), allocatable, public :: &
Tinz4d (:,:,:,:) , & ! array for Tin
Tsnz4d (:,:,:,:) , & ! array for Tsn
Sinz4d (:,:,:,:) ! array for Sin
real (kind=dbl_kind), public :: &
avgct(max_nstrm) ! average sample counter
logical (kind=log_kind), public :: &
igrd (nvar), & ! true if grid field is written to output file
igrdz(nvarz) ! true if category/vertical grid field is written
character (len=25), public, parameter :: &
tcstr = 'area: tarea' , & ! vcellmeas for T cell quantities
ucstr = 'area: uarea' , & ! vcellmeas for U cell quantities
tstr2D = 'TLON TLAT time' , & ! vcoord for T cell quantities, 2D
ustr2D = 'ULON ULAT time' , & ! vcoord for U cell quantities, 2D
tstr3Dz = 'TLON TLAT VGRDi time', & ! vcoord for T cell quantities, 3D
ustr3Dz = 'ULON ULAT VGRDi time', & ! vcoord for U cell quantities, 3D
tstr3Dc = 'TLON TLAT NCAT time', & ! vcoord for T cell quantities, 3D
ustr3Dc = 'ULON ULAT NCAT time', & ! vcoord for U cell quantities, 3D
tstr3Db = 'TLON TLAT VGRDb time', & ! vcoord for T cell quantities, 3D
ustr3Db = 'ULON ULAT VGRDb time', & ! vcoord for U cell quantities, 3D
!ferret
tstr4Di = 'TLON TLAT VGRDi NCAT', & ! vcoord for T cell, 4D, ice
ustr4Di = 'ULON ULAT VGRDi NCAT', & ! vcoord for U cell, 4D, ice
tstr4Ds = 'TLON TLAT VGRDs NCAT', & ! vcoord for T cell, 4D, snow
ustr4Ds = 'ULON ULAT VGRDs NCAT', & ! vcoord for U cell, 4D, snow
tstr4Db = 'TLON TLAT VGRDb NCAT', & ! vcoord for T cell, 4D, bio
ustr4Db = 'ULON ULAT VGRDb NCAT' ! vcoord for U cell, 4D, bio
!ferret
! tstr4Di = 'TLON TLAT VGRDi NCAT time', & ! ferret can not handle time
! ustr4Di = 'ULON ULAT VGRDi NCAT time', & ! index on 4D variables.
! tstr4Ds = 'TLON TLAT VGRDs NCAT time', & ! Use 'ferret' lines instead
! ustr4Ds = 'ULON ULAT VGRDs NCAT time', & ! (below also)
! tstr4Db = 'TLON TLAT VGRDb NCAT time', &
! ustr4Db = 'ULON ULAT VGRDb NCAT time'
!---------------------------------------------------------------
! flags: write to output file if true or histfreq value
!---------------------------------------------------------------
logical (kind=log_kind), public :: &
f_tmask = .true., f_blkmask = .true., &
f_tarea = .true., f_uarea = .true., &
f_dxt = .true., f_dyt = .true., &
f_dxu = .true., f_dyu = .true., &
f_HTN = .true., f_HTE = .true., &
f_ANGLE = .true., f_ANGLET = .true., &
f_bounds = .true., f_NCAT = .true., &
f_VGRDi = .true., f_VGRDs = .true., &
f_VGRDb = .true.
character (len=max_nstrm), public :: &
! f_example = 'md', &
f_hi = 'm', f_hs = 'm', &
f_snowfrac = 'x', f_snowfracn = 'x', &
f_Tsfc = 'm', f_aice = 'm', &
f_uvel = 'm', f_vvel = 'm', &
f_uatm = 'm', f_vatm = 'm', &
f_fswdn = 'm', f_flwdn = 'm', &
f_fswup = 'm', &
f_snow = 'm', f_snow_ai = 'm', &
f_rain = 'm', f_rain_ai = 'm', &
f_sst = 'm', f_sss = 'm', &
f_uocn = 'm', f_vocn = 'm', &
f_sice = 'm', f_frzmlt = 'm', &
f_fswfac = 'm', f_fswint_ai = 'x', &
f_fswabs = 'm', f_fswabs_ai = 'm', &
f_albsni = 'm', &
f_alvdr = 'x', f_alidr = 'x', &
f_alvdf = 'x', f_alidf = 'x', &
f_alvdr_ai = 'm', f_alidr_ai = 'm', &
f_alvdf_ai = 'm', f_alidf_ai = 'm', &
f_albice = 'm', f_albsno = 'm', &
f_albpnd = 'm', f_coszen = 'm', &
f_flat = 'm', f_flat_ai = 'm', &
f_fsens = 'm', f_fsens_ai = 'm', &
f_flwup = 'm', f_flwup_ai = 'm', &
f_evap = 'm', f_evap_ai = 'm', &
f_Tair = 'm', &
f_Tref = 'm', f_Qref = 'm', &
f_congel = 'm', f_frazil = 'm', &
f_snoice = 'm', f_dsnow = 'm', &
f_meltt = 'm', f_melts = 'm', &
f_meltb = 'm', f_meltl = 'm', &
f_fresh = 'm', f_fresh_ai = 'm', &
f_fsalt = 'm', f_fsalt_ai = 'm', &
f_fhocn = 'm', f_fhocn_ai = 'm', &
f_fswthru = 'm', f_fswthru_ai = 'm', &
f_strairx = 'm', f_strairy = 'm', &
f_strtltx = 'm', f_strtlty = 'm', &
f_strcorx = 'm', f_strcory = 'm', &
f_strocnx = 'm', f_strocny = 'm', &
f_strintx = 'm', f_strinty = 'm', &
f_strength = 'm', &
f_divu = 'm', f_shear = 'm', &
f_sig1 = 'm', f_sig2 = 'm', &
f_dvidtt = 'm', f_dvidtd = 'm', &
f_daidtt = 'm', f_daidtd = 'm', &
f_dagedtt = 'm', f_dagedtd = 'm', &
f_mlt_onset = 'm', f_frz_onset = 'm', &
f_iage = 'm', f_FY = 'm', &
f_hisnap = 'm', f_aisnap = 'm', &
f_aicen = 'x', f_vicen = 'x', &
f_vsnon = 'x', &
f_trsig = 'm', f_icepresent = 'm', &
f_fsurf_ai = 'm', f_fcondtop_ai= 'm', &
f_fmeltt_ai = 'm', &
f_fsurfn_ai = 'x' ,f_fcondtopn_ai='x', &
f_fmelttn_ai= 'x', f_flatn_ai = 'x', &
f_fsensn_ai = 'x', &
! f_field3dz = 'x', &
f_keffn_top = 'x', &
f_Tinz = 'x', f_Sinz = 'x', &
f_Tsnz = 'x', &
f_a11 = 'x', f_a12 = 'x', &
f_e11 = 'x', f_e12 = 'x', &
f_e22 = 'x', &
f_s11 = 'x', f_s12 = 'x', &
f_s22 = 'x', &
f_yieldstress11 = 'x', &
f_yieldstress12 = 'x', &
f_yieldstress22 = 'x'
!---------------------------------------------------------------
! namelist variables
!---------------------------------------------------------------
namelist / icefields_nml / &
f_tmask , f_blkmask , &
f_tarea , f_uarea , &
f_dxt , f_dyt , &
f_dxu , f_dyu , &
f_HTN , f_HTE , &
f_ANGLE , f_ANGLET , &
f_bounds , f_NCAT , &
f_VGRDi , f_VGRDs , &
f_VGRDb , &
! f_example , &
f_hi, f_hs , &
f_snowfrac, f_snowfracn, &
f_Tsfc, f_aice , &
f_uvel, f_vvel , &
f_uatm, f_vatm , &
f_fswdn, f_flwdn , &
f_fswup, &
f_snow, f_snow_ai , &
f_rain, f_rain_ai , &
f_sst, f_sss , &
f_uocn, f_vocn , &
f_sice, f_frzmlt , &
f_fswfac, f_fswint_ai, &
f_fswabs, f_fswabs_ai, &
f_albsni, &
f_alvdr, f_alidr , &
f_alvdf, f_alidf , &
f_alvdr_ai, f_alidr_ai , &
f_alvdf_ai, f_alidf_ai , &
f_albice, f_albsno , &
f_albpnd, f_coszen , &
f_flat, f_flat_ai , &
f_fsens, f_fsens_ai , &
f_flwup, f_flwup_ai , &
f_evap, f_evap_ai , &
f_Tair, &
f_Tref, f_Qref , &
f_congel, f_frazil , &
f_snoice, f_dsnow , &
f_meltt, f_melts , &
f_meltb, f_meltl , &
f_fresh, f_fresh_ai , &
f_fsalt, f_fsalt_ai , &
f_fhocn, f_fhocn_ai , &
f_fswthru, f_fswthru_ai,&
f_strairx, f_strairy , &
f_strtltx, f_strtlty , &
f_strcorx, f_strcory , &
f_strocnx, f_strocny , &
f_strintx, f_strinty , &
f_strength, &
f_divu, f_shear , &
f_sig1, f_sig2 , &
f_dvidtt, f_dvidtd , &
f_daidtt, f_daidtd , &
f_dagedtt, f_dagedtd , &
f_mlt_onset, f_frz_onset, &
f_iage, f_FY , &
f_hisnap, f_aisnap , &
f_aicen, f_vicen , &
f_vsnon, &
f_trsig, f_icepresent,&
f_fsurf_ai, f_fcondtop_ai,&
f_fmeltt_ai, &
f_fsurfn_ai,f_fcondtopn_ai,&
f_fmelttn_ai,f_flatn_ai, &
f_fsensn_ai, &
! f_field3dz, &
f_keffn_top, &
f_Tinz, f_Sinz, &
f_Tsnz, &
f_a11, f_a12, &
f_e11, f_e12, &
f_e22, &
f_s11, f_s12, &
f_s22, &
f_yieldstress11, &
f_yieldstress12, &
f_yieldstress22
!---------------------------------------------------------------
! field indices
!---------------------------------------------------------------
integer (kind=int_kind), parameter, public :: &
n_tmask = 1, &
n_blkmask = 2, &
n_tarea = 3, &
n_uarea = 4, &
n_dxt = 5, &
n_dyt = 6, &
n_dxu = 7, &
n_dyu = 8, &
n_HTN = 9, &
n_HTE = 10, &
n_ANGLE = 11, &
n_ANGLET = 12, &
n_NCAT = 1, &
n_VGRDi = 2, &
n_VGRDs = 3, &
n_VGRDb = 4, &
n_lont_bnds = 1, &
n_latt_bnds = 2, &
n_lonu_bnds = 3, &
n_latu_bnds = 4
integer (kind=int_kind), dimension(max_nstrm), public :: &
! n_example , &
n_hi , n_hs , &
n_snowfrac , n_snowfracn , &
n_Tsfc , n_aice , &
n_uvel , n_vvel , &
n_uatm , n_vatm , &
n_sice , &
n_fswdn , n_flwdn , &
n_fswup , &
n_snow , n_snow_ai , &
n_rain , n_rain_ai , &
n_sst , n_sss , &
n_uocn , n_vocn , &
n_frzmlt , n_fswfac , &
n_fswint_ai , &
n_fswabs , n_fswabs_ai , &
n_albsni , &
n_alvdr , n_alidr , &
n_alvdf , n_alidf , &
n_alvdr_ai , n_alidr_ai , &
n_alvdf_ai , n_alidf_ai , &
n_albice , n_albsno , &
n_albpnd , n_coszen , &
n_flat , n_flat_ai , &
n_fsens , n_fsens_ai , &
n_flwup , n_flwup_ai , &
n_evap , n_evap_ai , &
n_Tair , &
n_Tref , n_Qref , &
n_congel , n_frazil , &
n_snoice , n_dsnow , &
n_meltt , n_melts , &
n_meltb , n_meltl , &
n_fresh , n_fresh_ai , &
n_fsalt , n_fsalt_ai , &
n_vsnon , &
n_fhocn , n_fhocn_ai , &
n_fswthru , n_fswthru_ai , &
n_strairx , n_strairy , &
n_strtltx , n_strtlty , &
n_strcorx , n_strcory , &
n_strocnx , n_strocny , &
n_strintx , n_strinty , &
n_strength , &
n_divu , n_shear , &
n_sig1 , n_sig2 , &
n_dvidtt , n_dvidtd , &
n_daidtt , n_daidtd , &
n_dagedtt , n_dagedtd , &
n_mlt_onset , n_frz_onset , &
n_hisnap , n_aisnap , &
n_trsig , n_icepresent , &
n_iage , n_FY , &
n_fsurf_ai , &
n_fcondtop_ai, n_fmeltt_ai , &
n_aicen , n_vicen , &
n_fsurfn_ai , &
n_fcondtopn_ai, &
n_fmelttn_ai , &
n_flatn_ai , &
n_fsensn_ai , &
! n_field3dz , &
n_keffn_top , &
n_Tinz , n_Sinz , &
n_Tsnz , &
n_a11 , n_a12 , &
n_e11 , n_e12 , &
n_e22 , &
n_s11 , n_s12 , &
n_s22 , &
n_yieldstress11, n_yieldstress12, &
n_yieldstress22
interface accum_hist_field ! generic interface
module procedure accum_hist_field_2D, &
accum_hist_field_3D, &
accum_hist_field_4D
end interface
!=======================================================================
contains
!=======================================================================
subroutine construct_filename(ncfile,suffix,ns)
use ice_calendar, only: time, sec, nyr, month, daymo, &
mday, write_ic, histfreq, histfreq_n, &
year_init, new_year, new_month, new_day, &
dt
use ice_restart_shared, only: lenstr
character (len=*), intent(inout) :: ncfile
character (len=2), intent(in) :: suffix
integer (kind=int_kind), intent(in) :: ns
integer (kind=int_kind) :: iyear, imonth, iday, isec
character (len=1) :: cstream
iyear = nyr + year_init - 1 ! set year_init=1 in ice_in to get iyear=nyr
imonth = month
iday = mday
isec = sec - dt
#ifdef CCSMCOUPLED
if (write_ic) isec = sec
#endif
! construct filename
if (write_ic) then
write(ncfile,'(a,a,i4.4,a,i2.2,a,i2.2,a,i5.5,a,a)') &
incond_file(1:lenstr(incond_file)),'.',iyear,'-', &
imonth,'-',iday,'-',isec,'.',suffix
else
if (hist_avg .and. histfreq(ns) /= '1') then
if (histfreq(ns) == 'h'.or.histfreq(ns) == 'H') then
! do nothing
elseif (new_year) then
iyear = iyear - 1
imonth = 12
iday = daymo(imonth)
elseif (new_month) then
imonth = month - 1
iday = daymo(imonth)
elseif (new_day) then
iday = iday - 1
endif
endif
cstream = ''
!echmod ! this was implemented for CESM but it breaks post-processing software
!echmod ! of other groups (including RASM which uses CCSMCOUPLED)
!echmod if (ns > 1) write(cstream,'(i1.1)') ns-1
if (histfreq(ns) == '1') then ! instantaneous, write every dt
write(ncfile,'(a,a,i4.4,a,i2.2,a,i2.2,a,i5.5,a,a)') &
history_file(1:lenstr(history_file))//trim(cstream),'_inst.', &
iyear,'-',imonth,'-',iday,'-',sec,'.',suffix
elseif (hist_avg) then ! write averaged data
if (histfreq(ns) == 'd'.or.histfreq(ns) == 'D') then ! daily
write(ncfile,'(a,a,i4.4,a,i2.2,a,i2.2,a,a)') &
history_file(1:lenstr(history_file))//trim(cstream), &
'.',iyear,'-',imonth,'-',iday,'.',suffix
elseif (histfreq(ns) == 'h'.or.histfreq(ns) == 'H') then ! hourly
write(ncfile,'(a,a,i2.2,a,i4.4,a,i2.2,a,i2.2,a,i5.5,a,a)') &
history_file(1:lenstr(history_file))//trim(cstream),'_', &
histfreq_n(ns),'h.',iyear,'-',imonth,'-',iday,'-',sec,'.',suffix
elseif (histfreq(ns) == 'm'.or.histfreq(ns) == 'M') then ! monthly
write(ncfile,'(a,a,i4.4,a,i2.2,a,a)') &
history_file(1:lenstr(history_file))//trim(cstream),'.', &
iyear,'-',imonth,'.',suffix
elseif (histfreq(ns) == 'y'.or.histfreq(ns) == 'Y') then ! yearly
write(ncfile,'(a,a,i4.4,a,a)') &
history_file(1:lenstr(history_file))//trim(cstream),'.', &
iyear,'.',suffix
endif
else ! instantaneous with histfreq > dt
write(ncfile,'(a,a,i4.4,a,i2.2,a,i2.2,a,i5.5,a,a)') &
history_file(1:lenstr(history_file)),'_inst.', &
iyear,'-',imonth,'-',iday,'-',sec,'.',suffix
endif
endif
end subroutine construct_filename
!=======================================================================
! Initializes description of an available field and returns location
! in the available fields array for use in later calls.
!
! 2009 Created by D. Bailey following POP
subroutine define_hist_field(id, vname, vunit, vcoord, vcellmeas, &
vdesc, vcomment, cona, conb, &
ns, vhistfreq)
use ice_calendar, only: histfreq, histfreq_n, nstreams
use ice_domain_size, only: max_nstrm
use ice_exit, only: abort_ice
integer (int_kind), dimension(max_nstrm), intent(out) :: &
id ! location in avail_fields array for use in
! later routines
character (len=*), intent(in) :: &
vname , & ! variable names
vunit , & ! variable units
vcoord , & ! variable coordinates
vcellmeas , & ! variables cell measures
vdesc , & ! variable descriptions
vcomment ! variable comments
real (kind=dbl_kind), intent(in) :: &
cona , & ! multiplicative conversion factor
conb ! additive conversion factor
character (len=*), intent(in) :: &
vhistfreq ! history frequency
integer (kind=int_kind), intent(in) :: &
ns ! history file stream index
integer (kind=int_kind) :: &
ns1 , & ! variable stream loop index
lenf ! length of namelist string
character (len=40) :: stmp
if (histfreq(ns) == 'x') then
call abort_ice("define_hist_fields has histfreq x")
endif
if (ns == 1) id(:) = 0
lenf = len(trim(vhistfreq))
do ns1 = 1, lenf
if (vhistfreq(ns1:ns1) == histfreq(ns)) then
num_avail_hist_fields_tot = num_avail_hist_fields_tot + 1
if (vcoord(11:14) == 'time') then
num_avail_hist_fields_2D = num_avail_hist_fields_2D + 1
elseif (vcoord(11:14) == 'NCAT' .and. vcoord(17:20) == 'time') then
num_avail_hist_fields_3Dc = num_avail_hist_fields_3Dc + 1
elseif (vcoord(11:15) == 'VGRDi' .and. vcoord(17:20) == 'time') then
num_avail_hist_fields_3Dz = num_avail_hist_fields_3Dz + 1
elseif (vcoord(11:15) == 'VGRDb' .and. vcoord(17:20) == 'time') then
num_avail_hist_fields_3Db = num_avail_hist_fields_3Db + 1
elseif (vcoord(11:15) == 'VGRDi' .and. vcoord(17:20) == 'NCAT') then
num_avail_hist_fields_4Di = num_avail_hist_fields_4Di + 1
elseif (vcoord(11:15) == 'VGRDs' .and. vcoord(17:20) == 'NCAT') then
num_avail_hist_fields_4Ds = num_avail_hist_fields_4Ds + 1
elseif (vcoord(11:15) == 'VGRDb' .and. vcoord(17:20) == 'NCAT') then
num_avail_hist_fields_4Db = num_avail_hist_fields_4Db + 1
endif
if (num_avail_hist_fields_tot > max_avail_hist_fields) &
call abort_ice("Need to increase max_avail_hist_fields")
if (num_avail_hist_fields_tot /= &
num_avail_hist_fields_2D + &
num_avail_hist_fields_3Dc + &
num_avail_hist_fields_3Dz + &
num_avail_hist_fields_3Db + &
num_avail_hist_fields_4Di + &
num_avail_hist_fields_4Ds + &
num_avail_hist_fields_4Db) then
call abort_ice("num_avail_hist_fields error")
endif
id(ns) = num_avail_hist_fields_tot
stmp = vname
if (ns > 1) &
write(stmp,'(a,a1,a1)') trim(stmp),'_',vhistfreq(ns1:ns1)
avail_hist_fields(id(ns))%vname = trim(stmp)
avail_hist_fields(id(ns))%vunit = trim(vunit)
avail_hist_fields(id(ns))%vcoord = trim(vcoord)
avail_hist_fields(id(ns))%vcellmeas = trim(vcellmeas)
avail_hist_fields(id(ns))%vdesc = trim(vdesc)
avail_hist_fields(id(ns))%vcomment = trim(vcomment)
avail_hist_fields(id(ns))%cona = cona
avail_hist_fields(id(ns))%conb = conb
avail_hist_fields(id(ns))%vhistfreq = vhistfreq(ns1:ns1)
avail_hist_fields(id(ns))%vhistfreq_n = histfreq_n(ns)
endif
enddo
end subroutine define_hist_field
!=======================================================================
! Accumulates a history field
!
! 2009 Created by D. Bailey following POP
! 2010 Generalized dimension of variables by N. Jeffery, E. Hunke
subroutine accum_hist_field_2D(id, iblk, field_accum, field)
use ice_blocks, only: block, get_block
use ice_calendar, only: nstreams
use ice_domain, only: blocks_ice
use ice_domain_size, only: max_nstrm
use ice_grid, only: tmask
#ifdef AusCOM
use ice_grid, only: umask
#endif
integer (int_kind), dimension(max_nstrm), intent(in) :: &
id ! location in avail_fields array for use in
! later routines
integer (kind=int_kind), intent(in) :: iblk
real (kind=dbl_kind), intent(in) :: &
field_accum(:,:)
real (kind=dbl_kind), intent(inout) :: &
field(:,:,:,:)
type (block) :: &
this_block ! block information for current block
integer (kind=int_kind) :: i,j, ilo, ihi, jlo, jhi, ns, idns
!---------------------------------------------------------------
! increment field
!---------------------------------------------------------------
do ns = 1, nstreams
idns = id(ns)
if (idns > 0) then
this_block = get_block(blocks_ice(iblk),iblk)
ilo = this_block%ilo
ihi = this_block%ihi
jlo = this_block%jlo
jhi = this_block%jhi
do j = jlo, jhi
do i = ilo, ihi
#ifdef AusCOM
if (idns==n_uocn(ns).or.idns==n_vocn(ns)) then
if (umask(i,j,iblk)) then
field(i,j,idns, iblk) = field(i,j,idns, iblk) + field_accum(i,j)
endif
else
if (tmask(i,j,iblk)) then
field(i,j,idns, iblk) = field(i,j,idns, iblk) + field_accum(i,j)
endif
endif
#else
if (tmask(i,j,iblk)) then
field(i,j,idns, iblk) = field(i,j,idns, iblk) + field_accum(i,j)
endif
#endif
enddo
enddo
endif
enddo
end subroutine accum_hist_field_2D
!=======================================================================
! Accumulates a history field
!
! 2009 Created by D. Bailey following POP
! 2010 Generalized dimension of variables by N. Jeffery, E. Hunke
subroutine accum_hist_field_3D(id, iblk, ndim, field_accum, field)
use ice_blocks, only: block, get_block
use ice_calendar, only: nstreams
use ice_domain, only: blocks_ice
use ice_domain_size, only: max_nstrm
use ice_grid, only: tmask
integer (int_kind), dimension(max_nstrm), intent(in) :: &
id ! location in avail_fields array for use in
! later routines
integer (kind=int_kind), intent(in) :: iblk
integer (kind=int_kind), intent(in) :: &
ndim ! third dimension size
real (kind=dbl_kind), intent(in) :: &
field_accum(:,:,:)
real (kind=dbl_kind), intent(inout) :: &
field(:,:,:,:,:)
type (block) :: &
this_block ! block information for current block
integer (kind=int_kind) :: i,j,k, ilo, ihi, jlo, jhi, ns, idns
!---------------------------------------------------------------
! increment field
!---------------------------------------------------------------
do ns = 1, nstreams
idns = id(ns)
if (idns > 0) then
this_block = get_block(blocks_ice(iblk),iblk)
ilo = this_block%ilo
ihi = this_block%ihi
jlo = this_block%jlo
jhi = this_block%jhi
do k = 1, ndim
do j = jlo, jhi
do i = ilo, ihi
if (tmask(i,j,iblk)) then
field(i,j,k,idns,iblk) = field(i,j,k,idns,iblk) + field_accum(i,j,k)
endif
enddo
enddo
enddo
endif
enddo
end subroutine accum_hist_field_3D
!=======================================================================
! Accumulates a history field
!
! 2009 Created by D. Bailey following POP
! 2010 Generalized dimension of variables by N. Jeffery, E. Hunke
subroutine accum_hist_field_4D(id, iblk, ndim3, ndim4, field_accum, field)
use ice_blocks, only: block, get_block
use ice_calendar, only: nstreams
use ice_domain, only: blocks_ice
use ice_domain_size, only: max_nstrm
use ice_grid, only: tmask
integer (int_kind), dimension(max_nstrm), intent(in) :: &
id ! location in avail_fields array for use in
! later routines
integer (kind=int_kind), intent(in) :: iblk
integer (kind=int_kind), intent(in) :: &
ndim3 , & ! third dimension size
ndim4 ! fourth dimension size
real (kind=dbl_kind), intent(in) :: &
field_accum(:,:,:,:)
real (kind=dbl_kind), intent(inout) :: &
field(:,:,:,:,:,:)
type (block) :: &
this_block ! block information for current block
integer (kind=int_kind) :: i,j,k,n,ilo, ihi, jlo, jhi, ns, idns
!---------------------------------------------------------------
! increment field
!---------------------------------------------------------------
do ns = 1, nstreams
idns = id(ns)
if (idns > 0) then
this_block = get_block(blocks_ice(iblk),iblk)
ilo = this_block%ilo
ihi = this_block%ihi
jlo = this_block%jlo
jhi = this_block%jhi
do k = 1, ndim4
do n = 1, ndim3
do j = jlo, jhi
do i = ilo, ihi
if (tmask(i,j,iblk)) then
field(i,j,n,k,idns,iblk) = field(i,j,n,k,idns,iblk) + field_accum(i,j,n,k)
endif
enddo
enddo
enddo
enddo
endif
enddo
end subroutine accum_hist_field_4D
!=======================================================================
end module ice_history_shared
!=======================================================================