-
Notifications
You must be signed in to change notification settings - Fork 14
/
SU2G_GridCompMod.F90
1556 lines (1252 loc) · 63 KB
/
SU2G_GridCompMod.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
#include "MAPL_Generic.h"
!=============================================================================
!BOP
! !MODULE: SU2G_GridCompMod - GOCART refactoring of the SU gridded component
! !INTERFACE:
module SU2G_GridCompMod
! !USES:
use ESMF
use MAPL
use GOCART2G_MieMod
use Chem_AeroGeneric
use iso_c_binding, only: c_loc, c_f_pointer, c_ptr
use GOCART2G_Process ! GOCART2G process library
use GA_EnvironmentMod
use MAPL_StringTemplate, only: StrTemplate
!$ use omp_lib
implicit none
private
integer, parameter :: instanceComputational = 1
integer, parameter :: instanceData = 2
integer, parameter :: DP=kind(1.0d0)
! gram molecular weights of species
real, parameter :: fMassSulfur = 32., fMassSO2 = 64., fMassSO4 = 96., &
fMassDMS = 62., fMassMSA = 96.
real, parameter :: cpd = 1004.16
! relative position of sulfate tracers
integer, parameter :: nDMS = 1, &
nSO2 = 2, &
nSO4 = 3, &
nMSA = 4
real, parameter :: OCEAN=0.0, LAND = 1.0, SEA_ICE = 2.0
! !PUBLIC MEMBER FUNCTIONS:
PUBLIC SetServices
! !DESCRIPTION: This module implements GOCART's Sulfer (SU) Gridded Component.
! !REVISION HISTORY:
! 04January2024 Collow - Update to ChemSettling Call
! 08July2020 Sherman, da Silva, Darmenov, Clune - First attempt at refactoring.
!EOP
!===========================================================================
! !Sulfer state
type :: ThreadWorkspace
integer :: nymd_last = -1 ! Previous nymd. Updated daily
! Degassing volcanoes
integer :: nVolc = 0
real, allocatable, dimension(:) :: vLat, &
vLon, &
vSO2, &
vElev, &
vCloud
integer, allocatable, dimension(:) :: vStart, &
vEnd
! Explosive volcanoes
integer :: nVolcE = 0
real, allocatable, dimension(:) :: vLatE, &
vLonE, &
vSO2E, &
vElevE, &
vCloudE
integer, allocatable, dimension(:) :: vStartE, &
vEndE
! Other point emissions of Sulfate (SO4)
integer :: nPts = -1
integer, allocatable, dimension(:) :: pstart, pend
real, allocatable, dimension(:) :: pLat, &
pLon, &
pBase, &
pTop, &
pEmis
logical :: firstRun = .true.
integer :: nymd_oxidants = -1 ! Update the oxidant files?
logical :: recycle_H2O2 = .false.
end type ThreadWorkspace
type, extends(GA_Environment) :: SU2G_GridComp
integer :: myDOW = -1 ! my Day of the week: Sun=1, Mon=2,...,Sat=7
logical :: diurnal_bb ! diurnal biomass burning
real :: eAircraftFuel ! Aircraft emission factor: go from kg fuel to kg SO2
real :: aviation_layers(4) ! heights of the LTO, CDS and CRS layers
real :: fSO4anth ! Fraction of anthropogenic emissions that are SO4
!logical :: firstRun = .true.
real, allocatable :: rmed(:) ! Median radius of lognormal number distribution
real, allocatable :: sigma(:) ! Sigma of lognormal number distribution
!real, pointer :: h2o2_init(:,:,:)
! Special handling for volcanic emissions
character(len=255) :: volcano_srcfilen_degassing
character(len=255) :: volcano_srcfilen_explosive
! Workspace for point emissions
logical :: doing_point_emissions = .false.
character(len=255) :: point_emissions_srcfilen ! filename for pointwise emissions
type(ThreadWorkspace), allocatable :: workspaces(:)
end type SU2G_GridComp
type wrap_
type (SU2G_GridComp), pointer :: PTR !=> null()
end type wrap_
contains
!============================================================================
!BOP
! !IROUTINE: SetServices
! !INTERFACE:
subroutine SetServices ( GC, RC )
! !ARGUMENTS:
type (ESMF_GridComp), intent(INOUT) :: GC ! gridded component
integer, intent( OUT) :: RC ! return code
! DESCRIPTION: This version uses MAPL_GenericSetServices, which sets
! the Initialize and Finalize services to generic versions. It also
! allocates our instance of a generic state and puts it in the
! gridded component (GC). Here we only set the two-stage run method
! and declare the data services.
! !REVISION HISTORY:
! 08July2020 E.Sherman, A.Da Silva, A.Darmenov, T.Clune First attempt at refactoring
!EOP
!============================================================================
!
! !Locals
character (len=ESMF_MAXSTR) :: COMP_NAME
type (ESMF_Config) :: cfg
type (ESMF_Config) :: universal_cfg
type (wrap_) :: wrap
type (SU2G_GridComp), pointer :: self
character (len=ESMF_MAXSTR) :: field_name
integer :: i
real :: DEFVAL
logical :: data_driven=.true.
logical :: file_exists
integer :: num_threads
__Iam__('SetServices')
!****************************************************************************
! Begin...
! Get my name and set-up traceback handle
! ---------------------------------------
call ESMF_GridCompGet (GC, NAME=COMP_NAME, config=universal_cfg, __RC__)
Iam = trim(COMP_NAME) // '::' // Iam
! Wrap internal state for storing in GC
! -------------------------------------
allocate (self, __STAT__)
wrap%ptr => self
num_threads = MAPL_get_num_threads()
allocate(self%workspaces(0:num_threads-1), __STAT__)
! Load resource file
! -------------------
cfg = ESMF_ConfigCreate (__RC__)
inquire(file='SU2G_instance_'//trim(COMP_NAME)//'.rc', exist=file_exists)
if (file_exists) then
call ESMF_ConfigLoadFile (cfg, 'SU2G_instance_'//trim(COMP_NAME)//'.rc', __RC__)
else
if (mapl_am_i_root()) print*,'SU2G_instance_'//trim(COMP_NAME)//'.rc does not exist! loading SU2G_instance_SU.rc instead'
call ESMF_ConfigLoadFile (cfg, 'SU2G_instance_SU.rc', __RC__)
end if
! process generic config items
call self%GA_Environment%load_from_config( cfg, universal_cfg, __RC__)
allocate(self%rmed(self%nbins), __STAT__)
allocate(self%sigma(self%nbins), __STAT__)
! process SU-specific items
call ESMF_ConfigGetAttribute(cfg, self%volcano_srcfilen_degassing, label='volcano_srcfilen_degassing:', __RC__)
call ESMF_ConfigGetAttribute(cfg, self%volcano_srcfilen_explosive, label='volcano_srcfilen_explosive:', __RC__)
call ESMF_ConfigGetAttribute(cfg, self%eAircraftFuel, label='aircraft_fuel_emission_factor:', __RC__)
call ESMF_ConfigGetAttribute(cfg, self%fSO4anth, label='so4_anthropogenic_fraction:', __RC__)
call ESMF_ConfigGetAttribute(cfg, self%rmed, label='particle_radius_number:', __RC__)
call ESMF_ConfigGetAttribute(cfg, self%sigma, label='sigma:', __RC__)
call ESMF_ConfigFindLabel (cfg, 'aviation_vertical_layers:', __RC__)
do i=1,size(self%aviation_layers)
call ESMF_ConfigGetAttribute (cfg, self%aviation_layers(i), __RC__)
end do
call ESMF_ConfigGetAttribute (cfg, self%point_emissions_srcfilen, &
label='point_emissions_srcfilen:', default='/dev/null', __RC__)
if ( (index(self%point_emissions_srcfilen,'/dev/null')>0) ) then
self%doing_point_emissions = .false. ! disable it if no file specified
else
self%doing_point_emissions = .true. ! we are good to go
end if
! Is SU data driven?
! ------------------
call determine_data_driven (COMP_NAME, data_driven, __RC__)
! Set entry points
! ------------------------
call MAPL_GridCompSetEntryPoint (GC, ESMF_METHOD_INITIALIZE, Initialize, __RC__)
call MAPL_GridCompSetEntryPoint (GC, ESMF_METHOD_RUN, Run, __RC__)
if (data_driven .neqv. .true.) then
call MAPL_GridCompSetEntryPoint (GC, ESMF_Method_Run, Run2, __RC__)
end if
DEFVAL = 0.0
! Import and Internal states if data instance
! -------------------------------------------
if (data_driven) then
! Pressure at layer edges
! -----------------------
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'PLE', &
LONG_NAME = 'air_pressure', &
UNITS = 'Pa', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationEdge, &
RESTART = MAPL_RestartSkip, __RC__)
! RH: is between 0 and 1
! ----------------------
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'RH2', &
LONG_NAME = 'Rel_Hum_after_moist', &
UNITS = '1', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
call MAPL_AddInternalSpec(gc,&
short_name='SO4', &
long_name='Sulphate aerosol', &
units='kg kg-1', &
dims=MAPL_DimsHorzVert, &
vlocation=MAPL_VlocationCenter, &
restart=MAPL_RestartOptional, &
! friendlyto='DYNAMICS:TURBULENCE:MOIST', &
add2export=.true., __RC__)
call MAPL_AddImportSpec(gc,&
short_name='climSO4', &
long_name='Sulphate aerosol', &
units='kg kg-1', &
dims=MAPL_DimsHorzVert, &
vlocation=MAPL_VlocationCenter, &
restart=MAPL_RestartOptional, __RC__)
do i = 1, self%nbins
write(field_name, '(A, I0.3)') '', i
! ! dry deposition
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'climSUDP'//trim(field_name), &
LONG_NAME = 'Sulfate dry deposition (bin '//trim(field_name)//')', &
UNITS = 'kg kg-1 s-1', &
DIMS = MAPL_DimsHorzOnly, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
! ! wet deposition
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'climSUWT'//trim(field_name), &
LONG_NAME = 'Sulfate wet deposition (bin '//trim(field_name)//')', &
UNITS = 'kg kg-1 s-1', &
DIMS = MAPL_DimsHorzOnly, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
! ! gravitational settling
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'climSUSD'//trim(field_name), &
LONG_NAME = 'Sulfate settling (bin '//trim(field_name)//')', &
UNITS = 'kg kg-1 s-1', &
DIMS = MAPL_DimsHorzOnly, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
! ! convective scavenging
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'climSUSV'//trim(field_name), &
LONG_NAME = 'Sulfate convective scavenging (bin '//trim(field_name)//')', &
UNITS = 'kg kg-1 s-1', &
DIMS = MAPL_DimsHorzOnly, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
end do
end if ! (data_driven)
if (.not. data_driven) then
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'SU_H2O2', &
LONG_NAME = 'source species' , &
UNITS = '1', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'SU_OH', &
LONG_NAME = 'source species' , &
UNITS = '1', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
call MAPL_AddImportSpec(GC, &
SHORT_NAME = 'SU_NO3', &
LONG_NAME = 'source species' , &
UNITS = '1', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationCenter, &
RESTART = MAPL_RestartSkip, __RC__)
end if
! Import, Export, Internal states for computational instance
! ----------------------------------------------------------
if (.not. data_driven) then
#include "SU2G_Export___.h"
#include "SU2G_Import___.h"
#include "SU2G_Internal___.h"
end if
! This state holds fields needed by radiation
! ---------------------------------------------
call MAPL_AddExportSpec(GC, &
SHORT_NAME = trim(COMP_NAME)//'_AERO', &
LONG_NAME = 'aerosols_from_'//trim(COMP_NAME), &
UNITS = 'kg kg-1', &
DIMS = MAPL_DimsHorzVert, &
VLOCATION = MAPL_VLocationCenter, &
DATATYPE = MAPL_StateItem, __RC__)
! This bundle is needed by surface for snow albedo modification
! by aerosol settling and deposition
! DEVELOPMENT NOTE - Change to StateItem in future
! ---------------------------------------------------------------
call MAPL_AddExportSpec(GC, &
SHORT_NAME = trim(COMP_NAME)//'_AERO_DP', &
LONG_NAME = 'aerosol_deposition_from_'//trim(COMP_NAME), &
UNITS = 'kg m-2 s-1', &
DIMS = MAPL_DimsHorzOnly, &
DATATYPE = MAPL_BundleItem, __RC__)
! Store internal state in GC
! --------------------------
call ESMF_UserCompSetInternalState ( GC, 'SU2G_GridComp', wrap, _RC )
! Set generic services
! ----------------------------------
call MAPL_GenericSetServices (GC, __RC__)
RETURN_(ESMF_SUCCESS)
end subroutine SetServices
!============================================================================
!BOP
! !IROUTINE: Initialize
! !INTERFACE:
subroutine Initialize (GC, IMPORT, EXPORT, CLOCK, RC)
! !ARGUMENTS:
type (ESMF_GridComp), intent(inout) :: GC ! Gridded component
type (ESMF_State), intent(inout) :: IMPORT ! Import state
type (ESMF_State), intent(inout) :: EXPORT ! Export state
type (ESMF_Clock), intent(inout) :: CLOCK ! The clock
integer, optional, intent( out) :: RC ! Error code
! !DESCRIPTION: This initializes SU Grid Component.
! !REVISION HISTORY:
! 08July2019 E.Sherman First attempt at refactoring
!EOP
!============================================================================
! !Locals
character (len=ESMF_MAXSTR) :: COMP_NAME
type (MAPL_MetaComp), pointer :: MAPL
type (ESMF_Grid) :: grid
type (ESMF_State) :: internal
type (ESMF_State) :: aero
type (ESMF_State) :: providerState
type (ESMF_Config) :: cfg, universal_cfg
type (ESMF_FieldBundle) :: Bundle_DP
type (wrap_) :: wrap
type (SU2G_GridComp), pointer :: self
integer, allocatable :: mieTable_pointer(:)
integer :: i, dims(3), km
integer :: instance
type (ESMF_Field) :: field, fld
character (len=ESMF_MAXSTR) :: prefix, diurnal_bb
real, pointer, dimension(:,:) :: lats
real, pointer, dimension(:,:) :: lons
real :: CDT ! chemistry timestep (secs)
integer :: HDT ! model timestep (secs)
real, pointer, dimension(:,:,:) :: int_ptr
logical :: data_driven
integer :: NUM_BANDS
logical :: bands_are_present
real, pointer, dimension(:,:,:) :: ple
type(ESMF_Calendar) :: calendar
type(ESMF_Time) :: currentTime
type(ESMF_Time) :: ringTime
type(ESMF_TimeInterval) :: ringInterval
integer :: year, month, day, hh, mm, ss
real, dimension(4) :: Vect_Hcts
integer, allocatable, dimension(:) :: channels_
integer :: nmom_
character(len=ESMF_MAXSTR) :: file_
logical :: file_exists
__Iam__('Initialize')
!****************************************************************************
! Begin...
! Get the target components name and set-up traceback handle.
! -----------------------------------------------------------
call ESMF_GridCompGet (GC, grid=grid, name=COMP_NAME, config=universal_cfg, __RC__)
Iam = trim(COMP_NAME) // '::' //trim(Iam)
! Get my internal MAPL_Generic state
! -----------------------------------
call MAPL_GetObjectFromGC (GC, MAPL, __RC__)
! Get my internal private state
! -----------------------------
call ESMF_UserCompGetInternalState(GC, 'SU2G_GridComp', wrap, STATUS)
VERIFY_(STATUS)
self => wrap%ptr
! Get dimensions
! ---------------
call MAPL_GridGet (grid, localCellCountPerDim=dims, __RC__ )
km = dims(3)
self%km = km
! Get DTs
! -------
call MAPL_GetResource(mapl, HDT, Label='RUN_DT:', __RC__)
call MAPL_GetResource(mapl, CDT, Label='GOCART_DT:', default=real(HDT), __RC__)
self%CDT = CDT
! Check whether to de-activate diurnal biomass burning (default is *on*)
! ----------------------------------------------------------------------
call ESMF_ConfigGetAttribute(universal_cfg, diurnal_bb, label='DIURNAL_BIOMASS_BURNING:', &
default='YES', __RC__)
diurnal_bb = ESMF_UtilStringUpperCase(diurnal_bb, __RC__)
if (trim(diurnal_bb) == 'YES') then
self%diurnal_bb = .true.
else
self%diurnal_bb = .false.
end if
! Load resource file and get number of bins
! -------------------------------------------
cfg = ESMF_ConfigCreate (__RC__)
inquire(file='SU2G_instance_'//trim(COMP_NAME)//'.rc', exist=file_exists)
if (file_exists) then
call ESMF_ConfigLoadFile (cfg, 'SU2G_instance_'//trim(COMP_NAME)//'.rc', __RC__)
else
if (mapl_am_i_root()) print*,'SU2G_instance_'//trim(COMP_NAME)//'.rc does not exist! loading SU2G_instance_SU.rc instead'
call ESMF_ConfigLoadFile (cfg, 'SU2G_instance_SU.rc', __RC__)
end if
! Call Generic Initialize
! ----------------------------------------
call MAPL_GenericInitialize (GC, import, export, clock, __RC__)
! Get parameters from generic state.
! -----------------------------------
call MAPL_Get ( mapl, INTERNAL_ESMF_STATE = internal, &
LONS = LONS, &
LATS = LATS, __RC__ )
!allocate(self%h2o2_init(size(lats,1),size(lats,2),self%km), __STAT__)
! Is SU data driven?
! ------------------
call determine_data_driven (COMP_NAME, data_driven, __RC__)
! If this is a data component, the data is provided in the import
! state via ExtData instead of the actual GOCART children
! ----------------------------------------------------------------
if ( data_driven ) then
providerState = import
prefix = 'clim'
else
providerState = export
prefix = ''
end if
! Add attribute information
if (.not. data_driven) then
call ESMF_StateGet (internal, 'DMS', field, __RC__)
call ESMF_AttributeSet(field, NAME='ScavengingFractionPerKm', VALUE=self%fscav(1), __RC__)
! Vect_Hcts=(/0.56, 3500.0, 0.0, 0.0/)
call get_HenrysLawCts('DMS',Vect_Hcts(1),Vect_Hcts(2),Vect_Hcts(3),Vect_Hcts(4),__RC__)
call ESMF_AttributeSet(field, 'SetofHenryLawCts', Vect_Hcts, __RC__)
call ESMF_StateGet (internal, 'SO2', field, __RC__)
call ESMF_AttributeSet(field, NAME='ScavengingFractionPerKm', VALUE=self%fscav(2), __RC__)
! Vect_Hcts=(/1.4, 2900.0, 1.3E-02, 2000.0/)
call get_HenrysLawCts('SO2',Vect_Hcts(1),Vect_Hcts(2),Vect_Hcts(3),Vect_Hcts(4),__RC__)
call ESMF_AttributeSet(field, 'SetofHenryLawCts', Vect_Hcts, __RC__)
call ESMF_StateGet (internal, 'MSA', field, rc=status)
if (status == 0) then
call ESMF_AttributeSet(field, NAME='ScavengingFractionPerKm', VALUE=self%fscav(4), __RC__)
end if
end if
! Fill AERO State with SO4
! ----------------------------------------
call ESMF_StateGet (export, trim(COMP_NAME)//'_AERO' , aero , __RC__)
call ESMF_StateGet (export, trim(COMP_NAME)//'_AERO_DP' , Bundle_DP, __RC__)
call ESMF_StateGet (internal, 'SO4', field, __RC__)
call ESMF_AttributeSet(field, NAME='ScavengingFractionPerKm', VALUE=self%fscav(3), __RC__)
fld = MAPL_FieldCreate (field, 'SO4', __RC__)
call MAPL_StateAdd (aero, fld, __RC__)
if (.not. data_driven) then
! Set klid
call MAPL_GetPointer(import, ple, 'PLE', __RC__)
call findKlid (self%klid, self%plid, ple, __RC__)
! Set internal SO4 values to 0 where above klid
call MAPL_GetPointer (internal, int_ptr, 'SO4', __RC__)
call setZeroKlid (self%km, self%klid, int_ptr)
end if
if (data_driven) then
instance = instanceData
! (SO4; only aerosol component; bin 003)
! Dry deposition
call append_to_bundle('SUDP003', providerState, prefix, Bundle_DP, __RC__)
! Wet deposition (Convective scavenging)
call append_to_bundle('SUSV003', providerState, prefix, Bundle_DP, __RC__)
! Wet deposition
call append_to_bundle('SUWT003', providerState, prefix, Bundle_DP, __RC__)
! Gravitational Settling
call append_to_bundle('SUSD003', providerState, prefix, Bundle_DP, __RC__)
else
instance = instanceComputational
! Dry deposition
call append_to_bundle('SUDP', providerState, prefix, Bundle_DP, __RC__)
! Wet deposition (Convective scavenging)
call append_to_bundle('SUSV', providerState, prefix, Bundle_DP, __RC__)
! Wet deposition
call append_to_bundle('SUWT', providerState, prefix, Bundle_DP, __RC__)
! Gravitational Settling
call append_to_bundle('SUSD', providerState, prefix, Bundle_DP, __RC__)
end if
self%instance = instance
! Create Radiation Mie Table
! --------------------------
call ESMF_ConfigGetAttribute (cfg, file_, label="aerosol_radBands_optics_file:", __RC__ )
self%rad_Mie = GOCART2G_Mie(trim(file_), __RC__)
! Create Diagnostics Mie Table
! -----------------------------
! Get file names for the optical tables
call ESMF_ConfigGetAttribute (cfg, file_, &
label="aerosol_monochromatic_optics_file:", __RC__ )
call ESMF_ConfigGetAttribute (cfg, nmom_, label="n_moments:", default=0, __RC__)
i = ESMF_ConfigGetLen (universal_cfg, label='aerosol_monochromatic_optics_wavelength_in_nm_from_LUT:', __RC__)
allocate (channels_(i), __STAT__ )
call ESMF_ConfigGetAttribute (universal_cfg, channels_, &
label= "aerosol_monochromatic_optics_wavelength_in_nm_from_LUT:", __RC__)
self%diag_Mie = GOCART2G_Mie(trim(file_), channels_*1.e-9, nmom=nmom_, __RC__)
deallocate(channels_)
! Mie Table instance/index
call ESMF_AttributeSet(aero, name='mie_table_instance', value=instance, __RC__)
! Add variables to SU instance's aero state. This is used in aerosol optics calculations
call add_aero (aero, label='air_pressure_for_aerosol_optics', label2='PLE', grid=grid, typekind=MAPL_R4, __RC__)
call add_aero (aero, label='relative_humidity_for_aerosol_optics', label2='RH', grid=grid, typekind=MAPL_R4,__RC__)
! call ESMF_StateGet (import, 'PLE', field, __RC__)
! call MAPL_StateAdd (aero, field, __RC__)
! call ESMF_StateGet (import, 'RH2', field, __RC__)
! call MAPL_StateAdd (aero, field, __RC__)
call add_aero (aero, label='extinction_in_air_due_to_ambient_aerosol', label2='EXT', grid=grid, typekind=MAPL_R8,__RC__)
call add_aero (aero, label='single_scattering_albedo_of_ambient_aerosol', label2='SSA', grid=grid, typekind=MAPL_R8,__RC__)
call add_aero (aero, label='asymmetry_parameter_of_ambient_aerosol', label2='ASY', grid=grid, typekind=MAPL_R8,__RC__)
call add_aero (aero, label='monochromatic_extinction_in_air_due_to_ambient_aerosol', &
label2='monochromatic_EXT', grid=grid, typekind=MAPL_R4, __RC__)
call add_aero (aero, label='sum_of_internalState_aerosol', label2='aerosolSum', grid=grid, typekind=MAPL_R4, __RC__)
call ESMF_AttributeSet (aero, name='band_for_aerosol_optics', value=0, __RC__)
call ESMF_AttributeSet (aero, name='wavelength_for_aerosol_optics', value=0., __RC__)
mieTable_pointer = transfer(c_loc(self), [1])
call ESMF_AttributeSet (aero, name='mieTable_pointer', valueList=mieTable_pointer, itemCount=size(mieTable_pointer), __RC__)
call ESMF_AttributeSet (aero, name='internal_variable_name', value='SO4', __RC__)
call ESMF_MethodAdd (aero, label='aerosol_optics', userRoutine=aerosol_optics, __RC__)
call ESMF_MethodAdd (aero, label='monochromatic_aerosol_optics', userRoutine=monochromatic_aerosol_optics, __RC__)
call ESMF_MethodAdd (aero, label='get_mixR', userRoutine=get_mixR, __RC__)
RETURN_(ESMF_SUCCESS)
end subroutine Initialize
!============================================================================
!BOP
! !IROUTINE: Run
! !INTERFACE:
subroutine Run (GC, import, export, clock, rc)
! !ARGUMENTS:
type (ESMF_GridComp), intent(inout) :: GC ! Gridded component
type (ESMF_State), intent(inout) :: import ! Import state
type (ESMF_State), intent(inout) :: export ! Export state
type (ESMF_Clock), intent(inout) :: clock ! The clock
integer, optional, intent( out) :: rc ! Error code:
! !DESCRIPTION: Run method for the Sea Salt Grid Component. Determines whether to run
! data or computational run method.
!EOP
!============================================================================
! !Locals
character (len=ESMF_MAXSTR) :: COMP_NAME
type (MAPL_MetaComp), pointer :: MAPL
type (ESMF_State) :: internal
logical :: data_driven
__Iam__('Run')
!*****************************************************************************
! Begin...
! Get my name and set-up traceback handle
! ---------------------------------------
call ESMF_GridCompGet (GC, NAME=COMP_NAME, __RC__)
Iam = trim(COMP_NAME) //'::'// Iam
! Get my internal MAPL_Generic state
! -----------------------------------
call MAPL_GetObjectFromGC (GC, MAPL, __RC__)
! Get parameters from generic state.
! -----------------------------------
call MAPL_Get (MAPL, INTERNAL_ESMF_STATE=internal, __RC__)
! Is SU data driven?
! ------------------
call determine_data_driven (COMP_NAME, data_driven, __RC__)
! Update INTERNAL state variables with ExtData
! ---------------------------------------------
if (data_driven) then
call Run_data (GC, import, export, internal, __RC__)
else
call Run1 (GC, import, export, clock, __RC__)
end if
RETURN_(ESMF_SUCCESS)
end subroutine Run
!============================================================================
!BOP
! !IROUTINE: Run1
! !INTERFACE:
subroutine Run1 (GC, import, export, clock, RC)
! !ARGUMENTS:
type (ESMF_GridComp), intent(inout) :: GC ! Gridded component
type (ESMF_State), intent(inout) :: import ! Import state
type (ESMF_State), intent(inout) :: export ! Export state
type (ESMF_Clock), intent(inout) :: clock ! The clock
integer, optional, intent( out) :: RC ! Error code:
! !DESCRIPTION: Computes emissions/sources for Sea Salt
!EOP
!============================================================================
! !Locals
character (len=ESMF_MAXSTR) :: COMP_NAME
type (MAPL_MetaComp), pointer :: mapl
type (ESMF_State) :: internal
type (ESMF_Grid) :: grid
type (wrap_) :: wrap
type (SU2G_GridComp), pointer :: self
type(ESMF_Time) :: time
character(len=3) :: cdow
integer :: idow
integer :: nymd, nhms, iyr, imm, idd, ihr, imn, isc
real, pointer, dimension(:,:) :: lats
real, pointer, dimension(:,:) :: lons
real, dimension(:,:,:), allocatable :: aircraft_fuel_src
real, dimension(:,:), allocatable :: so2biomass_src, so2biomass_src_, so2anthro_l1_src, &
so2anthro_l2_src, so2ship_src, so4ship_src, dmso_conc, &
aviation_lto_src, aviation_cds_src, aviation_crs_src
integer, dimension(:), allocatable :: iPoint, jPoint
real, dimension(:,:,:), allocatable :: emissions_point
character (len=ESMF_MAXSTR) :: fname ! file name for point source emissions
logical :: fileExists
real, pointer, dimension(:,:,:) :: dummyMSA !=> null() ! This is so the model can run without MSA enabled
type(ThreadWorkspace), pointer :: workspace
integer :: thread
#include "SU2G_DeclarePointer___.h"
__Iam__('Run1')
!*****************************************************************************
! Begin...
nullify(dummyMSA)
! Get my name and set-up traceback handle
! ---------------------------------------
call ESMF_GridCompGet (GC, NAME=COMP_NAME, __RC__)
Iam = trim(comp_name) //'::'// Iam
! Get my internal MAPL_Generic state
! -----------------------------------
call MAPL_GetObjectFromGC (GC, mapl, __RC__)
call MAPL_Get(mapl, grid=grid, __RC__)
! Get parameters from generic state.
! -----------------------------------
call MAPL_Get (mapl, INTERNAL_ESMF_STATE=internal, &
LONS = LONS, &
LATS = LATS, __RC__ )
#include "SU2G_GetPointer___.h"
call MAPL_GetPointer(internal, dummyMSA, 'MSA', rc=status)
! Get my private internal state
! ------------------------------
call ESMF_UserCompGetInternalState(GC, 'SU2G_GridComp', wrap, STATUS)
VERIFY_(STATUS)
self => wrap%ptr
! Extract nymd(yyyymmdd) from clock
! ---------------------------------
call ESMF_ClockGet (clock, currTime=time, __RC__)
call ESMF_TimeGet (time ,YY=iyr, MM=imm, DD=idd, H=ihr, M=imn, S=isc, __RC__)
call MAPL_PackTime (nymd, iyr, imm , idd)
call MAPL_PackTime (nhms, ihr, imn, isc)
! Reset tracer to zero at 0Z on specific day of week
! --------------------------------------------------
idow = Chem_UtilIdow(nymd)
if ( (nhms==0) .and. (idow == self%myDOW) ) then
cdow = Chem_UtilCdow(nymd)
DMS = tiny(1.) ! avoid division by zero
SO2 = tiny(1.) ! avoid division by zero
SO4 = tiny(1.) ! avoid division by zero
if ( associated(dummyMSA)) dummyMSA = tiny(1.) ! avoid division by zero
if ( MAPL_AM_I_ROOT() ) then
print *, '<> SU '//cdow//' tracer being set to zero on ', nymd, nhms
end if
end if
! Implicit allocation with Fortran 2003
so2anthro_l1_src = SU_ANTHROL1
so2anthro_l2_src = SU_ANTHROL2
so2ship_src = SU_SHIPSO2
so4ship_src = SU_SHIPSO4
! As a safety check, where value is undefined set to 0
where(1.01*so2anthro_l1_src > MAPL_UNDEF) so2anthro_l1_src = 0.
where(1.01*so2anthro_l2_src > MAPL_UNDEF) so2anthro_l2_src = 0.
where(1.01*so2ship_src > MAPL_UNDEF) so2ship_src = 0.
where(1.01*so4ship_src > MAPL_UNDEF) so4ship_src = 0.
aircraft_fuel_src = SU_AIRCRAFT
so2biomass_src = SU_BIOMASS
dmso_conc = SU_DMSO
aviation_lto_src = SU_AVIATION_LTO
aviation_cds_src = SU_AVIATION_CDS
aviation_crs_src = SU_AVIATION_CRS
! As a safety check, where value is undefined set to 0
where(1.01*so2biomass_src > MAPL_UNDEF) so2biomass_src = 0.
where(1.01*dmso_conc > MAPL_UNDEF) dmso_conc = 0.
where(1.01*aircraft_fuel_src > MAPL_UNDEF) aircraft_fuel_src = 0.
where(1.01*aviation_lto_src > MAPL_UNDEF ) aviation_lto_src = 0.
where(1.01*aviation_cds_src > MAPL_UNDEF ) aviation_cds_src = 0.
where(1.01*aviation_crs_src > MAPL_UNDEF ) aviation_crs_src = 0.
! Start with a clean emission diagnostic
if(associated(SUEM)) SUEM = 0.0
! Update emissions/production if necessary (daily)
! -----------------------------------------------
thread = MAPL_get_current_thread()
workspace => self%workspaces(thread)
! Update Volcanic SO2 Emissions Daily
if(workspace%nymd_last /= nymd) then
workspace%nymd_last = nymd
! DEGASSING: Get pointwise SO2 and altitude of volcanoes from a daily file data base
workspace%nVolc = 0 ! case of /dev/null (no volcanoes) or ill-formed filename
if(index(self%volcano_srcfilen_degassing,'volcanic_') /= 0) then
call StrTemplate(fname, self%volcano_srcfilen_degassing, xid='unknown', &
nymd=nymd, nhms=120000 )
call ReadPointEmissions (nymd, fname, workspace%nVolc, workspace%vLat, workspace%vLon, &
workspace%vElev, workspace%vCloud, workspace%vSO2, workspace%vStart, &
workspace%vEnd, label='volcano', __RC__)
workspace%vSO2 = workspace%vSO2 * fMassSO2 / fMassSulfur
end if
! EXPLOSIVE: Get pointwise SO2 and altitude of volcanoes from a daily file data base
workspace%nVolcE = 0 ! case of /dev/null (no volcanoes) or ill-formed filename
if(index(self%volcano_srcfilen_explosive,'volcanic_') /= 0) then
call StrTemplate(fname, self%volcano_srcfilen_explosive, xid='unknown', &
nymd=nymd, nhms=120000 )
call ReadPointEmissions (nymd, fname, workspace%nVolcE, workspace%vLatE, workspace%vLonE, &
workspace%vElevE, workspace%vCloudE, workspace%vSO2E, workspace%vStartE, &
workspace%vEndE, label='volcano', __RC__)
workspace%vSO2 = workspace%vSO2 * fMassSO2 / fMassSulfur
end if
end if
! DEGASSING: Apply volcanic emissions
! -----------------------------------
if (workspace%nVolc > 0) then
if (associated(SO2EMVN)) SO2EMVN=0.0
allocate(iPoint(workspace%nVolc), jPoint(workspace%nVolc), __STAT__)
call MAPL_GetHorzIJIndex(workspace%nVolc, iPoint, jPoint, &
grid = grid, &
lon = workspace%vLon/real(MAPL_RADIANS_TO_DEGREES), &
lat = workspace%vLat/real(MAPL_RADIANS_TO_DEGREES), &
rc = status)
if ( status /= 0 ) then
if (mapl_am_i_root()) print*, trim(Iam), ' - cannot get indices for point emissions'
VERIFY_(status)
end if
call SUvolcanicEmissions (workspace%nVolc, workspace%vStart, workspace%vEnd, workspace%vSO2, workspace%vElev, &
workspace%vCloud, iPoint, jPoint, nhms, SO2EMVN, SO2, nSO2, SUEM, &
self%km, self%cdt, MAPL_GRAV, zle, delp, area, workspace%vLat, workspace%vLon, __RC__)
deallocate(iPoint, jPoint, __STAT__)
end if
! EXPLOSIVE: Apply volcanic emissions
! -----------------------------------
if (workspace%nVolcE > 0) then
if (associated(SO2EMVE)) SO2EMVE=0.0
allocate(iPoint(workspace%nVolcE), jPoint(workspace%nVolcE), __STAT__)
call MAPL_GetHorzIJIndex(workspace%nVolcE, iPoint, jPoint, &
grid = grid, &
lon = workspace%vLon/real(MAPL_RADIANS_TO_DEGREES), &
lat = workspace%vLat/real(MAPL_RADIANS_TO_DEGREES), &
rc = status)
if ( status /= 0 ) then
if (mapl_am_i_root()) print*, trim(Iam), ' - cannot get indices for point emissions'
VERIFY_(status)
end if
call SUvolcanicEmissions (workspace%nVolcE, workspace%vStartE, workspace%vEndE, workspace%vSO2E, workspace%vElevE, &
workspace%vCloudE, iPoint, jPoint, nhms, SO2EMVE, SO2, nSO2, SUEM, &
self%km, self%cdt, MAPL_GRAV, zle, delp, area, workspace%vLatE, workspace%vLonE, __RC__)
deallocate(iPoint, jPoint, __STAT__)
end if
! Apply diurnal cycle if so desired
if ( self%diurnal_bb ) then
so2biomass_src_ = so2biomass_src
call Chem_BiomassDiurnal (so2biomass_src, so2biomass_src_, &
lons(:,:)*real(MAPL_RADIANS_TO_DEGREES), &
lats(:,:)*real(MAPL_RADIANS_TO_DEGREES), &
nhms, self%cdt)
end if
! Apply sulfate emissions
! -----------------------
call SulfateDistributeEmissions ( self%km, self%nbins, self%cdt, MAPL_GRAV, nymd, nhms, &
fMassSO4, fMassSO2, self%fSO4anth, self%eAircraftFuel, &
nSO2, nSO4, &
so2anthro_l1_src, so2anthro_l2_src, &
so2biomass_src, dmso_conc, &
so2ship_src, so4ship_src, &
aircraft_fuel_src, &
SO2, SO4, &
lwi, u10m, v10m, zle, zpbl, &
t, airdens, delp, workspace%nVolc, &
SUEM, SO4EMAN, SO2EMAN, SO2EMBB, &
self%aviation_layers, &
aviation_lto_src, &
aviation_cds_src, &
aviation_crs_src, __RC__)
if (associated(dms)) then
call DMSemission (self%km, self%cdt, MAPL_GRAV, t, u10m, v10m, lwi, delp, &
fMassDMS, dmso_conc, dms, SUEM, nDMS, __RC__)
end if
! Add source of OCS-produced SO2
! ------------------------------
SO2 = SO2 + pSO2_OCS*self%cdt
! Read any pointwise emissions, if requested
! ------------------------------------------
if(self%doing_point_emissions) then
call StrTemplate(fname, self%point_emissions_srcfilen, xid='unknown', &
nymd=nymd, nhms=120000 )
inquire( file=fname, exist=fileExists)
if (fileExists) then
call ReadPointEmissions (nymd, fname, workspace%nPts, workspace%pLat, workspace%pLon, &
workspace%pBase, workspace%pTop, workspace%pEmis, workspace%pStart, &
workspace%pEnd, label='source', __RC__)
else if (.not. fileExists) then
if(mapl_am_i_root()) print*,'GOCART2G ',trim(comp_name),': ',trim(fname),' not found; proceeding.'
workspace%nPts = -1 ! set this back to -1 so the "if (workspace%nPts > 0)" conditional is not exercised.
end if
endif
! Get indices for point emissions
! -------------------------------
if (workspace%nPts > 0) then
allocate(emissions_point, mold=delp, __STAT__)
emissions_point = 0.0
allocate(iPoint(workspace%nPts), jPoint(workspace%nPts), __STAT__)
call MAPL_GetHorzIJIndex(workspace%nPts, iPoint, jPoint, &
grid = grid, &
lon = workspace%pLon/real(MAPL_RADIANS_TO_DEGREES), &
lat = workspace%pLat/real(MAPL_RADIANS_TO_DEGREES), &
rc = status)
if ( status /= 0 ) then
if (mapl_am_i_root()) print*, trim(Iam), ' - cannot get indices for point emissions'
VERIFY_(status)
end if
call updatePointwiseEmissions (self%km, workspace%pBase, workspace%pTop, workspace%pEmis, workspace%nPts, &
workspace%pStart, workspace%pEnd, zle, &
area, iPoint, jPoint, nhms, emissions_point, __RC__)
deallocate(iPoint, jPoint, __STAT__)
SO4 = SO4 + self%cdt * MAPL_GRAV / delp * emissions_point
end if
RETURN_(ESMF_SUCCESS)
end subroutine Run1
!============================================================================
!BOP
! !IROUTINE: Run2
! !INTERFACE:
subroutine Run2 (GC, import, export, clock, RC)