-
Notifications
You must be signed in to change notification settings - Fork 153
/
gamap_mod.F
8086 lines (7394 loc) · 288 KB
/
gamap_mod.F
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
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !MODULE: gamap_mod.F
!
! !DESCRIPTION: Module GAMAP\_MOD contains routines to create GAMAP
! "tracerinfo.dat" and "diaginfo.dat" files which are customized to each
! particular GEOS-Chem simulation.
!\\
!\\
! !INTERFACE:
!
MODULE GAMAP_MOD
!
! !USES:
!
USE CMN_SIZE_MOD ! Dimensions of arrays
USE CMN_DIAG_MOD ! Diagnostic parameters
USE inquireMod, ONLY : findFreeLUN
USE PRECISION_MOD ! For GEOS-Chem Precision (fp)
IMPLICIT NONE
PRIVATE
!
! !PUBLIC MEMBER FUNCTIONS:
!
PUBLIC :: DO_GAMAP
!
! !PRIVATE MEMBER FUNCTIONS:
!
PRIVATE :: CREATE_DINFO
PRIVATE :: CREATE_TINFO
PRIVATE :: WRITE_TINFO
PRIVATE :: WRITE_SEPARATOR
PRIVATE :: INIT_DIAGINFO
PRIVATE :: INIT_TRACERINFO
PRIVATE :: INIT_GAMAP
PRIVATE :: CLEANUP_GAMAP
!
! !REMARKS:
! For more information, please see the GAMAP Online Users' Manual:
! http://acmg.seas.harvard.edu/gamap/doc/index.html
!
! !REVISION HISTORY:
! 03 May 2005 - R. Yantosca - Initial version
! (1 ) Minor bug fix for Rn/Pb/Be simulations (bmy, 5/11/05)
! (2 ) Added ND09 diagnostic for HCN/CH3CN simulation. (bmy, 6/30/05)
! (3 ) Added ND04 diagnostic for CO2 simulation (bmy, 7/25/05)
! (4 ) Now make sure all USE statements are USE, ONLY (bmy, 10/3/05)
! (5 ) Add MBO to ND46 diagnostic (tmf, bmy, 10/20/05)
! (6 ) Updated for tagged Hg simulation (cdh, bmy, 4/6/06)
! (7 ) Updated for ND56 lightning flash diagnostics (ltm, bmy, 5/5/06)
! (8 ) Updated for ND42 SOA concentration diagnostics (dkh, bmy, 5/22/06)
! (9 ) Updated for ND36 CH3I simulation diagnostics (bmy, 7/25/06)
! (10) Remove support for GEOS-1 and GEOS-STRAT met fields (bmy, 8/4/06)
! (11) Add routines INIT_DIAGINFO, INIT_TRACERINFO for clarity. Added new
! entries for biomass burning (ND28) and time in tropopshere (ND54)
! in INIT_DIAGINFO and INIT_TRACERINFO. (phs, bmy, 10/17/06)
! (12) Now write GPROD & APROD info to diaginfo.dat, tracerinfo.dat files,
! for the SOA restart files (tmf, havala, bmy, 2/6/07)
! (13) Added ND10 diagnostic for H2/HD simulation. (phs, 9/18/07)
! (14) Change category name for ND31 diagnostic (bmy, 11/16/07)
! (15) Add to tracerinfo.dat file for timeseries and Rn-Pb-Be (bmy, 2/22/08)
! (16) Added ND52 diagnostic for gamma HO2 (jaegle 02/26/09)
! (17) Add gamap info for dicarbonyl simulation (tmf, 3/10/09)
! (18) Add C2H4 in ND46 (ccc, 3/10/09)
! (19) Add EFLUX to ND67 (lin, ccc, 5/29/09)
! (20) Minor bug fixes (bmy, phs, 10/9/09)
! (20) Minor bug fixes (dkh, bmy, 11/19/09)
! (21) Include second satellite overpass diagnostic. Adjust AOD name to 550
! nm from 400 nm. Add additional dust AOD bins. Output values to
! hdf_mod. (amv, bmy, 12/1/09)
! (22) Increase MAXTRACER from 120 to 325 (win, 6/25/09)
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
! 03 Aug 2010 - R. Yantosca - Now move the #include "CMN_SIZE" and
! #include "CMN_DIAG" to the top of module
! 13 Aug 2010 - R. Yantosca - Added modifications for MERRA
! 21 Sep 2010 - R. Yantosca - Removed duplicates in INIT_DIAGINFO
! 21 Oct 2010 - R. Yantosca - Bug fix in INIT_DIAGINFO
! 09 Dec 2010 - C. Carouge - Modify MAXTRACER definition to account for
! 07 Feb 2012 - E. Corbitt - Added diagnostic info for tagged Hg simulation.
! 08 Feb 2012 - R. Yantosca - Add modifications for GEOS-5.7.x
! 01 Aug 2012 - R. Yantosca - Add reference to findFreeLUN from inqure_mod.F90
! 13 Aug 2013 - M. Sulprizio- Add modifications for updated SOA and SOA +
! semivolatile POA simulations (H. Pye)
! 20 Aug 2013 - R. Yantosca - Removed "define.h", this is now obsolete
! 09 Apr 2014 - R. Yantosca - Increase MAXCAT to 160
! 13 Nov 2014 - M. Yannetti - Added PRECISION_MOD
! 06 Aug 2015 - J. Fisher - Add non-reducible snowpack Hg reservoir
! (orig. 29/11/11)
! 20 Jun 2016 - R. Yantosca - Now define species ID flags as module variables
! that are defined only in the INIT phase
! 03 Jan 2018 - M. Sulprizio- Replace UCX CPP switch with Input_Opt%LUCX
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !PRIVATE TYPES:
!
! For "diaginfo.dat"
! INTEGER, PARAMETER :: MAXCAT = 150
INTEGER, PARAMETER :: MAXCAT = 160
INTEGER, PARAMETER :: SPACING = 1000
INTEGER :: NCATS
INTEGER, ALLOCATABLE :: OFFSET(:)
CHARACTER(LEN=40), ALLOCATABLE :: CATEGORY(:)
CHARACTER(LEN=40), ALLOCATABLE :: DESCRIPT(:)
CHARACTER(LEN=255) :: DFILE
! For "tracerinfo.dat"
INTEGER, PARAMETER :: MAXDIAG = MAX_DIAG
INTEGER, PARAMETER :: MAXTRACER = 2 * MAX_TRACER
INTEGER, ALLOCATABLE :: NTRAC(:)
INTEGER, ALLOCATABLE :: INDEX(:,:)
INTEGER, ALLOCATABLE :: MOLC(:,:)
REAL*4, ALLOCATABLE :: MWT(:,:)
REAL*4, ALLOCATABLE :: SCALE(:,:)
CHARACTER(LEN=40), ALLOCATABLE :: NAME(:,:)
CHARACTER(LEN=40), ALLOCATABLE :: FNAME(:,:)
CHARACTER(LEN=40), ALLOCATABLE :: UNIT(:,:)
CHARACTER(LEN=255) :: TFILE
! Other variables
CHARACTER(LEN=16) :: STAMP
CHARACTER(LEN=40) :: SIM_NAME
! Used for ND72
CHARACTER(LEN=40) :: NAME0, NAME1
CHARACTER(LEN=40) :: FNAME0
! Species ID flags (formerly in tracerid_mod.F
INTEGER :: id_ACET, id_ALD2, id_ALK4, id_ASOA1
INTEGER :: id_BCPI, id_BCPO, id_BENZ, id_C2H2
INTEGER :: id_C2H4, id_C2H6, id_C3H8, id_CH2O
INTEGER :: id_CH4, id_CO, id_EOH, id_GLYC
INTEGER :: id_GLYX, id_HAC, id_ISOA1, id_LIMO
INTEGER :: id_MEK, id_MGLY, id_MTPA, id_MTPO
INTEGER :: id_NAP, id_NH3, id_NK1, id_NO
INTEGER :: id_OCPI, id_OCPO, id_OPOA1, id_OPOG1
INTEGER :: id_PAN, id_POA1, id_PRPE
INTEGER :: id_SO2, id_TSOA1, id_POG1, id_POG2
INTEGER :: id_TOLU, id_XYLE, id_HNO3
CONTAINS
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: do_gamap
!
! !DESCRIPTION: Subroutine DO\_GAMAP is the driver program for creating
! the customized GAMAP files "diaginfo.dat" and "tracerinfo.dat".
!\\
!\\
! !INTERFACE:
!
SUBROUTINE DO_GAMAP( am_I_Root, Input_Opt, State_Chm, RC )
!
! !USES:
!
USE ErrCode_Mod
USE Input_Opt_Mod, ONLY : OptInput
USE State_Chm_Mod, ONLY : ChmState
USE TIME_MOD, ONLY : SYSTEM_TIMESTAMP
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN) :: am_I_Root ! Are we on the root CPU?
TYPE(OptInput), INTENT(IN) :: Input_Opt ! Input Options object
TYPE(ChmState), INTENT(IN) :: State_Chm ! Chemistry State object
!
! !OUTPUT PARAMETERS:
!
INTEGER, INTENT(OUT) :: RC ! Success or failure?
!
! !REVISION HISTORY:
! 03 May 2005 - R. Yantosca - Initial version
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
! 25 Mar 2013 - R. Yantosca - Now accept am_I_Root, Input_Opt, RC
! 25 Jun 2014 - R. Yantosca - Now get SIM_NAME from Input_Opt
! 25 Jun 2014 - R. Yantosca - Remove all references to tracer_mod.F
! 03 Sep 2015 - R. Yantosca - Now get State_Chm as an argument
!EOP
!------------------------------------------------------------------------------
!BOC
!=================================================================
! DO_GAMAP begins here!
!=================================================================
! Assume success
RC = GC_SUCCESS
! Allocate and initialize variables
CALL INIT_GAMAP( am_I_Root, Input_Opt, State_Chm, RC )
! Create a timestamp with the system date & time
STAMP = SYSTEM_TIMESTAMP()
! Get simulation name
SIM_NAME = Input_Opt%SIM_NAME
! Write "diaginfo.dat" file
CALL CREATE_DINFO()
! Write "tracerinfo.dat" file
CALL CREATE_TINFO( am_I_Root, Input_Opt, State_Chm, RC )
! Deallocate variables
CALL CLEANUP_GAMAP
END SUBROUTINE DO_GAMAP
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: create_dinfo
!
! !DESCRIPTION: Subroutine CREATE\_DINFO writes information about diagnostic
! categories to a customized "diaginfo.dat" file. (bmy, 5/3/05)
!\\
!\\
! !INTERFACE:
!
SUBROUTINE CREATE_DINFO
!
! !USES:
!
USE FILE_MOD, ONLY : IOERROR
!
! !REVISION HISTORY:
! 03 May 2005 - R. Yantosca - Initial version
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
! 01 Aug 2012 - R. Yantosca - Add reference to findFreeLUN from inqure_mod.F90
! 03 Aug 2012 - R. Yantosca - Move calls to findFreeLUN out of DEVEL block
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: IOS, N
INTEGER :: IU_FILE
!=================================================================
! CREATE_DINFO begins here!
!=================================================================
! Find a free file LUN
IU_FILE = findFreeLUN()
! Open "diaginfo.dat" file for output
OPEN( IU_FILE, FILE=TRIM( DFILE ), STATUS='UNKNOWN', IOSTAT=IOS )
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'create_dinfo:1' )
! Write file header
WRITE( IU_FILE, '(a)' ) '#' // REPEAT( '=', 78 )
WRITE( IU_FILE, 100 ) STAMP
WRITE( IU_FILE, 105 ) TRIM( SIM_NAME )
WRITE( IU_FILE, 110 )
WRITE( IU_FILE, 115 )
WRITE( IU_FILE, '(a)' ) '# File Format:'
WRITE( IU_FILE, '(a)' ) '# ' // REPEAT( '-', 77 )
WRITE( IU_FILE, 120 )
WRITE( IU_FILE, 125 )
WRITE( IU_FILE, 130 )
WRITE( IU_FILE, 135 )
WRITE( IU_FILE, 125 )
WRITE( IU_FILE, '(a)' ) '#'
WRITE( IU_FILE, 140 ) SPACING
WRITE( IU_FILE, '(a)' ) '#' // REPEAT( '=', 78 )
! Loop over categories
DO N = 1, NCATS
! Write one line to "diaginfo.dat" file
WRITE( IU_FILE, 145, IOSTAT=IOS )
& OFFSET(N), ADJUSTL( CATEGORY(N) ), ADJUSTL( DESCRIPT(N) )
! Error check
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'create_dinfo:1' )
ENDDO
! FORMAT strings
100 FORMAT( '# diaginfo.dat: Created by GEOS-CHEM at ', a, /,'#' )
105 FORMAT( '# ****** CUSTOMIZED FOR ', a, ' SIMULATION *****',/,'#' )
110 FORMAT( '# This file contains category names and the offsets',
& ' which they are stored' )
115 FORMAT( '# in file "tracerinfo.dat". This file is read into',
& ' GAMAP by routine', /, '# "ctm_diaginfo.pro".', /,'#' )
120 FORMAT( '# OFFSET (I8 ) Constant to add to tracer numbers',
& ' in order to distinguish', /, '#', 18x, 'for the given',
& ' diagnostic category, as stored in file', /, '#', 18x,
& '"tracerinfo.dat". OFFSET may be up to 8 digits long.' )
125 FORMAT( '# -- (1X ) 1-character spacer' )
130 FORMAT( '# CATEGORY (A40) Category name for CTM diagnostics.',
& ' NOTE: The category name', /, '#', 18x,
& 'can be up to 40 chars long, but historically the',
& ' GEOS-CHEM', /,'#', 18x, 'and GISS models have used an',
& ' 8-character category name.' )
135 FORMAT( '# COMMENT (A ) Descriptive comment string', /,'#' )
140 FORMAT('##### SPACING BETWEEN DIAGNOSTIC CATEGORY OFFSETS = ',i8 )
145 FORMAT( i8, 1x, a40, 1x, a )
! Close file
CLOSE( IU_FILE )
END SUBROUTINE CREATE_DINFO
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: create_tinfo
!
! !DESCRIPTION: Subroutine CREATE\_TINFO writes information about tracers to
! a customized tracerinfo.dat" file.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE CREATE_TINFO( am_I_Root, Input_Opt, State_Chm, RC )
!
! !USES:
!
USE ErrCode_Mod
USE FILE_MOD, ONLY : IOERROR
USE Input_Opt_Mod, ONLY : OptInput
USE State_Chm_Mod, ONLY : ChmState
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN) :: am_I_Root ! Are we on the root CPU?
TYPE(OptInput), INTENT(IN) :: Input_Opt ! Input Options object
TYPE(ChmState), INTENT(IN) :: State_Chm ! Chemistry State object
!
! !OUTPUT PARAMETERS:
!
INTEGER, INTENT(OUT) :: RC ! Success or failure?
!
! !REVISION HISTORY:
! 21 Apr 2005 - R. Yantosca - Initial version
! (1 ) Now write out tracers in ug/m3 (dkh, bmy, 5/22/06)
! (2 ) Now write out GPROD & APROD info (tmf, havala, bmy, 2/6/07)
! 08 Dec 2009 - R. Yantosca - Added ProTeX headers
! 01 Aug 2012 - R. Yantosca - Add reference to findFreeLUN from inqure_mod.F90
! 03 Aug 2012 - R. Yantosca - Move calls to findFreeLUN out of DEVEL block
! 31 Oct 2012 - R. Yantosca - Now save out info about soil NOx restart file
! 25 Mar 2013 - R. Yantosca - Now accept am_I_Root, Input_Opt, RC
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: D, IOS, N, T
INTEGER :: IU_FILE
REAL*4 :: SCALE_NEW
CHARACTER(LEN=2) :: C
CHARACTER(LEN=40) :: UNIT_NEW, NAME_NEW, FNAME_NEW
!=================================================================
! CREATE_TINFO begins here!
!=================================================================
! Assume success
RC = GC_SUCCESS
! Find a free file LUN
IU_FILE = findFreeLUN()
! Open "tracerinfo.dat" file for output
OPEN( IU_FILE, FILE=TRIM( TFILE ), STATUS='UNKNOWN', IOSTAT=IOS )
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'create_tinfo:1' )
! Write file header
WRITE( IU_FILE, '(a)' ) '#' // REPEAT( '=', 78 )
WRITE( IU_FILE, 100 ) STAMP
WRITE( IU_FILE, 105 ) TRIM( SIM_NAME )
WRITE( IU_FILE, 110 )
WRITE( IU_FILE, 115 )
WRITE( IU_FILE, '(a)' ) '# File Format:'
WRITE( IU_FILE, '(a)' ) '# ' // REPEAT( '-', 77 )
WRITE( IU_FILE, 120 )
WRITE( IU_FILE, 125 )
WRITE( IU_FILE, 130 )
WRITE( IU_FILE, 135 )
WRITE( IU_FILE, 140 )
WRITE( IU_FILE, 145 )
WRITE( IU_FILE, 150 )
WRITE( IU_FILE, 125 )
WRITE( IU_FILE, 155 )
! FORMAT strings
100 FORMAT( '# tracerinfo.dat: Created by GEOS-CHEM at ', a, /,'#' )
105 FORMAT( '# ****** CUSTOMIZED FOR ', a, ' SIMULATION *****',/,'#' )
110 FORMAT( '# This file contains name weight and index',
& ' information about GEOS-CHEM' )
115 FORMAT( '# tracers. It is read by routine ',
& '"ctm_tracerinfo.pro" of the GAMAP package.', /,'#' )
120 FORMAT( '# NAME (A8 ) Tracer name (up to 8 chars)' )
125 FORMAT( '# -- (1X ) 1-character spacer' )
130 FORMAT( '# FULLNAME (A30 ) Full tracer name (up to 30 chars)' )
135 FORMAT( '# MOLWT (E10.0) Molecular weight (kg/mole)' )
140 FORMAT( '# C (I3 ) For HC''s: # moles C/moles tracer;',
& ' otherwise set=1' )
145 FORMAT( '# TRACER (I9 ) Tracer number (up to 9 digits)' )
150 FORMAT( '# SCALE (E10.3) Standard scale factor to convert',
& ' to unit given below' )
155 FORMAT( '# UNIT (A40 ) Unit string', /,'#' )
!-------------------------------------
! 0: Tracers [ppbv]
!-------------------------------------
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 0 )
! Loop over tracers
DO T = 1, NTRAC(45)
! GAMAP tracer number
N = ( SPACING * 0 ) + T
! Write tracers [ppbv] to "tracerinfo.dat" file
CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
& MOLC(T,45), SCALE(T,45), UNIT(T,45), N )
ENDDO
!-------------------------------------
! SPACING*1: Tracers [molec/cm2/s]
!-------------------------------------
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 100 )
! Loop over tracers
DO T = 1, NTRAC(45)
! GAMAP tracer number
N = ( SPACING * 1 ) + T
! New scale
SCALE_NEW = 1.0e0
! New unit
IF ( TRIM( UNIT(T,45) ) == 'ppbC' ) THEN
UNIT_NEW = 'atoms C/cm2/s'
ELSE
UNIT_NEW = 'molec/cm2/s'
ENDIF
! Write tracers [molec/cm2/s] to "tracerinfo.dat"
CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
& MOLC(T,45), SCALE_NEW, UNIT_NEW, N )
ENDDO
!-------------------------------------
! SPACING*2: Tracers [molec/cm2]
!-------------------------------------
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 200 )
! Loop over tracers
DO T = 1, NTRAC(45)
! GAMAP tracer number
N = ( SPACING * 2 ) + T
! New scale
SCALE_NEW = 1.0e0
! New unit
IF ( TRIM( UNIT(T,45) ) == 'ppbC' ) THEN
UNIT_NEW = 'atoms C/cm2'
ELSE
UNIT_NEW = 'molec/cm2'
ENDIF
! Write tracers [molec/cm2] to "tracerinfo.dat"
CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
& MOLC(T,45), SCALE_NEW, UNIT_NEW, N )
ENDDO
!-------------------------------------
! SPACING*3: Tracers [kg/s]
!-------------------------------------
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 300 )
! Loop over tracers
DO T = 1, NTRAC(45)
! GAMAP tracer number
N = ( SPACING * 3 ) + T
! New scale
SCALE_NEW = 1.0e0
! New unit
IF ( TRIM( UNIT(T,45) ) == 'ppbC' ) THEN
UNIT_NEW = 'kg C/s'
ELSE
UNIT_NEW = 'kg/s'
ENDIF
! Write tracers [kg/s] to "tracerinfo.dat"
CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
& MOLC(T,45), SCALE_NEW, UNIT_NEW, N )
ENDDO
!-------------------------------------
! SPACING*4: Tracers [kg]
!-------------------------------------
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 400 )
! Loop over tracers
DO T = 1, NTRAC(45)
! GAMAP tracer number
N = ( SPACING * 4 ) + T
! New scale
SCALE_NEW = 1.0e0
! New unit
IF ( TRIM( UNIT(T,45) ) == 'ppbC' ) THEN
UNIT_NEW = 'kg C'
ELSE
UNIT_NEW = 'kg'
ENDIF
! Write tracers [kg] to "tracerinfo.dat"
CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
& MOLC(T,45), SCALE_NEW, UNIT_NEW, N )
ENDDO
! Add this later on (bmy, 5/22/06)
! !-----------------------------------
! ! SPACING*5: Tracers [ug/m3]
! !-----------------------------------
!
! ! Write separator line
! CALL WRITE_SEPARATOR( IU_FILE, 500 )
!
! ! Loop over tracers
! DO T = 1, NTRAC(45)
!
! ! GAMAP tracer number
! N = ( SPACING * 5 ) + T
!
! ! New scale
! SCALE_NEW = 1.0e0
!
! ! New unit
! IF ( TRIM( UNIT(T,45) ) == 'ppbC' ) THEN
! UNIT_NEW = 'ug C/m3'
! ELSE
! UNIT_NEW = 'ug/m3'
! ENDIF
!
! ! Write tracers [kg] to "tracerinfo.dat"
! CALL WRITE_TINFO( IU_FILE, NAME(T,45), FNAME(T,45), MWT(T,45),
! & MOLC(T,45), SCALE_NEW, UNIT_NEW, N )
! ENDDO
! !-------------------------------------
! ! SPACING*6: GPROD & APROD [kg/kg]
! !-------------------------------------
! IF ( Input_Opt%LSOA ) THEN
!
! ! Write separator line
! CALL WRITE_SEPARATOR( IU_FILE, 600 )
!
! ! Loop over tracers
! ! New tracers for SOA simulation
!--- Previous (ccc, 3/17/10)
! DO T = 1, 18
! DO T = 1, 28
!
! ! GAMAP tracer number
! N = ( SPACING * 6 ) + T
!
! ! Make a character
! WRITE( C, '(i2.2)' ) T
!
! ! Tracer name
! NAME_NEW = 'PROD' // C
!
! ! Write tracers [kg] to "tracerinfo.dat"
! CALL WRITE_TINFO( IU_FILE, NAME_NEW, NAME_NEW,
! & REAL(1e0,4), 1, REAL(1e0,4), 'kg/kg', N )
! ENDDO
!
! ENDIF
!-------------------------------------
! SPACING*60: Soil NOx restart file
!-------------------------------------
IF ( Input_Opt%ITS_A_FULLCHEM_SIM ) THEN
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 999 )
! Dry period [h]
NAME_NEW = 'P_DRY'
FNAME_NEW = 'Dry period'
UNIT_NEW = 'hours'
CALL WRITE_TINFO( IU_FILE, NAME_NEW,
& FNAME_NEW, REAL(1e0,4), 1,
& REAL(1e0,4), UNIT_NEW, 60001 )
! Pulse factor [unitless]
NAME_NEW = 'PFACTOR'
FNAME_NEW = 'Pulsing factor'
UNIT_NEW = 'unitless'
CALL WRITE_TINFO( IU_FILE, NAME_NEW,
& FNAME_NEW, REAL(1e0,4), 1,
& REAL(1e0,4), UNIT_NEW, 60002 )
! GWET from previous timestep [unitless]
NAME_NEW = 'GWET_PRV'
FNAME_NEW = 'Soil moisture'
UNIT_NEW = 'unitless'
CALL WRITE_TINFO( IU_FILE, NAME_NEW,
& FNAME_NEW, REAL(1e0,4), 1,
& REAL(1e0,4), UNIT_NEW, 60003 )
! Reservoir of deposited N [ng N/m2]
NAME_NEW = 'N_RESVR'
FNAME_NEW = 'N reservoir'
UNIT_NEW = 'ng N/m2'
CALL WRITE_TINFO( IU_FILE, NAME_NEW,
& FNAME_NEW, REAL(1e0,4), 1,
& REAL(1e0,4), UNIT_NEW, 60004 )
ENDIF
!-------------------------------------
! SPACING*55: PSC restart file
!-------------------------------------
IF ( Input_Opt%ITS_A_FULLCHEM_SIM .and.
& Input_Opt%LUCX ) THEN
! Write separator line
CALL WRITE_SEPARATOR( IU_FILE, 999 )
! Instantaneous PSC state [unitless]
NAME_NEW = 'STATEPSC'
FNAME_NEW = 'Instantaneous PSC state'
UNIT_NEW = 'unitless'
CALL WRITE_TINFO( IU_FILE, NAME_NEW,
& FNAME_NEW, REAL(1e0,4), 1,
& REAL(1e0,4), UNIT_NEW, 55001 )
ENDIF
!-------------------------------------
! All other diagnostics
!-------------------------------------
DO D = 1, MAXDIAG
! If tracers are defined then...
IF ( NTRAC(D) > 0 ) THEN
! Skip ND45, we already wrote tracers above
IF ( D == 45 ) CYCLE
! Write separator
CALL WRITE_SEPARATOR( IU_FILE, D )
! Write tracers to file
DO T = 1, NTRAC(D)
CALL WRITE_TINFO( IU_FILE, NAME(T,D), FNAME(T,D), MWT(T,D),
& MOLC(T,D), SCALE(T,D), UNIT(T,D),
& INDEX(T,D) )
ENDDO
ENDIF
ENDDO
END SUBROUTINE CREATE_TINFO
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: write_tinfo
!
! !DESCRIPTION: Subroutine WRITE\_TINFO writes one line to the customized
! "tracerinfo.dat" file.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE WRITE_TINFO( IU_FILE, NAME, FNAME,
& MWT, MOLC, SCALE, UNIT, N )
!
! !USES:
!
USE FILE_MOD, ONLY : IOERROR
!
! !INPUT PARAMETERS:
!
INTEGER, INTENT(IN) :: IU_FILE ! Logical unit number
CHARACTER(LEN=*), INTENT(IN) :: NAME ! GAMAP short tracer name
CHARACTER(LEN=*), INTENT(IN) :: FNAME ! GAMAP long tracer name
REAL*4, INTENT(IN) :: MWT ! Molecular weight [kg/mole]
INTEGER, INTENT(IN) :: MOLC ! Moles C/mole tracer (for HC's)
INTEGER, INTENT(IN) :: N ! Tracer number
REAL*4, INTENT(IN) :: SCALE ! GAMAP scale factor
CHARACTER(LEN=*), INTENT(IN) :: UNIT ! Unit string
!
! !REVISION HISTORY:
! 03 May 2005 - R. Yantosca - Initial version
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: IOS
!=================================================================
! WRITE_TINFO begins here!
!=================================================================
! Write one line to "tracerinfo.dat" file
WRITE( IU_FILE, 100, IOSTAT=IOS )
& ADJUSTL( NAME ), ADJUSTL( FNAME ), MWT,
& MOLC, N, SCALE, TRIM( UNIT )
! Error check
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'write_tinfo:1' )
! FORMAT string
100 FORMAT( a8, 1x, a30, es10.3, i3, i9, es10.3, 1x, a )
END SUBROUTINE WRITE_TINFO
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: write_separator
!
! !DESCRIPTION: Subroutine WRITE\_SEPARATOR writes a separator block to the
! customized "tracerinfo.dat" file.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE WRITE_SEPARATOR( IU_FILE, DIAG )
!
! !USES:
!
USE FILE_MOD, ONLY : IOERROR
!
! !INPUT PARAMETERS:
!
INTEGER, INTENT(IN) :: IU_FILE
INTEGER, INTENT(IN) :: DIAG ! GEOS-Chem diagnostic number
!
! !REVISION HISTORY:
! 03 May 2005 - R. Yantosca - Initial version
! 06 Feb 2007 - R. Yantosca - Added new header for GPROD & APROD info
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
! 31 Oct 2012 - R. Yantosca - Add write statement for soil NOx restart file
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: IOS
CHARACTER(LEN=79) :: SEPARATOR
!=================================================================
! WRITE_SEPARATOR begins here!
!=================================================================
! Create separator string
SEPARATOR = '#' // REPEAT( '=', 78 )
! Write separator string
WRITE( IU_FILE, '(a)', IOSTAT=IOS ) SEPARATOR
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'write_separator:1' )
! Write the appropriate message
SELECT CASE( DIAG )
CASE( 0 )
WRITE( IU_FILE, 100, IOSTAT=IOS )
CASE( 100 )
WRITE( IU_FILE, 110, IOSTAT=IOS )
CASE( 200 )
WRITE( IU_FILE, 120, IOSTAT=IOS )
CASE( 300 )
WRITE( IU_FILE, 130, IOSTAT=IOS )
CASE( 400 )
WRITE( IU_FILE, 140, IOSTAT=IOS )
CASE( 500 )
WRITE( IU_FILE, 150, IOSTAT=IOS )
CASE( 600 )
WRITE( IU_FILE, 160, IOSTAT=IOS )
CASE( 700 ) !(win, 7/9/09)
WRITE( IU_FILE, 190, IOSTAT=IOS ) !sfarina - this can stay
CASE( 999 )
WRITE( IU_FILE, 170, IOSTAT=IOS )
CASE DEFAULT
WRITE( IU_FILE, 180, IOSTAT=IOS ) DIAG
END SELECT
! Error check
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'write_separator:2' )
! Write separator string
WRITE( IU_FILE, '(a)', IOSTAT=IOS ) SEPARATOR
IF ( IOS /= 0 ) CALL IOERROR( IOS, IU_FILE, 'write_separator:3' )
! FORMAT strings
100 FORMAT( '# GEOS-CHEM tracers [ppbv]' )
110 FORMAT( '# GEOS-CHEM tracers [molec/cm2/s]' )
120 FORMAT( '# GEOS-CHEM tracers [molec/cm2]' )
130 FORMAT( '# GEOS-CHEM tracers [kg/s]' )
140 FORMAT( '# GEOS-CHEM tracers [kg]' )
150 FORMAT( '# GEOS-CHEM tracers [ug/m3]' )
160 FORMAT( '# SOA GPROD & APROD [kg/kg]' )
170 FORMAT( '# Quantities for Soil NOx restart file' )
180 FORMAT( '# ND', i2.2, ' diagnostic quantities' )
190 FORMAT( '# TOMAS aerosol rate [cm-3 s-1]' ) !(win, 7/9/09)
END SUBROUTINE WRITE_SEPARATOR
!EOC
!------------------------------------------------------------------------------
! GEOS-Chem Global Chemical Transport Model !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: init_diaginfo
!
! !DESCRIPTION: Subroutine INIT\_DIAGINFO initializes the CATEGORY, DESCRIPT,
! and OFFSET variables, which are used to define the "diaginfo.dat" file
! for GAMAP.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE INIT_DIAGINFO
!
! !REVISION HISTORY:
! 17 Oct 1996 - R. Yantosca - Initial version
! (1 ) Split this code off from INIT_GAMAP, for clarity. Now declare biomass
! burning emissions w/ offset of 45000. Now declare time in the
! troposphere diagnostic with offset of 46000. (phs, bmy, 10/17/06)
! (2 ) Now add IJ-GPROD & IJ-APROD w/ offset of SPACING*6, for the SOA
! GPROD & APROD restart file. (tmf, havala, bmy, 2/6/07)
! (3 ) Now declare H2-HD sources w/ offset of 48000. Now declare H2-HD
! production/loss w/ offset of 47000. (phs, 9/18/07)
! (4 ) Change diagnostic category for ND31 diagnostic from "PS-PTOP"
! to "PEDGE-$" (bmy, 11/16/07)
! (5 ) Add categories CH4-LOSS, CH4-EMISS and WET-FRAC (kjw, 8/18/09)
! (6 ) Add potential temperature category. (fp, 2/26/10)
! 21 May 2010 - C. Carouge - Add diagnostic for mercury simulation
! 03 Aug 2010 - R. Yantosca - Added ProTeX headers
! 21 Sep 2010 - R. Yantosca - Remove duplicate definitions of CV-FLX-$,
! TURBMC-$, EW-FLX-$, NS-FLX-$, UP-FLX-$
! 21 Oct 2010 - R. Yantosca - Bug fix: MC-FRC-$ should have an offset of
! SPACING*3 since it has units of kg/s.
! 31 Oct 2012 - R. Yantosca - Save soil NOx restart quantities as SPACING*60
! 14 Mar 2013 - M. Payer - Replace NOx emissions with NO emissions as part
! of removal of NOx-Ox partitioning
! 13 Aug 2013 - M. Sulprizio- Add modifications for updated SOA and SOA +
! semivolatile POA simulations (H. Pye)
! 03 Sep 2013 - R. Yantosca - Restored PS-PTOP to avoid issues when using
! diaginfo.dat, tracerinfo.dat w/ REGRIDH_RESTART
! 30 Jan 2014 - R. Yantosca - Add ND60 TOMAS diagnostic catetories
! 06 Aug 2015 - J. Fisher - Add non-reducible snowpack Hg reservoir
! (orig. 29/11/11)
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: N
!=================================================================
! INIT_DIAGINFO begins here!
!=================================================================
N = 1
CATEGORY(N) = 'IJ-AVG-$'
DESCRIPT(N) = 'Tracer concentration'
OFFSET(N) = SPACING * 0
N = N + 1
CATEGORY(N) = 'IJ-24H-$'
DESCRIPT(N) = '24-hr avg tracer conc.'
OFFSET(N) = SPACING * 0
N = N + 1
CATEGORY(N) = 'INST-MAP'
DESCRIPT(N) = 'Instantaneous tracer'
OFFSET(N) = SPACING * 0
N = N + 1
CATEGORY(N) = 'IJ-MAX-$'
DESCRIPT(N) = 'Surface peak concentration'
OFFSET(N) = SPACING * 0
N = N + 1
CATEGORY(N) = 'ANTHSRCE'
DESCRIPT(N) = 'Anthropogenic emissions'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'BIOFSRCE'
DESCRIPT(N) = 'Biofuel emissions'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-AC-$'
DESCRIPT(N) = 'Aircraft NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-AN-$'
DESCRIPT(N) = 'Anthropogenic NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-BIOB'
DESCRIPT(N) = 'Biomass NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-BIOF'
DESCRIPT(N) = 'Biofuel NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-LI-$'
DESCRIPT(N) = 'Lightning NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-SOIL'
DESCRIPT(N) = 'Soil NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-FERT'
DESCRIPT(N) = 'Fertilizer NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'NO-STRT'
DESCRIPT(N) = 'Stratopsheric NO'
OFFSET(N) = SPACING * 1
N = N + 1
CATEGORY(N) = 'INST_COL'
DESCRIPT(N) = 'Instantaneous columns'
OFFSET(N) = SPACING * 2
N = N + 1
CATEGORY(N) = 'CV-FLX-$'
DESCRIPT(N) = 'Convective mass flux'
OFFSET(N) = SPACING * 3
N = N + 1
CATEGORY(N) = 'TURBMC-$'
DESCRIPT(N) = 'PBL mixing mass flux'
OFFSET(N) = SPACING * 3
N = N + 1
CATEGORY(N) = 'EW-FLX-$'
DESCRIPT(N) = 'E/W transport flux'
OFFSET(N) = SPACING * 3
N = N + 1
CATEGORY(N) = 'NS-FLX-$'
DESCRIPT(N) = 'N/S transport flux'
OFFSET(N) = SPACING * 3
N = N + 1