forked from HYCOM/HYCOM-src
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mod_OICPL.F90
267 lines (259 loc) · 8.9 KB
/
mod_OICPL.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
module mod_OICPL !ocean-ice coupler
!
! --- ESMF Framework module
use ESMF_Mod
!
implicit none
private
!
public OICPL_SetServices
!
! --- phase info
integer, parameter, public :: ice2ocn_phase = 1
integer, parameter, public :: ocn2ice_phase = 2
!
! --- VM and PET info
type(ESMF_VM), save :: vm
integer, save :: petCount,localPet
!
! --- Route handles for regridding and/or redistribution
type(ESMF_RouteHandle), save :: &
i2oRouteHandle, o2iRouteHandle
contains
subroutine OICPL_SetServices(cplComp, rc)
!
type(ESMF_CplComp) :: cplComp
integer, intent(out) :: rc
!
call ESMF_CplCompSetEntryPoint( &
cplComp, &
ESMF_SETINIT, &
OICPL_Init, &
ESMF_SINGLEPHASE, &
rc=rc)
call ESMF_CplCompSetEntryPoint( &
cplComp, &
ESMF_SETRUN, &
OICPL_Run_I2O, &
ice2ocn_phase, &
rc=rc)
call ESMF_CplCompSetEntryPoint( &
cplComp, &
ESMF_SETRUN, &
OICPL_Run_O2I, &
ocn2ice_phase, &
rc=rc)
call ESMF_CplCompSetEntryPoint( &
cplComp, &
ESMF_SETFINAL, &
OICPL_Final, &
ESMF_SINGLEPHASE, &
rc=rc)
!
end subroutine OICPL_SetServices
subroutine OICPL_Init(cplComp, impState, expState, extClock, rc)
!
! --- Calling parameters
type(ESMF_CplComp) :: cplComp
type(ESMF_State) :: impState
type(ESMF_State) :: expState
type(ESMF_Clock) :: extClock
integer, intent(out) :: rc
!
! --- Locals
integer :: rc2
type(ESMF_State) :: oiState, oeState, iiState, ieState
type(ESMF_FieldBundle) :: ocnBundle, iceBundle
!
! --- Report
call ESMF_LogWrite("OICPL initialize routine called", &
ESMF_LOG_INFO, rc=rc)
call ESMF_LogFlush(rc=rc)
!
! --- Get VM
call ESMF_CplCompGet(cplComp, vm=vm, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get VM failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get PET info
call ESMF_VMGet(vm, petCount=petCount, localPET=localPet, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get VM info failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get OCEAN and SEAICE import states
call ESMF_StateGet(impState, "OCEAN Import", oiState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get OCEAN impState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
call ESMF_StateGet(impState, "SEAICE Import", iiState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get SEAICE impState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get OCEAN and SEAICE export states
call ESMF_StateGet(expState, "OCEAN Export", oeState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get OCEAN expState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
call ESMF_StateGet(expState, "SEAICE Export", ieState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get SEAICE expState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Initialize I2O
!
! --- Get bundle for ocn
call ESMF_StateGet(oiState, "HYCOM Import", ocnBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get HYCOM Import failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ice
call ESMF_StateGet(ieState, "CICE Export", iceBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get CICE Export failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Transfer fields from ice state to ocn state
call ESMF_FieldBundleRedistStore(iceBundle, ocnBundle, &
i2oRouteHandle, rc=rc)
if (ESMF_LogMsgFoundError(rc, &
"FieldBundleRedistStore i2o failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! Initialize O2I
!
! --- Get bundle for ice
call ESMF_StateGet(iiState, "CICE Import", iceBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get CICE Import failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ocn
call ESMF_StateGet(oeState, "HYCOM Export", ocnBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get HYCOM Export failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Setup O2I route handle
call ESMF_FieldBundleRedistStore(ocnBundle, iceBundle, &
o2iRouteHandle, rc=rc)
if (ESMF_LogMsgFoundError(rc, &
"FieldBundleRedistStore o2i failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
return
end subroutine OICPL_Init
subroutine OICPL_Run_I2O(cplComp, impState, expState, extClock, &
rc)
!
! --- Calling parameters
type(ESMF_CplComp) :: cplComp
type(ESMF_State) :: impState
type(ESMF_State) :: expState
type(ESMF_Clock) :: extClock
integer, intent(out) :: rc
!
! --- Locals
integer :: rc2
type(ESMF_State) :: oiState, ieState
type(ESMF_FieldBundle) :: ocnBundle, iceBundle
!
! --- Report
call ESMF_LogWrite("OICPL I2O run routine called", &
ESMF_LOG_INFO, rc=rc)
call ESMF_LogFlush(rc=rc)
!
! --- Get OCEAN import state
call ESMF_StateGet(impState, "OCEAN Import", oiState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get OCEAN impState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get SEAICE export state
call ESMF_StateGet(expState, "SEAICE Export", ieState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get SEAICE expState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ocn
call ESMF_StateGet(oiState, "HYCOM Import", ocnBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get HYCOM Import failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ice
call ESMF_StateGet(ieState, "CICE Export", iceBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get CICE Export failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Transfer fields from ice state to ocn state
call ESMF_FieldBundleRedist(iceBundle, ocnBundle, &
i2oRouteHandle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "FieldBundleRedist i2o failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
return
end subroutine OICPL_Run_I2O
subroutine OICPL_Run_O2I(cplComp, impState, expState, extClock, &
rc)
!
! --- Calling parameters
type(ESMF_CplComp) :: cplComp
type(ESMF_State) :: impState
type(ESMF_State) :: expState
type(ESMF_Clock) :: extClock
integer, intent(out) :: rc
!
! --- Locals
integer :: rc2
type(ESMF_State) :: oeState, iiState
type(ESMF_FieldBundle) :: ocnBundle, iceBundle
!
! --- Report
call ESMF_LogWrite( "OICPL O2I run routine called", &
ESMF_LOG_INFO, rc=rc)
call ESMF_LogFlush(rc=rc)
!
! --- Get SEAICE import state
call ESMF_StateGet(impState, "SEAICE Import", iiState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get SEAICE impState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get OCEAN export state
call ESMF_StateGet(expState, "OCEAN Export", oeState, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get OCEAN expState failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ice
call ESMF_StateGet(iiState, "CICE Import", iceBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get CICE Import failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Get bundle for ocn
call ESMF_StateGet(oeState, "HYCOM Export", ocnBundle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "Get HYCOM Export failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
! --- Transfer fields from ocn state to ice state
call ESMF_FieldBundleRedist(ocnBundle, iceBundle, &
o2iRouteHandle, rc=rc)
if (ESMF_LogMsgFoundError(rc, "FieldBundleRedist o2i failed", &
rcToReturn=rc2)) call ESMF_Finalize(rc=rc)
!
return
end subroutine OICPL_Run_O2I
subroutine OICPL_Final(cplComp, impState, expState, extClock, rc)
!
! --- Calling parameters
type(ESMF_CplComp) :: cplComp
type(ESMF_State) :: impState
type(ESMF_State) :: expState
type(ESMF_Clock) :: extClock
integer, intent(out) :: rc
!
! --- Locals
!
! --- Report
call ESMF_LogWrite("OICPL finalize routine called", &
ESMF_LOG_INFO, rc=rc)
call ESMF_LogFlush(rc=rc)
!
! --- Release i2o regrid/redist route handle
call ESMF_FieldBundleRedistRelease(i2oRouteHandle, rc=rc)
!
! --- Release o2i regrid/redist route handle
call ESMF_FieldBundleRedistRelease(o2iRouteHandle, rc=rc)
!
return
end subroutine OICPL_Final
end module mod_OICPL