forked from esmf-org/esmf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ESMX_App.F90
262 lines (236 loc) · 11.1 KB
/
ESMX_App.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
!==============================================================================
! ESMX (Earth System Model eXecutable)
! This file contains the main ESMX Application program.
!==============================================================================
#define FILENAME "src/addon/ESMX/ESMF_App.F90"
!==============================================================================
!==============================================================================
! ESMX Application
!==============================================================================
program ESMX_App
use ESMF
use NUOPC
use ESMX_Driver, only: driverSS => SetServices, HConfigCreateFoundNode
implicit none
integer :: rc, urc
type(ESMF_GridComp) :: driver
type(ESMF_Config) :: config
type(ESMF_HConfig) :: hconfig, hconfigNode
character(:), allocatable :: configKey(:)
character(:), allocatable :: valueString
logical :: isFlag, logFlush
type(ESMF_Time) :: startTime, stopTime
type(ESMF_TimeInterval) :: timeStep
type(ESMF_Clock) :: clock
! Initialize ESMF
configKey = ["ESMX", "App "]
call ESMF_Initialize(configFilenameFromArgNum=1, & ! arg 1 to spec alt. config
configFileName="esmxRun.yaml", configKey=configKey, &
config=config, defaultCalkind=ESMF_CALKIND_GREGORIAN, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Access hconfig
call ESMF_ConfigGet(config, hconfig=hconfig, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Find hconfigNode that holds app level settings according to configKey
hconfigNode = HConfigCreateFoundNode(hconfig, configKey=configKey, &
foundFlag=isFlag, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (.not.isFlag) then
call ESMF_LogSetError(ESMF_RC_ARG_INCOMP, &
msg="Must provide settings for: "//configKey(1)//":"//configKey(2), &
line=__LINE__, file=FILENAME, rcToReturn=rc)
call ESMF_Finalize(endflag=ESMF_END_ABORT)
endif
! Validate hconfigNode against ESMX/App controlled key vocabulary
isFlag = ESMF_HConfigValidateMapKeys(hconfigNode, &
vocabulary=["defaultLogFilename ", & ! ESMF_Initialize option
"logAppendFlag ", & ! ESMF_Initialize option
"logKindFlag ", & ! ESMF_Initialize option
"globalResourceControl", & ! ESMF_Initialize option
"startTime ", & ! ESMX_App option
"stopTime ", & ! ESMX_App option
"logFlush ", & ! ESMX_App option
"fieldDictionary " & ! ESMX_App option
], badKey=valueString, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (.not.isFlag) then
call ESMF_LogSetError(ESMF_RC_ARG_WRONG, &
msg="An invalid key was found in config under ESMX/App (maybe a typo?): "//valueString, &
line=__LINE__, file=FILENAME, rcToReturn=rc)
call ESMF_Finalize(endflag=ESMF_END_ABORT)
endif
! Set logFlush
isFlag = ESMF_HConfigIsDefined(hconfigNode, keyString="logFlush", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (isFlag) then
logFlush = ESMF_HConfigAsLogical(hconfigNode, keyString="logFlush", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_LogSet(flush=logFlush, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
endif
! Log top banner
call ESMF_LogWrite("=============================================", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_LogWrite("ESMX (Earth System Model eXecutable) STARTING", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_LogWrite("=============================================", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Set field dictionary
isFlag = ESMF_HConfigIsDefined(hconfigNode, keyString="fieldDictionary", &
rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (isFlag) then
valueString = ESMF_HConfigAsString(hconfigNode, &
keyString="fieldDictionary", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call NUOPC_FieldDictionarySetup(fileName=valueString, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, &
msg="Unable to read Field Dictionary file: "//valueString, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
endif
! Create esmx driver
driver = ESMF_GridCompCreate(name="ESMX_Driver", config=config, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! SetServices esmx driver
call ESMF_GridCompSetServices(driver, driverSS, userRc=urc, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (ESMF_LogFoundError(rcToCheck=urc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Set run clock
valueString = ESMF_HConfigAsString(hconfigNode, keyString="startTime", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_TimeSet(startTime, timeString=valueString, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
valueString = ESMF_HConfigAsString(hconfigNode, keyString="stopTime", rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_TimeSet(stopTime, timeString=valueString, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! set the driver clock default timeStep = stopTime - startTime
! use with runSequence @*,
! or overwritten with explicit timeStep in runSequence
timeStep = stopTime - startTime
clock = ESMF_ClockCreate(name="ESMX Application Clock", &
timeStep=timeStep, startTime=startTime, stopTime=stopTime, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Destroy the hconfigNode
call ESMF_HConfigDestroy(hconfigNode, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Find hconfigNode that holds driver level attributes, conditionally ingest
configKey = ["ESMX ", "Driver ", "attributes"]
hconfigNode = HConfigCreateFoundNode(hconfig, configKey=configKey, &
foundFlag=isFlag, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (isFlag) then
call NUOPC_CompAttributeIngest(driver, hconfigNode, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
endif
! Destroy the hconfigNode
call ESMF_HConfigDestroy(hconfigNode, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Initialize esmx driver
call ESMF_GridCompInitialize(driver, clock=clock, userRc=urc, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (ESMF_LogFoundError(rcToCheck=urc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Run esmx driver
call ESMF_GridCompRun(driver, clock=clock, userRc=urc, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (ESMF_LogFoundError(rcToCheck=urc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Finalize esmx driver
call ESMF_GridCompFinalize(driver, clock=clock, userRc=urc, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
if (ESMF_LogFoundError(rcToCheck=urc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Destroy the esmx driver
call ESMF_GridCompDestroy(driver, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Destroy the clock
call ESMF_ClockDestroy(clock, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Log bottom banner
call ESMF_LogWrite("=============================================", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_LogWrite("ESMX (Earth System Model eXecutable) FINISHED", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
call ESMF_LogWrite("=============================================", &
ESMF_LOGMSG_INFO, rc=rc)
if (ESMF_LogFoundError(rcToCheck=rc, msg=ESMF_LOGERR_PASSTHRU, &
line=__LINE__, file=FILENAME)) &
call ESMF_Finalize(endflag=ESMF_END_ABORT)
! Finalize ESMF
call ESMF_Finalize(rc=rc)
if (rc /= ESMF_SUCCESS) then
write (ESMF_UtilIOStderr,*) "Error Finalizing ESMF"
endif
end program ESMX_App