-
Notifications
You must be signed in to change notification settings - Fork 32
/
hco_state_mod.F90
847 lines (761 loc) · 28.2 KB
/
hco_state_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
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !MODULE: hco_state_mod.F90
!
! !DESCRIPTION: Module HCO\_State\_Mod contains definitions and sub-
! routines for the HEMCO state derived type. The HEMCO state object
! (HcoState) contains all information related to the HEMCO run, such
! as the HEMCO clock, information on the emission grid and the data
! fields to be read, details on all used species, various physical
! constants, etc.
! It also contains the final assembled 3D flux and 2D deposition
! arrays (to be passed to the overlaying model) and a pointer to the
! HEMCO configuration object (Config). The latter contains error and
! traceback information and holds the data fields (in the data list
! ConfigList).
!\\
!\\
! The HEMCO state object (typically called HcoState) for a given HEMCO
! run must be defined on the HEMCO-model interface level (subroutine
! HcoState\_Init).
!\\
!\\
! !INTERFACE:
!
MODULE HCO_State_Mod
!
! USES:
!
USE HCO_Types_Mod
USE HCO_Error_Mod
USE HCO_Arr_Mod
USE HCO_VertGrid_Mod
#if defined(ESMF_)
USE ESMF
#endif
IMPLICIT NONE
PRIVATE
!
! !PUBLIC MEMBER FUNCTIONS:
!
PUBLIC :: HcoState_Init
PUBLIC :: HcoState_Final
PUBLIC :: HCO_GetModSpcID
PUBLIC :: HCO_GetHcoID
PUBLIC :: HCO_GetExtHcoID
!=========================================================================
! HCO_State: Main HEMCO State derived type
!=========================================================================
TYPE, PUBLIC :: HCO_State
!%%%%% Species information %%%%%
LOGICAL :: amIRoot ! Is this the root CPU?
!%%%%% Species information %%%%%
INTEGER :: nSpc ! # of species
TYPE(HcoSpc), POINTER :: Spc(:) ! list of species
!%%%%% Emission grid information %%%%%
INTEGER :: NX ! # of x-pts (lons) on this CPU
INTEGER :: NY ! # of y-pts (lats) on this CPU
INTEGER :: NZ ! # of z-pts (levs) on this CPU
TYPE(HcoGrid), POINTER :: Grid ! HEMCO grid information
TYPE(HcoClock), POINTER :: Clock ! HEMCO clock
! Data array
TYPE(Arr3D_HP), POINTER :: Buffer3D ! Placeholder to store temporary
! 3D array. Emissions will be
! written into this array if
! option FillBuffer = .TRUE.
!%%%%% Constants and timesteps %%%%%
TYPE(HcoPhys), POINTER :: Phys ! Physical constants
REAL(sp) :: TS_EMIS ! Emission timestep [s]
REAL(sp) :: TS_CHEM ! Chemical timestep [s]
REAL(sp) :: TS_DYN ! Dynamic timestep [s]
!%%%%% Aerosol quantities %%%%%
INTEGER :: nDust ! # of dust species
LOGICAL :: MarinePOA ! MUse marine organic aerosols?
TYPE(HcoMicroPhys), POINTER :: MicroPhys ! Microphysics settings
!%%%%% Run time options %%%%%
TYPE(HcoOpt), POINTER :: Options ! HEMCO run options
!%%%%% ReadLists %%%%%
TYPE(RdList), POINTER :: ReadLists
LOGICAL :: SetReadListCalled
!%%%%% Emissions linked list %%%%%%
TYPE(ListCont), POINTER :: EmisList
INTEGER :: nnEmisCont = 0 ! # of container in EmisList
!%%%%% Data container indeces %%%%%
! Element i of cIDList will point to data-container with container
! ID i (e.g. cIDList(3) points to data-container with cID = 3).
TYPE(cIDListPnt), POINTER :: cIDList(:) => NULL()
! # of defined data containers. Will be automatically increased
! by one when creating a new data container (DataCont_Init)
INTEGER :: nnDataCont = 0
! Define object based on TimeIdxCollection derived type
TYPE(TimeIdxCollection), POINTER :: AlltIDx => NULL()
! HEMCO configuration object
TYPE(ConfigObj), POINTER :: Config => NULL()
! Pointer to beginning of collections linked list
TYPE(DiagnBundle), POINTER :: Diagn => NULL()
!%%%%% ESMF objects
#if defined(ESMF_)
TYPE(ESMF_GridComp), POINTER :: GridComp
TYPE(ESMF_State), POINTER :: IMPORT
TYPE(ESMF_State), POINTER :: EXPORT
#endif
#ifdef ADJOINT
LOGICAL :: isAdjoint
#endif
END TYPE HCO_State
!
! !REVISION HISTORY:
! 20 Aug 2013 - C. Keller - Initial version, adapted from state_chm_mod.F90
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
CONTAINS
!EOC
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: HcoState_Init
!
! !DESCRIPTION: Routine HcoState\_Init initializes the HEMCO state object.
! This initializes (nullifies) all pointers and sets all HEMCO settings
! and options to default values.
! The here defined pointers are defined/connected at the HEMCO-model
! interface level.
! The passed HEMCO configuration object (HcoConfig) must be defined,
! e.g. this subroutine must be called after having read (at least
! stage 1 of) the HEMCO configuration file (Config\_ReadFile in
! hco\_config\_mod.F90).
!\\
!\\
! !INTERFACE:
!
SUBROUTINE HcoState_Init( HcoState, HcoConfig, nSpecies, RC )
!
! !USES:
!
USE HCO_EXTLIST_MOD, ONLY : GetExtOpt, CoreNr
USE HCO_UNIT_MOD, ONLY : HCO_UnitTolerance
!
! !INPUT PARAMETERS:
!
INTEGER, INTENT(IN) :: nSpecies ! # HEMCO species
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(HCO_State), POINTER :: HcoState ! HEMCO State object
TYPE(ConfigObj), POINTER :: HcoConfig ! HEMCO Config object
INTEGER, INTENT(INOUT) :: RC ! Return code
!
! !REVISION HISTORY:
! 20 Aug 2013 - C. Keller - Adapted from gigc_state_chm_mod.F90
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: I, AS
INTEGER :: UnitTolerance
LOGICAL :: FOUND
CHARACTER(LEN=255) :: MSG, LOC
!=====================================================================
! HcoState_Init begins here!
!=====================================================================
LOC = 'HcoState_Init (HCO_STATE_MOD.F90)'
! For error handling
CALL HCO_ENTER (HcoConfig%Err, LOC, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 0', RC, THISLOC=LOC )
RETURN
ENDIF
!=====================================================================
! Allocate emission field vectors
!=====================================================================
! Check if already allocated
IF ( ASSOCIATED(HcoState)) THEN
CALL HCO_WARNING( HcoConfig%Err,'HcoState already allocated!', RC )
RETURN
ENDIF
ALLOCATE ( HcoState )
! Is this the Root CPU?
HcoState%amIRoot = HcoConfig%amIRoot
! Initialize vector w/ species information
HcoState%nSpc = nSpecies
IF ( nSpecies > 0 ) THEN
ALLOCATE ( HcoState%Spc (nSpecies ), STAT=AS )
IF ( AS /= 0 ) THEN
CALL HCO_ERROR( 'Species', RC )
RETURN
ENDIF
ENDIF
! Initalize species information. The effective values for species
! names, model IDs, etc. are set in the HEMCO-model interface
! routine.
DO I = 1, nSpecies
HcoState%Spc(I)%HcoID = I
HcoState%Spc(I)%ModID = -1
HcoState%Spc(I)%SpcName = ''
HcoState%Spc(I)%MW_g = 0.0_dp
HcoState%Spc(I)%HenryK0 = 0.0_dp
HcoState%Spc(I)%HenryCR = 0.0_dp
HcoState%Spc(I)%HenryPKA = 0.0_dp
! Initialize data arrays. Pass dimension zero, which
! will just create a pointer to the data array (XX%Val).
! Will specify the arrays in HEMCO-model interface routine
! or when writing to them for the first time.
CALL Hco_ArrInit( HcoState%Spc(I)%Emis, 0, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 1', RC, THISLOC=LOC )
RETURN
ENDIF
CALL Hco_ArrInit( HcoState%Spc(I)%Conc, 0, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 2', RC, THISLOC=LOC )
RETURN
ENDIF
CALL Hco_ArrInit( HcoState%Spc(I)%Depv, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 3', RC, THISLOC=LOC )
RETURN
ENDIF
ENDDO !I
!=====================================================================
! Initialize grid
!=====================================================================
! Initialize grid dimensions.
HcoState%NX = 0
HcoState%NY = 0
HcoState%NZ = 0
ALLOCATE ( HcoState%Grid, STAT = AS )
IF ( AS /= 0 ) THEN
CALL HCO_ERROR( 'HEMCO grid', RC )
RETURN
ENDIF
! Initialize grid arrays.
CALL HCO_ArrInit ( HcoState%Grid%XMID, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 4', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%YMID, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 5', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%XEDGE, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 6', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%YEDGE, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 7', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%PEDGE, 0, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 8', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%YSIN, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 9', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%AREA_M2, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 10', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%PBLHEIGHT, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 11', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%BXHEIGHT_M, 0, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 12', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%ZSFC, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 13', RC, THISLOC=LOC )
RETURN
ENDIF
CALL HCO_ArrInit ( HcoState%Grid%PSFC, 0, 0, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 14', RC, THISLOC=LOC )
RETURN
ENDIF
! Initialize vertical grid
HcoState%Grid%ZGRID => NULL()
CALL HCO_VertGrid_Init( HcoState%Grid%ZGRID, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 15', RC, THISLOC=LOC )
RETURN
ENDIF
!=====================================================================
! Set misc. parameter
!=====================================================================
! Physical constants (Source: NIST, 2014)
ALLOCATE ( HcoState%Phys, STAT = AS )
IF ( AS /= 0 ) THEN
CALL HCO_ERROR( 'HEMCO physical constants', RC )
RETURN
ENDIF
HcoState%Phys%Avgdr = 6.022140857e23_dp
HcoState%Phys%PI = 3.14159265358979323_dp
HcoState%Phys%PI_180 = HcoState%Phys%PI / 180.0_dp
HcoState%Phys%Re = 6.3710072e+6_dp ! Was 6.375e6_dp
HcoState%Phys%AIRMW = 28.9644_dp ! Was 28.97_dp
HcoState%Phys%g0 = 9.80665_dp
HcoState%Phys%Rd = 287.0_dp
HcoState%Phys%Rdg0 = HcoState%Phys%Rd / HcoState%Phys%g0
HcoState%Phys%RSTARG = 8.3144598_dp ! Was 8.31450_dp
! Timesteps
HcoState%TS_EMIS = 0.0_sp
HcoState%TS_CHEM = 0.0_sp
HcoState%TS_DYN = 0.0_sp
#ifdef ADJOINT
HcoState%isAdjoint = .false.
#endif
! Nullify temporary array. This array may be used as temporary
! place to write emissions into.
HcoState%Buffer3D => NULL()
CALL HCO_ArrInit( HcoState%Buffer3D, 0, 0, 0, RC )
IF ( RC /= 0 ) RETURN
! Dust bins (set default to 4)
HcoState%nDust = 4
! Turn off marine POA by default
HcoState%MarinePOA = .FALSE.
! Aerosol options
ALLOCATE ( HcoState%MicroPhys, STAT = AS )
IF ( AS /= 0 ) THEN
CALL HCO_ERROR( 'HEMCO aerosol microphysics options', RC )
RETURN
ENDIF
HcoState%MicroPhys%nBins = 0
HcoState%MicroPhys%nActiveModeBins = 0
NULLIFY( HcoState%MicroPhys%BinBound )
! Default HEMCO options
! ==> execute HEMCO core; use all species, categories; not ESMF; not dryrun
ALLOCATE( HcoState%Options )
HcoState%Options%ExtNr = 0
HcoState%Options%SpcMin = 1
HcoState%Options%SpcMax = -1
HcoState%Options%CatMin = 1
HcoState%Options%CatMax = -1
HcoState%Options%AutoFillDiagn = .TRUE.
HcoState%Options%HcoWritesDiagn = .FALSE.
HcoState%Options%FillBuffer = .FALSE.
HcoState%Options%isESMF = .FALSE.
HcoState%Options%isDryRun = .FALSE.
! SetReadList has not been called yet
HcoState%SetReadListCalled = .FALSE.
! Get negative flag value from configuration file. If not found, set to 0.
CALL GetExtOpt ( HcoConfig, CoreNr, 'Negative values', &
OptValInt=HcoState%Options%NegFlag, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 16', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%NegFlag = 0
! Get PBL_DRYDEP flag from configuration file. If not found, set to default
! value of false.
CALL GetExtOpt ( HcoConfig, CoreNr, 'PBL dry deposition', &
OptValBool=HcoState%Options%PBL_DRYDEP, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 17', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%PBL_DRYDEP = .FALSE.
! Apply uniform scale factors specified in HEMCO_Config.rc?
CALL GetExtOpt ( HcoConfig, CoreNr, 'Scale emissions', &
OptValBool=HcoState%Options%ScaleEmis, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 18', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%ScaleEmis = .TRUE.
! Only shift hh/mm when applying time shift?
CALL GetExtOpt ( HcoConfig, CoreNr, 'Cap time shift', &
OptValBool=HcoState%Options%TimeShiftCap, &
Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 19', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%TimeShiftCap = .FALSE.
! Get MaxDepExp from configuration file. If not found, set to default
! value of 20.
CALL GetExtOpt ( HcoConfig, CoreNr, 'Maximum dep x ts', &
OptValHp=HcoState%Options%MaxDepExp, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 20', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%MaxDepExp = 20.0_hp
! Get binary mask flag from configuration file. If not found, set to default
! value of TRUE.
CALL GetExtOpt ( HcoConfig, CoreNr, 'Mask fractions', &
OptValBool=HcoState%Options%MaskFractions, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 21', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%MaskFractions = .FALSE.
CALL GetExtOpt ( HcoConfig, CoreNr, 'ConfigField to diagnostics', &
OptValBool=HcoState%Options%Field2Diagn, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 22', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%Field2Diagn = .FALSE.
CALL GetExtOpt ( HcoConfig, CoreNr, 'Vertical weights', &
OptValBool=HcoState%Options%VertWeight, Found=Found, RC=RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 23', RC, THISLOC=LOC )
RETURN
ENDIF
IF ( .NOT. Found ) HcoState%Options%VertWeight = .TRUE.
! Make sure ESMF pointers are not dangling
#if defined(ESMF_)
HcoState%GridComp => NULL()
HcoState%IMPORT => NULL()
HcoState%EXPORT => NULL()
#endif
! Read unit tolerance
UnitTolerance = HCO_UnitTolerance( HcoConfig )
! Connect to config object
HcoState%Config => HcoConfig
! Make sure pointers are not dangling
HcoState%Diagn => NULL()
HcoState%EmisList => NULL()
HcoState%ReadLists => NULL()
HcoState%Clock => NULL()
HcoState%cIDList => NULL()
HcoState%AlltIDx => NULL()
! Verbose mode
IF ( HCO_IsVerb( HcoConfig%Err ) ) THEN
WRITE(MSG,'(A68)') 'Initialized HEMCO state. Will use the following settings:'
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,I2)') 'Unit tolerance : ', UnitTolerance
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,I2)') 'Negative values : ', HcoState%Options%NegFlag
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,L2)') 'Mask fractions : ', HcoState%Options%MaskFractions
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,L2)') 'Do drydep over entire PBL : ', HcoState%Options%PBL_DRYDEP
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,F6.2)') 'Upper limit for deposition x ts: ', HcoState%Options%MaxDepExp
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,L2)') 'Scale emissions : ', HcoState%Options%ScaleEmis
CALL HCO_MSG(HcoConfig%Err,MSG)
WRITE(MSG,'(A33,L2)') 'Cap time shift : ', HcoState%Options%TimeShiftCap
CALL HCO_MSG(HcoConfig%Err,MSG)
ENDIF
! Leave w/ success
CALL HCO_LEAVE ( HcoConfig%Err, RC )
END SUBROUTINE HcoState_Init
!EOC
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: HcoState_Final
!
! !DESCRIPTION: Routine HcoState\_CLEANUP cleans up HcoState.
!\\
!\\
! !INTERFACE:
!
SUBROUTINE HcoState_Final( HcoState )
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(HCO_State), POINTER :: HcoState ! HEMCO State object
!
! !REVISION HISTORY:
! 20 Aug 2013 - C. Keller - Adapted from gigc_state_chm_mod.F90
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: I
!=====================================================================
! HcoState_Final begins here!
!=====================================================================
! Deallocate buffer array
CALL HCO_ArrCleanup ( HcoState%Buffer3D )
! Deallocate all species arrays
IF ( ASSOCIATED ( HcoState%Spc ) .and. HcoState%nSpc > 0 ) THEN
DO I = 1, HcoState%nSpc
CALL HCO_ArrCleanup( HcoState%Spc(I)%Emis )
CALL HCO_ArrCleanup( HcoState%Spc(I)%Conc )
CALL HCO_ArrCleanup( HcoState%Spc(I)%Depv )
ENDDO
DEALLOCATE( HcoState%Spc )
ENDIF
! Deallocate grid information
IF ( ASSOCIATED ( HcoState%Grid) ) THEN
CALL HCO_VertGrid_Cleanup( HcoState%Grid%ZGRID )
CALL HCO_ArrCleanup( HcoState%Grid%XMID )
CALL HCO_ArrCleanup( HcoState%Grid%YMID )
CALL HCO_ArrCleanup( HcoState%Grid%XEDGE )
CALL HCO_ArrCleanup( HcoState%Grid%YEDGE )
CALL HCO_ArrCleanup( HcoState%Grid%PEDGE )
CALL HCO_ArrCleanup( HcoState%Grid%YSIN )
CALL HCO_ArrCleanup( HcoState%Grid%AREA_M2 )
CALL HCO_ArrCleanup( HcoState%Grid%PBLHEIGHT )
CALL HCO_ArrCleanup( HcoState%Grid%BXHEIGHT_M )
CALL HCO_ArrCleanup( HcoState%Grid%ZSFC )
CALL HCO_ArrCleanup( HcoState%Grid%PSFC )
DEALLOCATE(HcoState%Grid)
ENDIF
! Deallocate microphysics information
IF ( ASSOCIATED( HcoState%MicroPhys ) ) THEN
IF ( HcoState%MicroPhys%nBins > 0 ) THEN
IF ( ASSOCIATED( HcoState%MicroPhys%BinBound ) ) THEN
NULLIFY( HcoState%MicroPhys%BinBound )
ENDIF
DEALLOCATE( HcoState%MicroPhys )
ENDIF
ENDIf
! Cleanup various types
IF ( ASSOCIATED ( HcoState%Options ) ) DEALLOCATE ( HcoState%Options )
IF ( ASSOCIATED ( HcoState%Phys ) ) DEALLOCATE ( HcoState%Phys )
#if defined(ESMF_)
HcoState%GridComp => NULL()
HcoState%IMPORT => NULL()
HcoState%EXPORT => NULL()
#endif
END SUBROUTINE HcoState_Final
!EOC
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: HCO_GetModSpcId
!
! !DESCRIPTION: Function HCO\_GetModSpcId returns the model species index
! of a species by name. Returns -1 if given species is not found, 0 if
! name corresponds to the HEMCO wildcard character.
!\\
!\\
! !INTERFACE:
!
FUNCTION HCO_GetModSpcID( name, HcoState ) RESULT( Indx )
!
! !USES:
!
USE HCO_EXTLIST_MOD, ONLY : HCO_GetOpt
!
! !INPUT PARAMETERS:
!
CHARACTER(LEN=*), INTENT(IN) :: name ! Species name
!
! !INPUT/OUTPUT PARAMETERS:
!
TYPE(HCO_State), INTENT(INOUT) :: HcoState ! HEMCO State
!
! !RETURN VALUE:
!
INTEGER :: Indx ! Index of this species
!
! !REVISION HISTORY:
! 20 Aug 2013 - C. Keller - Adapted from gigc_state_chm_mod.F90
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: N
! Default
Indx = -1
! Return 0 if wildcard character
IF ( TRIM(name) == TRIM(HCO_GetOpt(HcoState%Config%ExtList,'Wildcard')) ) THEN
Indx = 0
RETURN
ENDIF
! Loop over all species names
DO N = 1, HcoState%nSpc
! Return the index of the sought-for species
IF( TRIM( name ) == TRIM( HcoState%Spc(N)%SpcName ) ) THEN
Indx = HcoState%Spc(N)%ModID
EXIT
ENDIF
ENDDO
END FUNCTION HCO_GetModSpcID
!EOC
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !IROUTINE: HCO_GetHcoId
!
! !DESCRIPTION: Function HCO\_GetHcoIdHCO returns the HEMCO species index
! of a species by name. Returns -1 if given species is not found, 0 if
! name corresponds to the HEMCO wildcard character.
!\\
!\\
! !INTERFACE:
!
FUNCTION HCO_GetHcoID( name, HcoState ) RESULT( Indx )
!
! !USES:
!
USE HCO_EXTLIST_MOD, ONLY : HCO_GetOpt
!
! !INPUT PARAMETERS:
!
CHARACTER(LEN=*), INTENT(IN) :: name ! Species name
TYPE(HCO_State), INTENT(INOUT) :: HcoState ! HEMCO State
!
! !RETURN VALUE:
!
INTEGER :: Indx ! Index of this species
!
! !REVISION HISTORY:
! 20 Aug 2013 - C. Keller - Adapted from gigc_state_chm_mod.F90
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: N
! Default
Indx = -1
! Return 0 if wildcard character
IF ( TRIM(name) == TRIM(HCO_GetOpt(HcoState%Config%ExtList,'Wildcard')) ) THEN
Indx = 0
RETURN
ENDIF
! Loop over all species names
DO N = 1, HcoState%nSpc
! Return the index of the sought-for species
IF( TRIM( name ) == TRIM( HcoState%Spc(N)%SpcName ) ) THEN
Indx = N
EXIT
ENDIF
ENDDO
END FUNCTION HCO_GetHcoID
!EOC
!------------------------------------------------------------------------------
! Harmonized Emissions Component (HEMCO) !
!------------------------------------------------------------------------------
!BOP
!
! !ROUTINE: HCO_GetExtHcoID
!
! !DESCRIPTION: Subroutine HCO\_GetExtHcoID returns the HEMCO species IDs
! and names for all species assigned to the given extension (identified by
! its extension number).
!\\
!\\
! !INTERFACE:
!
SUBROUTINE HCO_GetExtHcoID( HcoState, ExtNr, HcoIDs, &
SpcNames, nSpc, RC )
!
! !USES:
!
USE HCO_CHARPAK_MOD, ONLY : STRSPLIT
USE HCO_EXTLIST_MOD, ONLY : GetExtSpcStr
USE HCO_EXTLIST_MOD, ONLY : HCO_GetOpt
!
! !INPUT PARAMETERS:
!
TYPE(HCO_State), POINTER :: HcoState
INTEGER, INTENT(IN ) :: ExtNr ! Extension #
!
! !OUTPUT PARAMETERS:
!
INTEGER, ALLOCATABLE, INTENT( OUT) :: HcoIDs(:) ! Species IDs
!
! !INPUT/OUTPUT PARAMETERS:
!
CHARACTER(LEN=*), ALLOCATABLE, INTENT(INOUT) :: SpcNames(:) ! Species names
INTEGER, INTENT(INOUT) :: nSpc ! # of species
INTEGER, INTENT(INOUT) :: RC ! Success/fail
!
! !REVISION HISTORY:
! 10 Jan 2014 - C. Keller: Initialization (update)
! See https://github.com/geoschem/hemco for complete history
!EOP
!------------------------------------------------------------------------------
!BOC
!
! !LOCAL VARIABLES:
!
INTEGER :: I, AS
CHARACTER(LEN=255) :: MSG, LOC
CHARACTER(LEN=2047) :: SpcStr, SUBSTR(255)
CHARACTER(LEN=2047) :: TmpStr
!======================================================================
! HCO_GetExtHcoID begins here
!======================================================================
! Enter
LOC = 'HCO_GetExtHcoID (hco_state_mod.F90)'
! Get all species names belonging to extension Nr. ExtNr
CALL GetExtSpcStr( HcoState%Config, ExtNr, SpcStr, RC )
IF ( RC /= HCO_SUCCESS ) THEN
CALL HCO_ERROR( 'ERROR 24', RC, THISLOC=LOC )
RETURN
ENDIF
! Split character into species string.
CALL STRSPLIT( SpcStr, HCO_GetOpt(HcoState%Config%ExtList,'Separator'), SUBSTR, nSpc )
! nothing to do if there are no species
IF ( nSpc == 0 ) RETURN
! Allocate arrays
IF ( ALLOCATED(HcoIDs ) ) DEALLOCATE(HcoIDs )
IF ( ALLOCATED(SpcNames) ) DEALLOCATE(SpcNames)
ALLOCATE(HcoIDs(nSpc), SpcNames(nSpc), STAT=AS)
#if defined( MODEL_GEOS )
SpcNames(:) = ''
HcoIDs(:) = -1
#endif
IF ( AS/=0 ) THEN
CALL HCO_ERROR('HcoIDs allocation error', RC, THISLOC=LOC)
RETURN
ENDIF
! Extract species information
DO I = 1, nSpc
!---------------------------------------------------------------------
! Prior to 6/26/18:
! This code can cause issues with certain compiler versions,
! so let's rewrite it slightly (bmy, 6/26/18)
!SpcNames(I) = SUBSTR(I)
!HcoIDs(I) = HCO_GetHcoID( TRIM(SpcNames(I)), HcoState )
!---------------------------------------------------------------------
! Rewrite this code to be a little more friendly to compilers with
! strict string-parsing syntax, such as ifort 17. ALSO NOTE: We don't
! necessarily have to do the TRIM in the call to HCO_GetHcoID, because
! the species name will be TRIMmed internally. We have noticed that
! some compilers don't like taking the TRIM of an array element as
! an argument to a function call. (bmy, 6/26/18)
TmpStr = SubStr(I)
SpcNames(I) = TRIM( TmpStr )
HcoIDs(I) = HCO_GetHcoID( TmpStr, HcoState )
ENDDO
! Return w/ success
RC = HCO_SUCCESS
END SUBROUTINE HCO_GetExtHcoID
!EOC
END MODULE HCO_STATE_MOD