-
Notifications
You must be signed in to change notification settings - Fork 174
/
Copy pathhcoi_gc_diagn_mod.F90
5951 lines (5345 loc) · 248 KB
/
hcoi_gc_diagn_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
!------------------------------------------------------------------------------
! Harvard-NASA Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !MODULE: hcoi_gc_diagn_mod.F90
!
! !DESCRIPTION: Module HCOI\_GC\_Diagn\_Mod.F90 is the GEOS-Chem interface
! module for the HEMCO diagnostics. For every GEOS-Chem emissions diagnostics,
! a corresponding HEMCO diagnostics is created. The HEMCO diagnostics become
! (automatically) filled and updated when calling HEMCO. They are passed
! back to GEOS-Chem when writing the diagnostics (e.g. in diag3.F).
!\\
!\\
! Notes:
! \begin{itemize}
! \item The category specific diagnostics (anthropogenic, aircraft, etc.)
! explicitly assume certain category numbers in the HEMCO configuration
! file (e.g. Cat=1 for anthropogenic, Cat=20 for aircraft, etc.).
! Diagnostics will not represent what they should if these category numbers
! get changed!
! \item In HEMCO, ocean sinks are treated as drydep and the calculated
! deposition velocities are passed to drydep\_mod.F. Hence, no Acetone or ALD2
! ocean sink is calculated by HEMCO and the DMS diagnostics only includes
! the ocean flux (this is NOT the net flux!!).
! If needed, we can build a simple wrapper in hcoi\_gc\_main\_mod.F90 that
! explicitly calculates oceanic fluxes.
! \end{itemize}
!
! !INTERFACE:
!
MODULE HCOI_GC_Diagn_Mod
!
! !USES:
!
! GEOS-Chem diagnostic switches and arrays
USE CMN_SIZE_Mod
#if defined( BPCH_DIAG )
USE CMN_DIAG_Mod
USE DIAG_Mod
USE DIAG53_Mod
USE DIAG56_Mod
#endif
USE HCO_Diagn_Mod
USE HCO_Error_Mod
USE HCO_Interface_Mod
IMPLICIT NONE
PRIVATE
! Get parameters that define the different categories
#include "hcoi_gc_diagn_include.H"
!
! !PUBLIC MEMBER FUNCTIONS:
!
PUBLIC :: HCOI_GC_Diagn_Init
!
! !PRIVATE MEMBER FUNCTIONS:
!
!
! !REMARKS:
! This is currently a "bridge" module to provide backwards compatibility
! with existing GEOS-Chem diagnostics. We will eventually write all
! diagnostics to netCDF format, but we are not quite there yet.
!
! !REVISION HISTORY:
! 04 May 2014 - C. Keller - Initial version.
! 11 Jun 2014 - R. Yantosca - Cosmetic changes in ProTeX headers
! 11 Jun 2014 - R. Yantosca - Now use F90 freeform indentation
! 28 Jul 2014 - C. Keller - Split off from hcoio_diagn_mod.F90 and moved
! from HEMCO/Interface to GeosCore.
! 20 Aug 2014 - R. Yantosca - Add wrapper function GetHemcoId to simplify
! the process of getting the HEMCO species ID
! 20 Aug 2014 - R. Yantosca - Split code into several routines, for clarity
! 26 Aug 2014 - M. Sulprizio- Add modifications for POPs emissions diagnostics
! 23 Sep 2014 - C. Keller - Added Hg diagnostics
! 11 Nov 2014 - C. Keller - Added call to ESMF diagnostics.
! 22 Apr 2015 - M. Sulprizio- Now save out hydrocarbons in units kgC/m2/s
! 27 Feb 2016 - C. Keller - Update to HEMCO v2.0
!EOP
!------------------------------------------------------------------------------
!BOC
CONTAINS
!EOC
!------------------------------------------------------------------------------
! Harvard-NASA Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: HCOI_GC_Diagn_Init
!
! !DESCRIPTION: Subroutine HCOI\_GC\_Diagn\_Init initializes the HEMCO
! diagnostics in GEOS-Chem.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE HCOI_GC_Diagn_Init( am_I_Root, Input_Opt, HcoState, ExtState, RC )
!
! !USES:
!
USE ErrCode_Mod
USE HCO_ExtList_Mod, ONLY : GetExtNr
USE HCO_ExtList_Mod, ONLY : GetExtOpt
USE HCO_State_Mod, ONLY : HCO_GetHcoID
USE HCO_State_Mod, ONLY : HCO_State
USE HCOX_State_Mod, ONLY : Ext_State
USE Input_Opt_Mod, ONLY : OptInput
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN ) :: am_I_Root ! Are we on the root CPU?
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(OptInput), INTENT(INOUT) :: Input_Opt ! Input opts
TYPE(HCO_State), POINTER :: HcoState ! HEMCO state object
TYPE(EXT_State), POINTER :: ExtState ! Extensions state object
INTEGER, INTENT(INOUT) :: RC ! Failure or success
!
! !REMARKS:
! The category numbers must correspond to those in the HEMCO_Config.rc file.
! We will have to come up with a better way of making sure that these
! are consistent in the future.
! CO emissions (ND29)
! --> Anthropogenic, biogenic, and biomass emissions are
! all covered in the respective sections.
! --> CO produced from methanol doesn't seem to be written anymore?!
! Not filled for now.
!
! !REVISION HISTORY:
! 12 Sep 2013 - C. Keller - Initial version
! 11 Jun 2014 - R. Yantosca - Cosmetic changes in ProTeX headers
! 11 Jun 2014 - R. Yantosca - Now use F90 freeform indentation
! 13 Aug 2014 - R. Yantosca - Cosmetic changes
! 20 Aug 2014 - R. Yantosca - Now call wrapper function GetHemcoId to get
! the HEMCO ID # for each species name
! 29 Aug 2014 - R. Yantosca - Now exit if any of the subroutines come
! back with RC = HCO_FAIL
! 22 Apr 2015 - M. Sulprizio- Now save out hydrocarbons in units kgC/m2/s
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
LOGICAL :: YesOrNo
INTEGER :: I, J, HcoID, N, AS
INTEGER :: ExtNr, Cat, Hier
CHARACTER(LEN=31) :: SpcName, DiagnName, Unit
CHARACTER(LEN=255) :: ErrMsg, ThisLoc
!=======================================================================
! HCOI_GC_DIAGN_INIT begins here!
!=======================================================================
! Initialize
RC = HCO_SUCCESS
ErrMsg = ''
ThisLoc = &
' -> at HCOI_GC_Diagn_Init (in module GeosCore/hcoi_gc_diagn_mod.F90)'
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!%%%% NOTE: Emissions for CH4 specialty simulations are passed to %%%%
!%%%% global_ch4_mod.F90 via HEMCO diagnostics, and not directly %%%%
!%%%% from the HEMCO state pointer. Therefore, we need to make %%%%
!%%%% sure that routine DIAGN_CH4 is outside the BPCH_DIAG #if %%%%
!%%%% block. -- Bob Yantosca (25 Jan 2018) %%%%
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CALL Diagn_CH4( am_I_Root, Input_Opt, HcoState, ExtState, RC )
! Trap potential errors
IF ( RC /= HCO_SUCCESS ) THEN
ErrMsg = 'Error encountered in "Diagn_CH4"!'
CALL GC_Error( ErrMsg, RC, ThisLoc )
RETURN
ENDIF
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!%%%% NOTE: Emissions for Hg specialty simulations are passed to %%%%
!%%%% mercury_mod.F90 via HEMCO diagnostics, and not directly %%%%
!%%%% from the HEMCO state pointer. Therefore, we need to make %%%%
!%%%% sure that routine DIAGN_Hg is outside the BPCH_DIAG #if %%%%
!%%%% block. -- Bob Yantosca (25 Jan 2018) %%%%
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CALL Diagn_Hg( am_I_Root, Input_Opt, HcoState, ExtState, RC )
! Trap potential errors
IF ( RC /= HCO_SUCCESS ) THEN
ErrMsg = 'Error encountered in "Diagn_Hg"'
CALL GC_Error( ErrMsg, RC, ThisLoc )
RETURN
ENDIF
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!%%%% NOTE: Some diagnostics for the POPs simulation do not have %%%%
!%%%% any species associated with them, and thus need to be %%%%
!%%%% declared as manual diagnostics. We need to move the call %%%%
!%%%% to Diagn_POPs outside of the #ifdef BPCH_DIAG block. %%%%
!%%%% -- Bob Yantosca (09 Oct 2018) %%%%
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
CALL Diagn_POPs( am_I_Root, Input_Opt, HcoState, ExtState, RC )
! Trap potential errors
IF ( RC /= HCO_SUCCESS ) THEN
ErrMsg = 'Error encountered in "Diagn_POPs"'
CALL GC_Error( ErrMsg, RC, ThisLoc )
RETURN
ENDIF
#if defined( BPCH_DIAG )
!=======================================================================
! Define manual diagnostics
!
! CATEGORY : GEOS-CHEM DIAGNOSTICS
! (1 ) Rn-Pb-Be emissions : ND01
! (2 ) Dust emissions : ND06
! (3 ) Carbon aerosols : ND07
! (4 ) Sea salt emissions : ND08
! (5 ) Acetone ocean source : ND11
! (6 ) Sulfur emisisons : ND13
! (6 ) Biomass emissions : ND07, ND13, ND28, ND29, ND32
! (7 ) NO emissions : ND07, ND13, ND28, ND29, ND32
! (9 ) Anthropogenic emissions : ND29, ND32, ND34
! (10) Biogenic emissions : ND46
! (11) Lightning flash diagnostics : ND56
! (12) PARANOX diagnostics : ND63
! (13) POPs emissions : ND53
!=======================================================================
CALL Diagn_Radon ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Dust ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Carbon ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_SeaSalt ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_AcetSrc ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Sulfur ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Biomass ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_NOsrc ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Anthro ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_Biogenic( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_LFlash ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
CALL Diagn_ParaNOx ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
#if defined( TOMAS )
CALL Diagn_TOMAS ( am_I_Root, Input_Opt, HcoState, ExtState, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
#endif
!=======================================================================
! Define automatic diagnostics (AutoFill)
!=======================================================================
! This is for testing only. Only activate if needed.
IF ( .FALSE. ) THEN ! Deactivated
! IF ( Input_Opt%ITS_A_FULLCHEM_SIM ) THEN
!-------------------------------------
! Hourly emissions
!-------------------------------------
! Do for all emission species
DO I = 1,43
! Get species name
SELECT CASE ( I )
CASE ( 1 )
SpcName = 'NO'
Unit = 'kg/m2/s'
CASE ( 2 )
SpcName = 'CO'
Unit = 'kg/m2/s'
CASE ( 3 )
SpcName = 'NH3'
Unit = 'kg/m2/s'
CASE ( 4 )
SpcName = 'SO2'
Unit = 'kg/m2/s'
CASE ( 5 )
SpcName = 'SO4'
Unit = 'kg/m2/s'
CASE ( 6 )
SpcName = 'GLYX'
Unit = 'kg/m2/s'
CASE ( 7 )
SpcName = 'MGLY'
Unit = 'kg/m2/s'
CASE ( 8 )
SpcName = 'C2H6'
Unit = 'kgC/m2/s'
CASE ( 9 )
SpcName = 'ALK4'
Unit = 'kgC/m2/s'
CASE ( 10 )
SpcName = 'ACET'
Unit = 'kgC/m2/s'
CASE ( 11 )
SpcName = 'MEK'
Unit = 'kgC/m2/s'
CASE ( 12 )
SpcName = 'ALD2'
Unit = 'kgC/m2/s'
CASE ( 13 )
SpcName = 'PRPE'
Unit = 'kgC/m2/s'
CASE ( 14 )
SpcName = 'C3H8'
Unit = 'kgC/m2/s'
7 CASE ( 15 )
SpcName = 'CH2O'
Unit = 'kg/m2/s'
CASE ( 16 )
SpcName = 'BENZ'
Unit = 'kgC/m2/s'
CASE ( 17 )
SpcName = 'TOLU'
Unit = 'kgC/m2/s'
CASE ( 18 )
SpcName = 'XYLE'
Unit = 'kgC/m2/s'
CASE ( 19 )
SpcName = 'C2H4'
Unit = 'kgC/m2/s'
CASE ( 20 )
SpcName = 'C2H2'
Unit = 'kgC/m2/s'
CASE ( 21 )
SpcName = 'CHBr3'
Unit = 'kg/m2/s'
CASE ( 22 )
SpcName = 'CH2Br2'
Unit = 'kg/m2/s'
CASE ( 23 )
SpcName = 'BCPI'
Unit = 'kg/m2/s'
CASE ( 24 )
SpcName = 'BCPO'
Unit = 'kg/m2/s'
CASE ( 25 )
SpcName = 'OCPI'
Unit = 'kg/m2/s'
CASE ( 26 )
SpcName = 'OCPO'
Unit = 'kg/m2/s'
CASE ( 27 )
SpcName = 'RCHO'
Unit = 'kg/m2/s'
CASE ( 28 )
SpcName = 'MACR'
Unit = 'kg/m2/s'
CASE ( 29 )
SpcName = 'DMS'
Unit = 'kg/m2/s'
CASE ( 30 )
SpcName = 'DST1'
Unit = 'kg/m2/s'
CASE ( 31 )
SpcName = 'DST2'
Unit = 'kg/m2/s'
CASE ( 32 )
SpcName = 'DST3'
Unit = 'kg/m2/s'
CASE ( 33 )
SpcName = 'DST4'
Unit = 'kg/m2/s'
CASE ( 34 )
SpcName = 'SALA'
Unit = 'kg/m2/s'
CASE ( 35 )
SpcName = 'SALC'
Unit = 'kg/m2/s'
CASE ( 36 )
SpcName = 'Br2'
Unit = 'kg/m2/s'
CASE ( 37 )
SpcName = 'ISOP'
Unit = 'kgC/m2/s'
CASE ( 38 )
SpcName = 'Rn'
Unit = 'kg/m2/s'
CASE ( 39 )
SpcName = 'O3'
Unit = 'kg/m2/s'
CASE ( 40 )
SpcName = 'PAN'
Unit = 'kg/m2/s'
CASE ( 41 )
SpcName = 'HNO3'
Unit = 'kg/m2/s'
CASE ( 42 )
SpcName = 'MTPA'
Unit = 'kgC/m2/s'
CASE ( 43 )
SpcName = 'EOH'
Unit = 'kgC/m2/s'
CASE DEFAULT
SpcName = 'DUMMY'
END SELECT
HcoID = HCO_GetHcoID( TRIM(SpcName), HcoState )
IF ( HcoID > 0 ) THEN
CALL Diagn_Create ( am_I_Root, &
cName = 'EMIS_'//TRIM(SpcName), &
HcoState = HcoState, &
ExtNr = -1, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 2, &
LevIDx = -1, &
OutUnit = TRIM(Unit), &
AutoFill = 1, &
COL = HcoState%Diagn%HcoDiagnIDDefault, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
ENDIF
!-------------------------------------
! Emissions per category (NO only)
!-------------------------------------
IF ( TRIM(SpcName) == 'NO' .and. HcoID > 0 ) THEN
! There are 3 different categories
DO J = 1, 6
SELECT CASE ( J )
CASE ( 1 )
DiagnName = 'EMIS_NO_ANTHRO'
ExtNr = 0
Cat = 1
CASE ( 2 )
DiagnName = 'EMIS_NO_AVIATION'
ExtNr = 0
Cat = 20
CASE ( 3 )
DiagnName = 'EMIS_NO_PARANOX'
ExtNr = 102
Cat = -1
CASE ( 4 )
DiagnName = 'EMIS_NO_LIGHTNING'
ExtNr = 103
Cat = -1
CASE ( 5 )
DiagnName = 'EMIS_NO_SOIL'
ExtNr = 104
Cat = -1
CASE ( 6 )
DiagnName = 'EMIS_NO_BIOMASS'
ExtNr = 111
Cat = -1
CASE DEFAULT
DiagnName = 'EMIS_NO_DUMMY'
ExtNr = 999
Cat = 999
END SELECT
CALL Diagn_Create ( am_I_Root, &
cName = DiagnName, &
HcoState = HcoState, &
ExtNr = ExtNr, &
Cat = Cat, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 2, &
LevIDx = -1, &
OutUnit = 'kg/m2/s', &
AutoFill = 1, &
COL = HcoState%Diagn%HcoDiagnIDDefault, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
ENDDO ! J
ENDIF ! NO
ENDDO ! I
! ENDIF ! fullchem
ENDIF ! testing toggle
! Leave w/ success
RC = HCO_SUCCESS
#endif
END SUBROUTINE HCOI_GC_Diagn_Init
!EOC
!------------------------------------------------------------------------------
! Harvard-NASA Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: Diagn_Radon
!
! !DESCRIPTION: Subroutine Diagn\_Radon initializes diagnostics for the
! Rn-Pb-Be simulation (ND01).
!\\
!\\
! !INTERFACE:
!
SUBROUTINE Diagn_Radon( am_I_Root, Input_Opt, HcoState, ExtState, RC )
!
! !USES:
!
USE HCO_ExtList_Mod, ONLY : GetExtNr
USE HCO_State_Mod, ONLY : HCO_State
USE HCOX_State_Mod, ONLY : Ext_State
USE Input_Opt_Mod, ONLY : OptInput
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN ) :: am_I_Root ! Are we on the root CPU?
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(OptInput), INTENT(INOUT) :: Input_Opt ! Input opts
TYPE(HCO_State), POINTER :: HcoState ! HEMCO state object
TYPE(EXT_State), POINTER :: ExtState ! Extensions state object
INTEGER, INTENT(INOUT) :: RC ! Failure or success
!
! !REMARKS:
! Split off code from HCOI_GC_Diagn_Init into smaller routines in order to
! make the code more manageable.
!
! !REVISION HISTORY:
! 20 Aug 2014 - R. Yantosca - Initial version
! 21 Aug 2014 - R. Yantosca - Exit for simulations that don't use Rn-Pb-Be
! 03 Sep 2014 - R. Yantosca - Don't define diagnostic container for Pb
! 03 Sep 2014 - R. Yantosca - Change units from kg/m2/s to kg; also in diag3.F
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: ExtNr, HcoID, N
CHARACTER(LEN=31) :: DiagnName
CHARACTER(LEN=255) :: MSG
CHARACTER(LEN=255) :: LOC = 'DIAGN_RADON (hcoi_gc_diagn_mod.F90)'
!=======================================================================
! Define ND01 diagnostics (Rn-Pb-Be emissions)
!=======================================================================
! Assume success
RC = HCO_SUCCESS
#if defined( BPCH_DIAG )
! Exit if the Rn-Pb-Be simulation is not selected
IF ( .not. Input_Opt%ITS_A_RnPbBe_SIM ) RETURN
! Define diagnostics
IF ( ( ExtState%GC_RnPbBe > 0 ) .and. ( ND01 > 0 ) ) THEN
! HEMCO extension # for Rn-Pb-Be
ExtNr = GetExtNr( HcoState%Config%ExtList, 'GC_Rn-Pb-Be' )
IF ( ExtNr <= 0 ) THEN
CALL HCO_Error ( 'Cannot find Rn-Pb-Be extension', RC, THISLOC=LOC )
RETURN
ENDIF
!-------------------------------------------
! %%%%% Rn222 %%%%%
!-------------------------------------------
! HEMCO species ID
HcoID = GetHemcoId( 'Rn222', HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
DiagnName = 'AD01_Rn_SOURCE'
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 2, &
LevIDx = -1, &
OutUnit = 'kg/s', &
AutoFill = 1, &
COL = HcoState%Diagn%HcoDiagnIDManual, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
!-------------------------------------------
! %%%%% Be7 %%%%%
!-------------------------------------------
! HEMCO species ID
HcoID = GetHemcoId( 'Be7', HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
DiagnName = 'AD01_Be7_SOURCE'
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 3, &
LevIDx = -1, &
OutUnit = 'kg/s', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
!-------------------------------------------
! %%%%% Be7 in stratosphere %%%%%
!-------------------------------------------
! HEMCO species ID
HcoID = GetHemcoId( 'Be7Strat', HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
DiagnName = 'AD01_Be7Strat_SOURCE'
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 3, &
LevIDx = -1, &
OutUnit = 'kg/s', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
!-------------------------------------------
! %%%%% Be10 %%%%%
!-------------------------------------------
! HEMCO species ID
HcoID = GetHemcoId( 'Be10', HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
DiagnName = 'AD01_Be10_SOURCE'
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 3, &
LevIDx = -1, &
OutUnit = 'kg/s', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
!-------------------------------------------
! %%%%% Be10 in stratosphere %%%%%
!-------------------------------------------
! HEMCO species ID
HcoID = GetHemcoId( 'Be10Strat', HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
DiagnName = 'AD01_Be10Strat_SOURCE'
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 3, &
LevIDx = -1, &
OutUnit = 'kg/s', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
ENDIF
#endif
END SUBROUTINE Diagn_Radon
!EOC
!------------------------------------------------------------------------------
! Harvard-NASA Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: Diagn_Dust
!
! !DESCRIPTION: Subroutine Diagn\_Dust initializes diagnostics for the
! mineral dust aerosols (ND06).
!\\
!\\
! !INTERFACE:
!
SUBROUTINE Diagn_Dust( am_I_Root, Input_Opt, HcoState, ExtState, RC )
!
! !USES:
!
USE CMN_SIZE_Mod, ONLY : NDSTBIN
USE HCO_ExtList_Mod, ONLY : GetExtNr
USE HCO_State_Mod, ONLY : HCO_State
USE HCOX_State_Mod, ONLY : Ext_State
USE Input_Opt_Mod, ONLY : OptInput
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN ) :: am_I_Root ! Are we on the root CPU?
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(OptInput), INTENT(INOUT) :: Input_Opt ! Input opts
TYPE(HCO_State), POINTER :: HcoState ! HEMCO state object
TYPE(EXT_State), POINTER :: ExtState ! Extensions state object
INTEGER, INTENT(INOUT) :: RC ! Failure or success
!
! !REMARKS:
! Split off code from HCOI_GC_Diagn_Init into smaller routines in order to
! make the code more manageable.
!
! !REVISION HISTORY:
! 20 Aug 2014 - R. Yantosca - Initial version
! 21 Aug 2014 - R. Yantosca - Exit for simulations that don't use dust
! 30 Sep 2014 - R. Yantosca - Update for TOMAS dust species
! 25 Oct 2016 - R. Yantosca - Make sure to cast INTEGER to LOGICAL values
! before comparing them in an IF statement
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
LOGICAL :: Is_DustDead
LOGICAL :: Is_DustGinoux
INTEGER :: ExtNr, Cat, HcoID, I, N
CHARACTER(LEN=1) :: ISTR1
CHARACTER(LEN=2) :: ISTR2
CHARACTER(LEN=15) :: SpcName
CHARACTER(LEN=31) :: DiagnName
CHARACTER(LEN=255) :: MSG
CHARACTER(LEN=255) :: LOC = 'DIAGN_DUST (hcoi_gc_diagn_mod.F90)'
!=======================================================================
! DIAGN_DUST begins here!
!=======================================================================
! Assume success
RC = HCO_SUCCESS
#if defined( BPCH_DIAG )
! Exit if we are doing a specialty simulation w/o dust
IF ( ( .not. Input_Opt%ITS_A_FULLCHEM_SIM ) .and. &
( .not. Input_Opt%ITS_AN_AEROSOL_SIM ) ) THEN
RETURN
ENDIF
! Now use local LOGICAL variables to save ExtState%DustDead and
! ExtState%DustGinoux. This will make sure these variables are
! cast to LOGICAL, so that we can compare them in the same IF
! statement. Otherwise GNU Fortran will choke. (bmy, 10/25/16)
Is_DustDead = ( ExtState%DustDead > 0 )
Is_DustGinoux = ( ExtState%DustGinoux > 0 )
! Define diagnostics if dust is used
IF ( ND06 > 0 ) THEN
! Get Ext. Nr
IF ( Is_DustDead ) THEN
ExtNr = GetExtNr( HcoState%Config%ExtList, 'DustDead' )
Cat = -1
ELSEIF ( Is_DustGinoux ) THEN
ExtNr = GetExtNr( HcoState%Config%ExtList, 'DustGinoux' )
Cat = -1
ELSE
! Use offline dust emissions
ExtNr = 0
Cat = CATEGORY_NATURAL
ENDIF
! Do for each dust bin
DO I = 1, NDSTBIN
#if defined( TOMAS )
! Get species name (i.e. DUST1 .. DUST40) for TOMAS simulatiosn
IF ( I < 10 ) THEN
WRITE( ISTR1,'(i1)' ) I
SpcName = 'DUST' // ISTR1
ELSE
WRITE( ISTR2,'(i2)' ) I
SpcName = 'DUST' // ISTR2
ENDIF
#else
! Get species name (i.e. DST1 .. DST4) for non TOMAS simualtions
WRITE( ISTR1,'(i1)' ) I
SpcName = 'DST' // ISTR1
#endif
DiagnName = 'AD06_' // TRIM( SpcName )
! HEMCO species ID
HcoID = GetHemcoId( TRIM( SpcName ), HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = Cat, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 2, &
LevIDx = -1, &
OutUnit = 'kg', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
ENDDO
! Add diagnostics for dust alkalinity
IF ( Input_Opt%LDSTUP ) THEN
! Get Ext. Nr of used extension
ExtNr = GetExtNr( HcoState%Config%ExtList, 'DustAlk' )
IF ( ExtNr <= 0 ) THEN
CALL HCO_Error( 'Cannot find dust alk extension', RC, &
THISLOC=LOC )
RETURN
ENDIF
! Do for each dust bin
DO I = 1, NDSTBIN
! Get species name (i.e. DSTAL1 .. DSTAL4)
WRITE( ISTR1,'(i1)' ) I
SpcName = 'DSTAL' // ISTR1
DiagnName = 'AD06_' // TRIM( SpcName )
! HEMCO species ID
HcoID = GetHemcoId( TRIM( SpcName ), HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
! Create diagnostic container
CALL Diagn_Create( am_I_Root, &
HcoState = HcoState, &
cName = TRIM( DiagnName ), &
ExtNr = ExtNr, &
Cat = -1, &
Hier = -1, &
HcoID = HcoID, &
SpaceDim = 2, &
LevIDx = -1, &
OutUnit = 'kg', &
COL = HcoState%Diagn%HcoDiagnIDManual, &
AutoFill = 1, &
RC = RC )
IF ( RC /= HCO_SUCCESS ) RETURN
ENDDO
ENDIF
ENDIF
#endif
END SUBROUTINE Diagn_Dust
!EOC
!------------------------------------------------------------------------------
! Harvard-NASA Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: Diagn_Carbon
!
! !DESCRIPTION: Subroutine Diagn\_Carbon initializes diagnostics for the
! carbon aerosols (ND07).
!\\
!\\
! !INTERFACE:
!
SUBROUTINE Diagn_Carbon( am_I_Root, Input_Opt, HcoState, ExtState, RC )
!
! !USES:
!
USE HCO_ExtList_Mod, ONLY : GetExtNr
USE HCO_State_Mod, ONLY : HCO_State
USE HCOX_State_Mod, ONLY : Ext_State
USE Input_Opt_Mod, ONLY : OptInput
USE State_Chm_Mod, only : Ind_
!
! !INPUT PARAMETERS:
!
LOGICAL, INTENT(IN ) :: am_I_Root ! Are we on the root CPU?
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(OptInput), INTENT(INOUT) :: Input_Opt ! Input opts
TYPE(HCO_State), POINTER :: HcoState ! HEMCO state object
TYPE(EXT_State), POINTER :: ExtState ! Extensions state object
INTEGER, INTENT(INOUT) :: RC ! Failure or success
!
! !REMARKS:
! Biomass diagnostics (ND28) are defined in routine Diagn_Biomass.
!
! !REVISION HISTORY:
! 20 Aug 2014 - R. Yantosca - Initial version
! 21 Aug 2014 - R. Yantosca - Exit for simulations that don't use carbon
! 16 Jun 2016 - C. Miller - Now define species ID's with Ind_ function
! 27 Mar 2017 - M. Sulprizio- Make anthropogenic emissions diagnostics 3D
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: ExtNr, HcoID, Cat, N, I, J
CHARACTER(LEN=31) :: SpcName, SrcName, DiagnName
CHARACTER(LEN=255) :: MSG
CHARACTER(LEN=255) :: LOC = 'DIAGN_CARBON (hcoi_gc_diagn_mod.F90)'
INTEGER :: id_POA1, id_POG1
INTEGER :: SpaceDim
!=======================================================================
! DIAGN_CARBON begins here!
!=======================================================================
! Assume success
RC = HCO_SUCCESS
#if defined( BPCH_DIAG )
! Exit if we are doing a specialty simulation w/o carbon aerosols
IF ( ( .not. Input_Opt%ITS_A_FULLCHEM_SIM ) .and. &
( .not. Input_Opt%ITS_AN_AEROSOL_SIM ) ) THEN
RETURN
ENDIF
! Define advected species ID's
id_POA1 = Ind_('POA1','A')
id_POG1 = Ind_('POG1','A')
! Define diagnostics
IF ( ND07 > 0 .AND. Input_Opt%LCARB ) THEN
! Do for all species
DO I = 1, 4
! Get species name
SELECT CASE ( I )
CASE ( 1 )
SpcName = 'BCPI'
CASE ( 2 )
SpcName = 'BCPO'
CASE ( 3 )
SpcName = 'OCPI'
IF ( id_POA1 > 0 ) SpcName = 'POA1'
CASE ( 4 )
SpcName = 'OCPO'
IF ( id_POG1 > 0 ) SpcName = 'POG1'
END SELECT
! HEMCO species ID
HcoID = GetHemcoId( SpcName, HcoState, LOC, RC )
IF ( RC /= HCO_SUCCESS ) RETURN
SrcName = 'ANTHRO'
Cat = CATEGORY_ANTHRO
SpaceDim= 3