-
Notifications
You must be signed in to change notification settings - Fork 2
/
MAM_SulfateMod.F90
519 lines (383 loc) · 15.6 KB
/
MAM_SulfateMod.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
#include "MAPL_Generic.h"
!-------------------------------------------------------------------------
! NASA/GSFC, Data Assimilation Office, Code 610.1, GEOS/DAS !
!-------------------------------------------------------------------------
!BOP
!
! !MODULE: MAM_SulfateMod --- MAM Sulfate (SO4) processes and diagnostics
!
! !INTERFACE:
!
module MAM_SulfateMod
! !USES:
USE ESMF
USE MAPL
use Chem_ConstMod, only: grav, undef
use Chem_UtilMod, only: Chem_BiomassDiurnal
use MAM_BaseMod
use MAM3_DataMod
use MAM7_DataMod
implicit none
! !PUBLIC TYPES:
!
PRIVATE
real, private, parameter :: pi = MAPL_PI
!
! !PUBLIIC MEMBER FUNCTIONS:
!
PUBLIC MAM_SO4_Emission
PUBLIC MAM_SO4_Diagnostics
!
! !DESCRIPTION:
!
! This module implements MAM Sulfate (SO4) processes (emission, etc) and
! diagnostic fields
!
! !REVISION HISTORY:
!
! 01 Aug 2016 A. Darmenov Initial implementation.
!
!EOP
!-------------------------------------------------------------------------
CONTAINS
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE: MAM_SO4_Emission --- The Emission Driver
!
! !INTERFACE:
!
subroutine MAM_SO4_Emission (self, import, export, qa, cdt, rc)
! !USES:
implicit NONE
! !INPUT/OUTPUT PARAMETERS:
type(MAPL_SimpleBundle), intent(inout) :: qa ! interstitial aerosol tracer fields
type(ESMF_State), intent(inout) :: export ! export fields
! !INPUT PARAMETERS:
type(MAM_Scheme), intent(in) :: self ! MAM scheme/configuration
type(ESMF_State), intent(inout) :: import ! import fields
real, intent(in) :: cdt ! chemical timestep (secs)
! !OUTPUT PARAMETERS:
integer, intent(out) :: rc ! error return code:
! 0 - all is well
! 1 -
! !DESCRIPTION: This routine implements the Sulfate (SO4) Emissions Driver. That
! is, adds tendencies due to emission.
!
! !REVISION HISTORY:
!
! 11 Jul 2012 A. Darmenov Initial implementation.
!
!EOP
!-------------------------------------------------------------------------
character(len=*), parameter :: Iam = 'MAM_SO4_Emission'
integer :: STATUS
integer :: i1, i2, j1, j2, k1, km, n, i
integer :: ijl, ijkl
real :: qmin, qmax
real :: rUp, rLow
real, pointer, dimension(:,:) :: emission_total
real, pointer, dimension(:,:) :: emission_mass, emission_num
real, pointer, dimension(:,:) :: dqa_mass, dqa_num
! Mode parameters
! ------------------------
integer :: nmodes ! number of modes with dust emission
integer, dimension(MAM_MAX_NUMBER_MODES) :: mode
character(len=ESMF_MAXSTR) :: mode_name
character(len=ESMF_MAXSTR) :: mmr_name, nmr_name
character(len=ESMF_MAXSTR) :: emiss_name
! Input fields from fvGCM
! -----------------------
real, pointer, dimension(:,:) :: gwettop
real, pointer, dimension(:,:,:) :: rhoa, ple, delp
! Input fields from ExtData
! -------------------------
real, pointer, dimension(:,:) :: emiss_sh
! Exports
! -----------------------
real, pointer, dimension(:,:) :: emission
!
! Parameters of primary aerosol emissions
! ---------------------------------------
type PAE
integer :: mode_id ! mode ID
real :: weight ! weight by mass
real :: sigma ! geometric standard deviation
real :: diameter ! geometric mean diameter of number size distribution
real, pointer, dimension(:,:) :: emission => null()
real, pointer, dimension(:,:,:) :: injection => null()
end type
! note that the SO4 from ship emissions is emitted with D_mass_emiss = 0.261 micrometers
type(PAE), parameter :: pae_sh = PAE(1, 1.0, 0.0, 0.261, null(), null())
real :: D_emiss_sh, f_sh
! Initialize local variables
! --------------------------
rc = 0
D_emiss_sh = pae_sh%diameter
f_sh = 1 / (pi/6 * D_emiss_sh**3)
_ASSERT(self%id == MAM7_SCHEME .or. self%id == MAM3_SCHEME,'needs informative message')
if (self%id == MAM7_SCHEME) then
mode_name = MAM7_ACCUMULATION_MODE_NAME
else
mode_name = MAM3_ACCUMULATION_MODE_NAME
end if
! Get Imports
! --------------
call MAPL_GetPointer(import, gwettop, 'WET1', __RC__)
call MAPL_GetPointer(import, rhoa, 'AIRDENS', __RC__)
call MAPL_GetPointer(import, ple, 'PLE', __RC__)
call MAPL_GetPointer(import, delp, 'DELP', __RC__)
call MAPL_GetPointer(import, emiss_sh, 'SO4_EMIS_SHIP', __RC__)
! Local dimensions
! ----------------
i1 = lbound(rhoa, 1)
i2 = ubound(rhoa, 1)
j1 = lbound(rhoa, 2)
j2 = ubound(rhoa, 2)
k1 = lbound(rhoa, 3)
km = ubound(rhoa, 3)
ijl = (i2 - i1 + 1) * (j2 - j1 + 1)
ijkl = ijl * km
#ifdef DEBUG
call write_parallel(trim(Iam) // '::DEBUG(before)::Indexes:')
call write_parallel((/i1, i2/), format='(("i1, i2 = ", (X2I3)))')
call write_parallel((/j1, j2/), format='(("j1, j2 = ", (X2I3)))')
call write_parallel((/k1, km/), format='(("k1, k2 = ", (X2I3)))')
do i = 1, qa%n3d
call pmaxmin('CAM:qa:'//trim(qa%r3(i)%name)//' : ', &
qa%r3(i)%q(i1:i2,j1:j2,k1:km), qmin, qmax, ijl, km, 1.)
end do
#endif
#ifdef DEBUG
call write_parallel(trim(Iam) // '::DEBUG::Indexes:')
call write_parallel((/i1, i2/), format='(("i1, i2 = ", (X2I3)))')
call write_parallel((/j1, j2/), format='(("j1, j2 = ", (X2I3)))')
call write_parallel((/k1, km/), format='(("k1, k2 = ", (X2I3)))')
call write_parallel(trim(Iam) // '::DEBUG::Inputs:')
call write_parallel(self%id, format='(("model = ", (I5)))')
call pmaxmin('SO4: gwettop ', gwettop, qmin, qmax, ijl, k1, 1.)
call pmaxmin('SO4: rhoa ', rhoa, qmin, qmax, ijl, km, 1.)
call pmaxmin('SO4: ple ', ple, qmin, qmax, ijl, km, 1.)
call pmaxmin('SO4: delp ', delp, qmin, qmax, ijl, km, 1.)
#endif
! Sulfate (SO4) Emissions
! -----------------------
allocate(emission_total(i1:i2,j1:j2), __STAT__)
allocate(emission_mass(i1:i2,j1:j2), __STAT__)
allocate(emission_num(i1:i2,j1:j2), __STAT__)
allocate(dqa_mass(i1:i2,j1:j2), __STAT__)
allocate(dqa_num(i1:i2,j1:j2), __STAT__)
emission_total = 0.0
mmr_name = 'SU_A_' // trim(mode_name) ! name of the mass mixing ratio
nmr_name = 'NUM_A_' // trim(mode_name) ! name of the number mixing ratio
emiss_name = 'SUEM' // trim(mode_name) ! name of the emission export
emission_num = 0.0
emission_mass = 0.0
! set undefined to 0
where ((emiss_sh - undef) > abs(emiss_sh)*epsilon(emiss_sh)) emiss_sh = 0.0
emission_mass = emiss_sh
emission_num = f_sh * emiss_sh
#ifdef DEBUG
call pmaxmin('SO4: emission_total ', emission_total, qmin, qmax, ijl, 1, 1.)
call write_parallel('SO4: mode ' // trim(mode_name))
call pmaxmin('SO4: emission_mass ', emission_mass, qmin, qmax, ijl, 1, 1.)
call pmaxmin('SO4: emission_number', emission_num, qmin, qmax, ijl, 1, 1.)
#endif
dqa_mass = emission_mass * cdt * grav / delp(:,:,km)
dqa_num = emission_num * cdt * grav / delp(:,:,km)
! update the mass and number mixing ratios due to emission
i = MAPL_SimpleBundleGetIndex(qa, mmr_name, 3, __RC__)
qa%r3(i)%q(:,:,km) = qa%r3(i)%q(:,:,km) + dqa_mass
i = MAPL_SimpleBundleGetIndex(qa, nmr_name, 3, __RC__)
qa%r3(i)%q(:,:,km) = qa%r3(i)%q(:,:,km) + dqa_num
call MAPL_GetPointer(export, emission, emiss_name, __RC__)
if (associated(emission)) then
emission = emission_mass
endif
#ifdef DEBUG
call write_parallel(trim(Iam) // '::DEBUG(after)::Indexes:')
call write_parallel((/i1, i2/), format='(("i1, i2 = ", (X2I3)))')
call write_parallel((/j1, j2/), format='(("j1, j2 = ", (X2I3)))')
call write_parallel((/k1, km/), format='(("k1, k2 = ", (X2I3)))')
do i = 1, qa%n3d
call pmaxmin('CAM:qa:'//trim(qa%r3(i)%name)//' : ', &
qa%r3(i)%q(i1:i2,j1:j2,k1:km), qmin, qmax, ijl, km, 1.)
end do
#endif
! Clean up
! --------
deallocate(emission_total, __STAT__)
deallocate(emission_mass, __STAT__)
deallocate(emission_num, __STAT__)
deallocate(dqa_mass, __STAT__)
deallocate(dqa_num, __STAT__)
RETURN_(ESMF_SUCCESS)
end subroutine MAM_SO4_Emission
!-------------------------------------------------------------------------
! NASA/GSFC, Global Modeling and Assimilation Office, Code 610.1 !
!-------------------------------------------------------------------------
!BOP
!
! !IROUTINE: MAM_SO4_Diagnostics --- The Diagnostics Driver
!
! !INTERFACE:
!
subroutine MAM_SO4_Diagnostics (self, import, export, qa, cdt, rc)
! !USES:
implicit NONE
! !INPUT/OUTPUT PARAMETERS:
type(MAPL_SimpleBundle), intent(inout) :: qa ! interstitial aerosol tracer fields
type(ESMF_State), intent(inout) :: export ! export fields
! !INPUT PARAMETERS:
type(MAM_Scheme), intent(in) :: self ! MAM scheme/configuration
type(ESMF_State), intent(inout) :: import ! import fields
real, intent(in) :: cdt ! chemical timestep (secs)
! !OUTPUT PARAMETERS:
integer, intent(out) :: rc ! error return code:
! 0 - all is well
! 1 -
! !DESCRIPTION: This routine calculates a number of diagnostic fields.
!
! !REVISION HISTORY:
!
! 11 Jul 2012 A. Darmenov Initial implementation.
!
!EOP
!-------------------------------------------------------------------------
character(len=*), parameter :: Iam = 'MAM_SO4_Diagnostics'
integer :: STATUS
integer :: i1, i2, j1, j2, k1, km, n, i, k
integer :: ijl, ijkl
real :: qmin, qmax
! Mode parameters
! ------------------------
integer :: nmodes ! number of modes with dust emission
integer, dimension(MAM_MAX_NUMBER_MODES) :: mode
character(len=ESMF_MAXSTR) :: mode_name(MAM_MAX_NUMBER_MODES)
character(len=ESMF_MAXSTR) :: mmr_name, nmr_name
! Input fields from fvGCM
! -----------------------
real, pointer, dimension(:,:,:) :: rhoa, ple, delp
real, pointer, dimension(:,:,:) :: u, v
! Exports - diagnostic fields
! ---------------------------
real, pointer, dimension(:,:) :: sfcmass ! surface mass concentration, kg m-3
real, pointer, dimension(:,:) :: sfcmass25 ! surface PM2.5 mass concentration, kg m-3
real, pointer, dimension(:,:) :: colmass ! column integrated mass density, kg m-2
real, pointer, dimension(:,:) :: colmass25 ! column integrated PM2.5 mass density, kg m-2
real, pointer, dimension(:,:) :: fluxu ! Column mass flux in x direction
real, pointer, dimension(:,:) :: fluxv ! Column mass flux in y direction
real, pointer, dimension(:,:,:) :: conc ! mass concentration, kg m-3
real, pointer, dimension(:,:,:) :: mass ! mass mixing ratio, kg kg-1
real, pointer, dimension(:,:,:) :: mass25 ! PM2.5 mass mixing ratio, kg kg-1
! Initialize local variables
! --------------------------
rc = 0
_ASSERT(self%id == MAM7_SCHEME .or. self%id == MAM3_SCHEME,'needs informative message')
#if (0)
if (self%id == MAM7_SCHEME) then
nmodes = size(MAM7_SO4_EMISSION_MODE_ID)
mode(1:nmodes) = MAM7_SO4_EMISSION_MODE_ID
mode_name(1:nmodes) = MAM7_MODE_NAME(mode(1:nmodes))
else
nmodes = size(MAM3_SO4_EMISSION_MODE_ID)
mode(1:nmodes) = MAM3_SO4_EMISSION_MODE_ID
mode_name(1:nmodes) = MAM3_MODE_NAME(mode(1:nmodes))
end if
! Get Imports
! --------------
call MAPL_GetPointer(import, rhoa, 'AIRDENS', __RC__)
call MAPL_GetPointer(import, ple, 'PLE', __RC__)
call MAPL_GetPointer(import, delp, 'DELP', __RC__)
call MAPL_GetPointer(import, u, 'U', __RC__)
call MAPL_GetPointer(import, v, 'V', __RC__)
! Get Exports
! --------------
call MAPL_GetPointer(export, sfcmass, 'SUSMASS', __RC__)
call MAPL_GetPointer(export, sfcmass25, 'SUSMASS25', __RC__)
call MAPL_GetPointer(export, colmass, 'SUCMASS', __RC__)
call MAPL_GetPointer(export, colmass25, 'SUCMASS25', __RC__)
call MAPL_GetPointer(export, fluxu, 'SUFLUXU', __RC__)
call MAPL_GetPointer(export, fluxv, 'SUFLUXV', __RC__)
call MAPL_GetPointer(export, conc, 'SUCONC', __RC__)
call MAPL_GetPointer(export, mass, 'SUMASS', __RC__)
call MAPL_GetPointer(export, mass25, 'SUMASS25', __RC__)
! Local dimensions
! ----------------
i1 = lbound(rhoa, 1)
i2 = ubound(rhoa, 1)
j1 = lbound(rhoa, 2)
j2 = ubound(rhoa, 2)
k1 = lbound(rhoa, 3)
km = ubound(rhoa, 3)
ijl = (i2 - i1 + 1) * (j2 - j1 + 1)
ijkl = ijl * km
#ifdef DEBUG
call write_parallel(trim(Iam) // '::DEBUG::Indexes:')
call write_parallel((/i1, i2/), format='(("i1, i2 = ", (X2I3)))')
call write_parallel((/j1, j2/), format='(("j1, j2 = ", (XI3)))')
call write_parallel((/k1, km/), format='(("k1, k2 = ", (XI3)))')
call write_parallel(trim(Iam) // '::DEBUG::Inputs:')
call write_parallel(self%id, format='(("model = ", (I5)))')
#endif
! Initialize diagnostic fields
! ----------------------------
if (associated(sfcmass)) sfcmass = 0.0
if (associated(sfcmass25)) sfcmass25 = 0.0
if (associated(colmass)) colmass = 0.0
if (associated(colmass25)) colmass25 = 0.0
if (associated(fluxu)) fluxu = 0.0
if (associated(fluxv)) fluxv = 0.0
if (associated(conc)) conc = 0.0
if (associated(mass)) mass = 0.0
if (associated(mass25)) mass25 = 0.0
! Calculate diagnostic fields
! ---------------------------
do n = 1, nmodes
mmr_name = 'SU_A_' // trim(mode_name(n)) ! name of the mass mixing ratio
nmr_name = 'NUM_A_' // trim(mode_name(n)) ! name of the number mixing ratio
i = MAPL_SimpleBundleGetIndex(qa, mmr_name, 3, __RC__)
if (associated(sfcmass)) then
sfcmass(:,:) = sfcmass(:,:) + qa%r3(i)%q(:,:,km) * rhoa(:,:,km)
end if
if (associated(sfcmass25)) then ! placeholder for now
sfcmass25(:,:) = sfcmass25(:,:) + 0.0 * qa%r3(i)%q(:,:,km) * rhoa(:,:,km)
end if
if (associated(colmass)) then
do k = 1, km
colmass(:,:) = colmass(:,:) + qa%r3(i)%q(:,:,k) * delp(:,:,k)/grav
end do
end if
if (associated(colmass25)) then ! placeholder for now
do k = 1, km
colmass25(:,:) = colmass25(:,:) + 0.0 * qa%r3(i)%q(:,:,k) * delp(:,:,k)/grav
end do
end if
if (associated(fluxu)) then
do k = 1, km
fluxu(:,:) = fluxu(:,:) + u(:,:,k) * qa%r3(i)%q(:,:,k) * delp(:,:,k)/grav
end do
end if
if (associated(fluxv)) then
do k = 1, km
fluxv(:,:) = fluxv(:,:) + v(:,:,k) * qa%r3(i)%q(:,:,k) * delp(:,:,k)/grav
end do
end if
if (associated(conc)) then
conc = conc + qa%r3(i)%q * rhoa
end if
if (associated(mass)) then
mass = mass + qa%r3(i)%q
end if
if (associated(mass25)) then ! placeholder for now
mass25 = mass25 + 0.0 * qa%r3(i)%q
end if
end do
#endif
! Clean up
! --------
RETURN_(ESMF_SUCCESS)
end subroutine MAM_SO4_Diagnostics
end module MAM_SulfateMod