-
Notifications
You must be signed in to change notification settings - Fork 13
/
GIGC_GridCompMod.F90
547 lines (420 loc) · 17.9 KB
/
GIGC_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
#include "MAPL_Generic.h"
!=============================================================================
!BOP
! !MODULE:
! GIGC\_GridCompMod -- this gridded component (GC) builds an ESMF application
! out of the following three (children) components:
! 1. Advection (DYNAMICS)
! 2. Traditional GEOS-Chem except for advection (GIGCchem)
! 3. Cinderella component to derive variables for other components (GIGCenv)
!
! !NOTES:
! (1) For now, the dynamics module is rather primitive and based upon netCDF
! input fields for all met. variables (U,V,etc.). This module computes
! pressure related quantities (PEDGE, PCENTER, BOXHEIGHT, AIRDEN, AD, DELP,
! AIRVOL) and passes these variables to chemistry and HEMCO.
! Similarly, HEMCO inherits the grid box surface area from dynamics.
! (2) Tracers and emissions are passed as 'bundle' from one component to
! another.
! (3) All 3D fields are exchanged on the 'GEOS-5' vertical levels, i.e. with
! a reversed atmosphere (level 1 is top of atmosphere).
!
! ---
!
! !INTERFACE:
module GIGC_GridCompMod
! !USES:
use ESMF
use MAPL_Mod
use CHEM_GridCompMod, only : AtmosChemSetServices => SetServices
use AdvCore_GridCompMod, only : AtmosAdvSetServices => SetServices
use GEOS_ctmEnvGridComp, only : EctmSetServices => SetServices
implicit none
private
!
! !PUBLIC MEMBER FUNCTIONS:
!
public SetServices
!
! !PRIVATE MEMBER FUNCTIONS:
!
private Initialize
private Run
private Finalize
!=============================================================================
! !DESCRIPTION:
!EOP
integer :: ADV, CHEM, ECTM, MemDebugLevel
contains
!BOP
! !IROUTINE: SetServices -- Sets ESMF services for this component
! !INTERFACE:
subroutine SetServices ( GC, RC )
! !ARGUMENTS:
type(ESMF_GridComp), intent(INOUT) :: GC ! gridded component
integer, intent( OUT) :: RC ! return code
! !DESCRIPTION: The SetServices for the GIGC gridded component needs to
! register its Initialize, Run, and Finalize. It uses the MAPL_Generic
! construct for defining state specifications and couplings among its
! children. In addition, it creates the children GCs (ADV, CHEM, ECTM)
! and run their respective SetServices.
!EOP
!=============================================================================
!
! ErrLog Variables
character(len=ESMF_MAXSTR) :: IAm
integer :: STATUS
character(len=ESMF_MAXSTR) :: COMP_NAME
! Locals
type (ESMF_Config) :: CF
logical :: am_I_Root
!=============================================================================
! Begin...
! Get the target component name and set-up traceback handle
!-----------------------------------------------------------
Iam = 'SetServices'
call ESMF_GridCompGet( GC, NAME=COMP_NAME, CONFIG=CF, RC=STATUS )
_VERIFY(STATUS)
Iam = trim(COMP_NAME) // "::" // Iam
! Register services for this component
! ------------------------------------
call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_INITIALIZE, Initialize, &
RC=STATUS )
_VERIFY(STATUS)
call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_RUN, Run, RC=STATUS )
_VERIFY(STATUS)
call MAPL_GridCompSetEntryPoint ( GC, ESMF_METHOD_FINALIZE, Finalize, &
RC=STATUS )
_VERIFY(STATUS)
!BOP
! !IMPORT STATE:
! !EXPORT STATE:
! Create children`s gridded components and invoke their SetServices
! -----------------------------------------------------------------
! Add component for deriving variables for other components
ECTM = MAPL_AddChild(GC, NAME='GIGCenv' , SS=EctmSetServices, &
RC=STATUS)
_VERIFY(STATUS)
! Add chemistry
CHEM = MAPL_AddChild(GC, NAME='GIGCchem', SS=AtmosChemSetServices, &
RC=STATUS)
_VERIFY(STATUS)
! Add dynamics
ADV = MAPL_AddChild(GC, NAME='DYNAMICS', SS=AtmosAdvSetServices, &
RC=STATUS)
_VERIFY(STATUS)
! Set internal connections between the children`s IMPORTS and EXPORTS
! -------------------------------------------------------------------
!BOP
! !CONNECTIONS:
! Connectivities between Children
! -------------------------------
CALL MAPL_AddConnectivity ( GC, &
SHORT_NAME = (/'AREA'/), &
DST_ID = ECTM, &
SRC_ID = ADV, &
__RC__ )
CALL MAPL_AddConnectivity ( GC, &
SHORT_NAME = (/'AIRDENS'/), &
DST_ID = CHEM, &
SRC_ID = ECTM, &
__RC__ )
CALL MAPL_AddConnectivity ( GC, &
SRC_NAME = (/ 'CXr8 ', &
'CYr8 ', &
'MFXr8 ', &
'MFYr8 ', &
'PLE0r8 ', &
'PLE1r8 ', &
'DryPLE0r8', &
'DryPLE1r8' /), &
DST_NAME = (/ 'CX ', &
'CY ', &
'MFX ', &
'MFY ', &
'PLE0 ', &
'PLE1 ', &
'DryPLE0', &
'DryPLE1' /), &
DST_ID = ADV, &
SRC_ID = ECTM, &
__RC__ )
CALL MAPL_AddConnectivity ( GC, &
SHORT_NAME = (/ 'AREA ', &
'PLE ', &
'DryPLE' /), &
DST_ID = CHEM, &
SRC_ID = ADV, &
__RC__ )
CALL MAPL_TerminateImport ( GC, &
SHORT_NAME = (/'TRADV'/), &
CHILD = ADV, &
__RC__ )
call MAPL_TimerAdd(GC, name="RUN", RC=STATUS)
_VERIFY(STATUS)
call MAPL_GenericSetServices ( GC, RC=STATUS )
_VERIFY(STATUS)
!EOP
_RETURN(ESMF_SUCCESS)
end subroutine SetServices
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
! !IROUTINE: Initialize -- Initialize method for the GIGC Gridded Component
! !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: The Initialize method of the GIGC Composite Gridded
! Component. It acts as a driver for the initialization of the three
! children: DYNAMICS, GIGCchem, and GIGCenv.
!
!EOP
! ErrLog Variables
character(len=ESMF_MAXSTR) :: IAm
integer :: STATUS
character(len=ESMF_MAXSTR) :: COMP_NAME
! Local derived type aliases
type (MAPL_MetaComp), pointer :: STATE
type (ESMF_GridComp), pointer :: GCS(:)
type (ESMF_State), pointer :: GIM(:)
type (ESMF_State), pointer :: GEX(:)
type (ESMF_FieldBundle) :: BUNDLE
type (ESMF_Field) :: FIELD
type (ESMF_Grid) :: GRID
type (ESMF_Config) :: CF
integer :: NUM_TRACERS
!=============================================================================
! Begin...
! Get the target component name and set-up traceback handle
!----------------------------------------------------------
Iam = "Initialize"
call ESMF_GridCompGet ( GC, name=COMP_NAME, Config=CF, RC=STATUS )
_VERIFY(STATUS)
Iam = trim(COMP_NAME) // "::" // Iam
! Get memory debug level
!----------------------------------------------------------
call ESMF_ConfigGetAttribute(CF, MemDebugLevel, &
Label="MEMORY_DEBUG_LEVEL:" , RC=STATUS)
_VERIFY(STATUS)
! Get my MAPL_Generic state
!--------------------------
call MAPL_GetObjectFromGC ( GC, STATE, RC=STATUS)
_VERIFY(STATUS)
! Create Atmospheric grid
!------------------------
call MAPL_GridCreate( GC, rc=status )
_VERIFY(STATUS)
! Call Initialize for every Child
!--------------------------------
call MAPL_GenericInitialize ( GC, IMPORT, EXPORT, CLOCK, __RC__ )
_VERIFY(STATUS)
call MAPL_TimerOn(STATE,"TOTAL")
! call MAPL_TimerOn(STATE,"INITIALIZE")
! Get children and their im/ex states from my generic state.
!----------------------------------------------------------
call MAPL_Get ( STATE, GCS=GCS, GIM=GIM, GEX=GEX, RC=STATUS )
_VERIFY(STATUS)
! AdvCore Tracers
!----------------
call ESMF_StateGet( GIM(ADV), 'TRADV', BUNDLE, RC=STATUS )
_VERIFY(STATUS)
call MAPL_GridCompGetFriendlies(GCS(CHEM), "DYNAMICS", BUNDLE, RC=STATUS )
_VERIFY(STATUS)
! Count tracers
!--------------
call ESMF_FieldBundleGet(BUNDLE,FieldCount=NUM_TRACERS, RC=STATUS)
_VERIFY(STATUS)
! Disable this erroneous MAPL_TimerOff to fix timing. J.W.Zhuang 2017/04
! call MAPL_TimerOff(STATE,"RUN")
call MAPL_TimerOff(STATE,"TOTAL")
_RETURN(ESMF_SUCCESS)
end subroutine Initialize
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!BOP
! !IROUTINE: Run -- Run method for the composite GIGC Gridded Component
! !INTERFACE:
subroutine Run ( GC, IMPORT, EXPORT, CLOCK, RC )
! !USES:
use MAPL_MemUtilsMod ! Optional memory prints
! !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: The run method for the GIGC gridded component calls the
! children`s run methods. It also prepares inputs and couplings amongst them.
!EOP
! ErrLog Variables
character(len=ESMF_MAXSTR) :: IAm
integer :: STATUS
character(len=ESMF_MAXSTR) :: COMP_NAME
! Local derived type aliases
type (MAPL_MetaComp), pointer :: STATE
type (ESMF_GridComp), pointer :: GCS(:)
type (ESMF_State), pointer :: GIM(:)
type (ESMF_State), pointer :: GEX(:)
type (ESMF_State) :: INTERNAL
type (ESMF_Config) :: CF
type (ESMF_VM) :: VM
character(len=ESMF_MAXSTR),pointer :: GCNames(:)
integer :: I, L
integer :: IM, JM, LM
real :: DT
!=============================================================================
! Begin...
! Get the target component name and set-up traceback handle
! ---------------------------------------------------------
Iam = "Run"
call ESMF_GridCompGet ( GC, name=COMP_NAME, config=CF, RC=STATUS )
_VERIFY(STATUS)
Iam = trim(COMP_NAME) // "::" // Iam
! Get my internal MAPL_Generic state
!-----------------------------------
call MAPL_GetObjectFromGC ( GC, STATE, RC=STATUS)
_VERIFY(STATUS)
! Get the VM for optional memory prints (level >= 1)
!-----------------------------------
if ( MemDebugLevel > 0 ) THEN
call ESMF_VmGetCurrent(VM, RC=STATUS)
_VERIFY(STATUS)
endif
! Start timers
!-------------
call MAPL_TimerOn(STATE,"TOTAL")
call MAPL_TimerOn(STATE,"RUN")
! Get the children`s states from the generic state
!-------------------------------------------------
call MAPL_Get ( STATE, &
GCS=GCS, &
GIM=GIM, &
GEX=GEX, &
IM = IM, &
JM = JM, &
LM = LM, &
GCNames = GCNames, &
INTERNAL_ESMF_STATE = INTERNAL, &
RC = STATUS )
_VERIFY(STATUS)
! Get heartbeat
!--------------
call ESMF_ConfigGetAttribute(CF, DT, Label="RUN_DT:" , RC=STATUS)
_VERIFY(STATUS)
! Cinderella Component: to derive variables for other components
!---------------------
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, before GEOS_ctmE: ', RC=STATUS )
_VERIFY(STATUS)
endif
call MAPL_TimerOn ( STATE, GCNames(ECTM) )
call ESMF_GridCompRun ( GCS(ECTM), &
importState = GIM(ECTM), &
exportState = GEX(ECTM), &
clock = CLOCK, &
userRC = STATUS )
_VERIFY(STATUS)
call MAPL_TimerOff( STATE, GCNames(ECTM) )
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, after GEOS_ctmE: ', RC=STATUS )
_VERIFY(STATUS)
endif
! Dynamics & Advection
!------------------
! SDE 2017-02-18: This needs to run even if transport is off, as it is
! responsible for the pressure level edge arrays. It already has an internal
! switch ("AdvCore_Advection") which can be used to prevent any actual
! transport taking place by bypassing the advection calculation.
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, before Advection: ', RC=STATUS )
_VERIFY(STATUS)
endif
call MAPL_TimerOn ( STATE, GCNames(ADV) )
call ESMF_GridCompRun ( GCS(ADV), &
importState = GIM(ADV), &
exportState = GEX(ADV), &
clock = CLOCK, &
userRC = STATUS );
_VERIFY(STATUS)
call MAPL_GenericRunCouplers (STATE, ADV, CLOCK, RC=STATUS );
_VERIFY(STATUS)
call MAPL_TimerOff( STATE, GCNames(ADV) )
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, after Advection: ', RC=STATUS )
_VERIFY(STATUS)
endif
! Chemistry
!------------------
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, before GEOS-Chem: ', RC=STATUS )
_VERIFY(STATUS)
endif
call MAPL_TimerOn ( STATE, GCNames(CHEM) )
call ESMF_GridCompRun ( GCS(CHEM), &
importState = GIM(CHEM), &
exportState = GEX(CHEM), &
clock = CLOCK, &
userRC = STATUS );
_VERIFY(STATUS)
call MAPL_GenericRunCouplers (STATE, CHEM, CLOCK, RC=STATUS );
_VERIFY(STATUS)
call MAPL_TimerOff(STATE,GCNames(CHEM))
if ( MemDebugLevel > 0 ) THEN
call ESMF_VMBarrier(VM, RC=STATUS)
_VERIFY(STATUS)
call MAPL_MemUtilsWrite(VM, &
'GIGC, after GEOS-Chem: ', RC=STATUS )
_VERIFY(STATUS)
endif
call MAPL_TimerOff(STATE,"RUN")
call MAPL_TimerOff(STATE,"TOTAL")
_RETURN(ESMF_SUCCESS)
end subroutine Run
!=============================================================================
subroutine Finalize ( 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: The Finalize method
!EOP
! ErrLog Variables
character(len=ESMF_MAXSTR) :: IAm
integer :: STATUS
character(len=ESMF_MAXSTR) :: COMP_NAME
! Get the target component name and set-up traceback handle
Iam = "Finalize"
call ESMF_GridCompGet ( GC, name=COMP_NAME, RC=STATUS )
_VERIFY(STATUS)
Iam = trim(COMP_NAME) // Iam
! Call generic finalize
call MAPL_GenericFinalize( GC, IMPORT, EXPORT, CLOCK, RC=STATUS )
_VERIFY(STATUS)
! Destroy import and export states
call ESMF_StateDestroy(IMPORT, rc=status)
_VERIFY(STATUS)
call ESMF_StateDestroy(EXPORT, rc=status)
_VERIFY(STATUS)
_RETURN(ESMF_SUCCESS)
end subroutine Finalize
!=============================================================================
end module GIGC_GridCompMod