1 | MODULE cpl_oasis3 |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE cpl_oasis *** |
---|
4 | !! Coupled O/A : coupled ocean-atmosphere case using OASIS3 V. prism_2_4 |
---|
5 | !! special case: NEMO OPA/LIM coupled to ECHAM5 |
---|
6 | !!===================================================================== |
---|
7 | !! History : |
---|
8 | !! 9.0 ! 04-06 (R. Redler, NEC Laboratories Europe, Germany) Original code |
---|
9 | !! " " ! 04-11 (R. Redler, NEC Laboratories Europe; N. Keenlyside, W. Park, IFM-GEOMAR, Germany) revision |
---|
10 | !! " " ! 04-11 (V. Gayler, MPI M&D) Grid writing |
---|
11 | !! " " ! 05-08 (R. Redler, W. Park) frld initialization, paral(2) revision |
---|
12 | !! " " ! 05-09 (R. Redler) extended to allow for communication over root only |
---|
13 | !! " " ! 06-01 (W. Park) modification of physical part |
---|
14 | !! " " ! 06-02 (R. Redler, W. Park) buffer array fix for root exchange |
---|
15 | !! 3.4 ! 11-11 (C. Harris) Changes to allow mutiple category fields |
---|
16 | !!---------------------------------------------------------------------- |
---|
17 | #if defined key_oasis3 |
---|
18 | !!---------------------------------------------------------------------- |
---|
19 | !! 'key_oasis3' coupled Ocean/Atmosphere via OASIS3 |
---|
20 | !!---------------------------------------------------------------------- |
---|
21 | !! cpl_prism_init : initialization of coupled mode communication |
---|
22 | !! cpl_prism_define : definition of grid and fields |
---|
23 | !! cpl_prism_snd : snd out fields in coupled mode |
---|
24 | !! cpl_prism_rcv : receive fields in coupled mode |
---|
25 | !! cpl_prism_finalize : finalize the coupled mode communication |
---|
26 | !!---------------------------------------------------------------------- |
---|
27 | USE mod_prism_proto ! OASIS3 prism module |
---|
28 | USE mod_prism_def_partition_proto! OASIS3 prism module for partitioning |
---|
29 | USE mod_prism_put_proto ! OASIS3 prism module for snding |
---|
30 | USE mod_prism_get_proto ! OASIS3 prism module for receiving |
---|
31 | USE mod_comprism_proto ! OASIS3 prism module to get coupling frequency |
---|
32 | USE par_oce ! ocean parameters |
---|
33 | USE dom_oce ! ocean space and time domain |
---|
34 | USE in_out_manager ! I/O manager |
---|
35 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
36 | |
---|
37 | IMPLICIT NONE |
---|
38 | PRIVATE |
---|
39 | |
---|
40 | PUBLIC cpl_prism_init |
---|
41 | PUBLIC cpl_prism_define |
---|
42 | PUBLIC cpl_prism_snd |
---|
43 | PUBLIC cpl_prism_rcv |
---|
44 | PUBLIC cpl_prism_freq |
---|
45 | PUBLIC cpl_prism_finalize |
---|
46 | |
---|
47 | LOGICAL, PUBLIC, PARAMETER :: lk_cpl = .TRUE. !: coupled flag |
---|
48 | INTEGER, PUBLIC :: OASIS_Rcv = 1 !: return code if received field |
---|
49 | INTEGER, PUBLIC :: OASIS_idle = 0 !: return code if nothing done by oasis |
---|
50 | INTEGER :: ncomp_id ! id returned by prism_init_comp |
---|
51 | INTEGER :: nerror ! return error code |
---|
52 | |
---|
53 | INTEGER, PARAMETER :: nmaxfld=40 ! Maximum number of coupling fields |
---|
54 | |
---|
55 | TYPE, PUBLIC :: FLD_CPL !: Type for coupling field information |
---|
56 | LOGICAL :: laction ! To be coupled or not |
---|
57 | CHARACTER(len = 8) :: clname ! Name of the coupling field |
---|
58 | CHARACTER(len = 1) :: clgrid ! Grid type |
---|
59 | REAL(wp) :: nsgn ! Control of the sign change |
---|
60 | INTEGER, DIMENSION(9) :: nid ! Id of the field (no more than 9 categories) |
---|
61 | INTEGER :: nct ! Number of categories in field |
---|
62 | END TYPE FLD_CPL |
---|
63 | |
---|
64 | TYPE(FLD_CPL), DIMENSION(nmaxfld), PUBLIC :: srcv, ssnd !: Coupling fields |
---|
65 | |
---|
66 | REAL(wp), DIMENSION(:,:), ALLOCATABLE :: exfld ! Temporary buffer for receiving |
---|
67 | |
---|
68 | !!---------------------------------------------------------------------- |
---|
69 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
70 | !! $Id$ |
---|
71 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
72 | !!---------------------------------------------------------------------- |
---|
73 | CONTAINS |
---|
74 | |
---|
75 | SUBROUTINE cpl_prism_init( kl_comm ) |
---|
76 | !!------------------------------------------------------------------- |
---|
77 | !! *** ROUTINE cpl_prism_init *** |
---|
78 | !! |
---|
79 | !! ** Purpose : Initialize coupled mode communication for ocean |
---|
80 | !! exchange between AGCM, OGCM and COUPLER. (OASIS3 software) |
---|
81 | !! |
---|
82 | !! ** Method : OASIS3 MPI communication |
---|
83 | !!-------------------------------------------------------------------- |
---|
84 | INTEGER, INTENT(out) :: kl_comm ! local communicator of the model |
---|
85 | !!-------------------------------------------------------------------- |
---|
86 | |
---|
87 | ! WARNING: No write in numout in this routine |
---|
88 | !============================================ |
---|
89 | |
---|
90 | !------------------------------------------------------------------ |
---|
91 | ! 1st Initialize the PRISM system for the application |
---|
92 | !------------------------------------------------------------------ |
---|
93 | CALL prism_init_comp_proto ( ncomp_id, 'oceanx', nerror ) |
---|
94 | IF ( nerror /= PRISM_Ok ) & |
---|
95 | CALL prism_abort_proto (ncomp_id, 'cpl_prism_init', 'Failure in prism_init_comp_proto') |
---|
96 | |
---|
97 | !------------------------------------------------------------------ |
---|
98 | ! 3rd Get an MPI communicator for OPA local communication |
---|
99 | !------------------------------------------------------------------ |
---|
100 | |
---|
101 | CALL prism_get_localcomm_proto ( kl_comm, nerror ) |
---|
102 | IF ( nerror /= PRISM_Ok ) & |
---|
103 | CALL prism_abort_proto (ncomp_id, 'cpl_prism_init','Failure in prism_get_localcomm_proto' ) |
---|
104 | ! |
---|
105 | END SUBROUTINE cpl_prism_init |
---|
106 | |
---|
107 | |
---|
108 | SUBROUTINE cpl_prism_define( krcv, ksnd ) |
---|
109 | !!------------------------------------------------------------------- |
---|
110 | !! *** ROUTINE cpl_prism_define *** |
---|
111 | !! |
---|
112 | !! ** Purpose : Define grid and field information for ocean |
---|
113 | !! exchange between AGCM, OGCM and COUPLER. (OASIS3 software) |
---|
114 | !! |
---|
115 | !! ** Method : OASIS3 MPI communication |
---|
116 | !!-------------------------------------------------------------------- |
---|
117 | INTEGER, INTENT(in) :: krcv, ksnd ! Number of received and sent coupling fields |
---|
118 | ! |
---|
119 | INTEGER :: id_part |
---|
120 | INTEGER :: paral(5) ! OASIS3 box partition |
---|
121 | INTEGER :: ishape(2,2) ! shape of arrays passed to PSMILe |
---|
122 | INTEGER :: ji,jc ! local loop indicees |
---|
123 | CHARACTER(LEN=8) :: zclname |
---|
124 | !!-------------------------------------------------------------------- |
---|
125 | |
---|
126 | IF(lwp) WRITE(numout,*) |
---|
127 | IF(lwp) WRITE(numout,*) 'cpl_prism_define : initialization in coupled ocean/atmosphere case' |
---|
128 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~~~' |
---|
129 | IF(lwp) WRITE(numout,*) |
---|
130 | |
---|
131 | ! |
---|
132 | ! ... Define the shape for the area that excludes the halo |
---|
133 | ! For serial configuration (key_mpp_mpi not being active) |
---|
134 | ! nl* is set to the global values 1 and jp*glo. |
---|
135 | ! |
---|
136 | ishape(:,1) = (/ 1, nlei-nldi+1 /) |
---|
137 | ishape(:,2) = (/ 1, nlej-nldj+1 /) |
---|
138 | ! |
---|
139 | ! ... Allocate memory for data exchange |
---|
140 | ! |
---|
141 | ALLOCATE(exfld(nlei-nldi+1, nlej-nldj+1), stat = nerror) |
---|
142 | IF( nerror > 0 ) THEN |
---|
143 | CALL prism_abort_proto ( ncomp_id, 'cpl_prism_define', 'Failure in allocating exfld') ; RETURN |
---|
144 | ENDIF |
---|
145 | ! |
---|
146 | ! ----------------------------------------------------------------- |
---|
147 | ! ... Define the partition |
---|
148 | ! ----------------------------------------------------------------- |
---|
149 | |
---|
150 | paral(1) = 2 ! box partitioning |
---|
151 | paral(2) = jpiglo * (nldj-1+njmpp-1) + (nldi-1+nimpp-1) ! NEMO lower left corner global offset |
---|
152 | paral(3) = nlei-nldi+1 ! local extent in i |
---|
153 | paral(4) = nlej-nldj+1 ! local extent in j |
---|
154 | paral(5) = jpiglo ! global extent in x |
---|
155 | |
---|
156 | IF( ln_ctl ) THEN |
---|
157 | WRITE(numout,*) ' multiexchg: paral (1:5)', paral |
---|
158 | WRITE(numout,*) ' multiexchg: jpi, jpj =', jpi, jpj |
---|
159 | WRITE(numout,*) ' multiexchg: nldi, nlei, nimpp =', nldi, nlei, nimpp |
---|
160 | WRITE(numout,*) ' multiexchg: nldj, nlej, njmpp =', nldj, nlej, njmpp |
---|
161 | ENDIF |
---|
162 | |
---|
163 | CALL prism_def_partition_proto ( id_part, paral, nerror ) |
---|
164 | ! |
---|
165 | ! ... Announce send variables. |
---|
166 | ! |
---|
167 | DO ji = 1, ksnd |
---|
168 | IF ( ssnd(ji)%laction ) THEN |
---|
169 | DO jc = 1, ssnd(ji)%nct |
---|
170 | IF ( ssnd(ji)%nct .gt. 1 ) THEN |
---|
171 | WRITE(zclname,'( a7, i1)') ssnd(ji)%clname,jc |
---|
172 | ELSE |
---|
173 | zclname=ssnd(ji)%clname |
---|
174 | ENDIF |
---|
175 | WRITE(numout,*) "Define",ji,jc,zclname," for",PRISM_Out |
---|
176 | CALL prism_def_var_proto (ssnd(ji)%nid(jc), zclname, id_part, (/ 2, 0/), & |
---|
177 | PRISM_Out, ishape, PRISM_REAL, nerror) |
---|
178 | IF ( nerror /= PRISM_Ok ) THEN |
---|
179 | WRITE(numout,*) 'Failed to define transient ', ji, TRIM(zclname) |
---|
180 | CALL prism_abort_proto ( ssnd(ji)%nid(jc), 'cpl_prism_define', 'Failure in prism_def_var') |
---|
181 | ENDIF |
---|
182 | END DO |
---|
183 | ENDIF |
---|
184 | END DO |
---|
185 | ! |
---|
186 | ! ... Announce received variables. |
---|
187 | ! |
---|
188 | DO ji = 1, krcv |
---|
189 | IF ( srcv(ji)%laction ) THEN |
---|
190 | DO jc = 1, srcv(ji)%nct |
---|
191 | IF ( srcv(ji)%nct .gt. 1 ) THEN |
---|
192 | WRITE(zclname,'( a7, i1)') srcv(ji)%clname,jc |
---|
193 | ELSE |
---|
194 | zclname=srcv(ji)%clname |
---|
195 | ENDIF |
---|
196 | WRITE(numout,*) "Define",ji,jc,zclname," for",PRISM_In |
---|
197 | CALL prism_def_var_proto ( srcv(ji)%nid(jc), zclname, id_part, (/ 2, 0/), & |
---|
198 | & PRISM_In , ishape , PRISM_REAL, nerror) |
---|
199 | IF ( nerror /= PRISM_Ok ) THEN |
---|
200 | WRITE(numout,*) 'Failed to define transient ', ji, TRIM(zclname) |
---|
201 | CALL prism_abort_proto ( srcv(ji)%nid(jc), 'cpl_prism_define', 'Failure in prism_def_var') |
---|
202 | ENDIF |
---|
203 | END DO |
---|
204 | ENDIF |
---|
205 | END DO |
---|
206 | |
---|
207 | !------------------------------------------------------------------ |
---|
208 | ! End of definition phase |
---|
209 | !------------------------------------------------------------------ |
---|
210 | |
---|
211 | CALL prism_enddef_proto(nerror) |
---|
212 | IF( nerror /= PRISM_Ok ) CALL prism_abort_proto ( ncomp_id, 'cpl_prism_define', 'Failure in prism_enddef') |
---|
213 | ! |
---|
214 | END SUBROUTINE cpl_prism_define |
---|
215 | |
---|
216 | |
---|
217 | SUBROUTINE cpl_prism_snd( kid, kstep, pdata, kinfo ) |
---|
218 | !!--------------------------------------------------------------------- |
---|
219 | !! *** ROUTINE cpl_prism_snd *** |
---|
220 | !! |
---|
221 | !! ** Purpose : - At each coupling time-step,this routine sends fields |
---|
222 | !! like sst or ice cover to the coupler or remote application. |
---|
223 | !!---------------------------------------------------------------------- |
---|
224 | INTEGER , INTENT(in ) :: kid ! variable index in the array |
---|
225 | INTEGER , INTENT( out) :: kinfo ! OASIS3 info argument |
---|
226 | INTEGER , INTENT(in ) :: kstep ! ocean time-step in seconds |
---|
227 | REAL(wp), DIMENSION(:,:,:), INTENT(in ) :: pdata |
---|
228 | !! |
---|
229 | INTEGER :: jc ! local loop index |
---|
230 | !!-------------------------------------------------------------------- |
---|
231 | ! |
---|
232 | ! snd data to OASIS3 |
---|
233 | ! |
---|
234 | DO jc = 1, ssnd(kid)%nct |
---|
235 | |
---|
236 | CALL prism_put_proto ( ssnd(kid)%nid(jc), kstep, pdata(nldi:nlei, nldj:nlej,jc), kinfo ) |
---|
237 | |
---|
238 | IF ( ln_ctl ) THEN |
---|
239 | IF ( kinfo == PRISM_Sent .OR. kinfo == PRISM_ToRest .OR. & |
---|
240 | & kinfo == PRISM_SentOut .OR. kinfo == PRISM_ToRestOut ) THEN |
---|
241 | WRITE(numout,*) '****************' |
---|
242 | WRITE(numout,*) 'prism_put_proto: Outgoing ', ssnd(kid)%clname |
---|
243 | WRITE(numout,*) 'prism_put_proto: ivarid ', ssnd(kid)%nid(jc) |
---|
244 | WRITE(numout,*) 'prism_put_proto: kstep ', kstep |
---|
245 | WRITE(numout,*) 'prism_put_proto: info ', kinfo |
---|
246 | WRITE(numout,*) ' - Minimum value is ', MINVAL(pdata(:,:,jc)) |
---|
247 | WRITE(numout,*) ' - Maximum value is ', MAXVAL(pdata(:,:,jc)) |
---|
248 | WRITE(numout,*) ' - Sum value is ', SUM(pdata(:,:,jc)) |
---|
249 | WRITE(numout,*) '****************' |
---|
250 | ENDIF |
---|
251 | ENDIF |
---|
252 | |
---|
253 | ENDDO |
---|
254 | ! |
---|
255 | END SUBROUTINE cpl_prism_snd |
---|
256 | |
---|
257 | |
---|
258 | SUBROUTINE cpl_prism_rcv( kid, kstep, pdata, kinfo ) |
---|
259 | !!--------------------------------------------------------------------- |
---|
260 | !! *** ROUTINE cpl_prism_rcv *** |
---|
261 | !! |
---|
262 | !! ** Purpose : - At each coupling time-step,this routine receives fields |
---|
263 | !! like stresses and fluxes from the coupler or remote application. |
---|
264 | !!---------------------------------------------------------------------- |
---|
265 | INTEGER , INTENT(in ) :: kid ! variable index in the array |
---|
266 | INTEGER , INTENT(in ) :: kstep ! ocean time-step in seconds |
---|
267 | REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: pdata ! IN to keep the value if nothing is done |
---|
268 | INTEGER , INTENT( out) :: kinfo ! OASIS3 info argument |
---|
269 | !! |
---|
270 | INTEGER :: jc ! local loop index |
---|
271 | LOGICAL :: llaction |
---|
272 | !!-------------------------------------------------------------------- |
---|
273 | ! |
---|
274 | ! receive local data from OASIS3 on every process |
---|
275 | ! |
---|
276 | DO jc = 1, srcv(kid)%nct |
---|
277 | |
---|
278 | CALL prism_get_proto ( srcv(kid)%nid(jc), kstep, exfld, kinfo ) |
---|
279 | |
---|
280 | llaction = .false. |
---|
281 | IF( kinfo == PRISM_Recvd .OR. kinfo == PRISM_FromRest .OR. & |
---|
282 | kinfo == PRISM_RecvOut .OR. kinfo == PRISM_FromRestOut ) llaction = .TRUE. |
---|
283 | |
---|
284 | IF ( ln_ctl ) WRITE(numout,*) "llaction, kinfo, kstep, ivarid: " , llaction, kinfo, kstep, srcv(kid)%nid(jc) |
---|
285 | |
---|
286 | IF ( llaction ) THEN |
---|
287 | |
---|
288 | pdata(nldi:nlei, nldj:nlej,jc) = exfld(:,:) |
---|
289 | |
---|
290 | !--- Fill the overlap areas and extra hallows (mpp) |
---|
291 | !--- check periodicity conditions (all cases) |
---|
292 | CALL lbc_lnk( pdata(:,:,jc), srcv(kid)%clgrid, srcv(kid)%nsgn ) |
---|
293 | |
---|
294 | IF ( ln_ctl ) THEN |
---|
295 | WRITE(numout,*) '****************' |
---|
296 | WRITE(numout,*) 'prism_get_proto: Incoming ', srcv(kid)%clname |
---|
297 | WRITE(numout,*) 'prism_get_proto: ivarid ' , srcv(kid)%nid(jc) |
---|
298 | WRITE(numout,*) 'prism_get_proto: kstep', kstep |
---|
299 | WRITE(numout,*) 'prism_get_proto: info ', kinfo |
---|
300 | WRITE(numout,*) ' - Minimum value is ', MINVAL(pdata(:,:,jc)) |
---|
301 | WRITE(numout,*) ' - Maximum value is ', MAXVAL(pdata(:,:,jc)) |
---|
302 | WRITE(numout,*) ' - Sum value is ', SUM(pdata(:,:,jc)) |
---|
303 | WRITE(numout,*) '****************' |
---|
304 | ENDIF |
---|
305 | |
---|
306 | ! Ideally we would not reuse kinfo, but define a separate variable |
---|
307 | ! for use as the return code from this routine to avoid confusion |
---|
308 | ! with the return code previously obtained from the coupler. |
---|
309 | kinfo = OASIS_Rcv |
---|
310 | |
---|
311 | ELSE |
---|
312 | kinfo = OASIS_idle |
---|
313 | ENDIF |
---|
314 | |
---|
315 | ENDDO |
---|
316 | ! |
---|
317 | END SUBROUTINE cpl_prism_rcv |
---|
318 | |
---|
319 | |
---|
320 | INTEGER FUNCTION cpl_prism_freq( kid ) |
---|
321 | !!--------------------------------------------------------------------- |
---|
322 | !! *** ROUTINE cpl_prism_freq *** |
---|
323 | !! |
---|
324 | !! ** Purpose : - send back the coupling frequency for a particular field |
---|
325 | !!---------------------------------------------------------------------- |
---|
326 | INTEGER,INTENT(in) :: kid ! variable index |
---|
327 | !!---------------------------------------------------------------------- |
---|
328 | cpl_prism_freq = ig_def_freq( kid ) |
---|
329 | ! |
---|
330 | END FUNCTION cpl_prism_freq |
---|
331 | |
---|
332 | |
---|
333 | SUBROUTINE cpl_prism_finalize |
---|
334 | !!--------------------------------------------------------------------- |
---|
335 | !! *** ROUTINE cpl_prism_finalize *** |
---|
336 | !! |
---|
337 | !! ** Purpose : - Finalizes the coupling. If MPI_init has not been |
---|
338 | !! called explicitly before cpl_prism_init it will also close |
---|
339 | !! MPI communication. |
---|
340 | !!---------------------------------------------------------------------- |
---|
341 | ! |
---|
342 | DEALLOCATE( exfld ) |
---|
343 | CALL prism_terminate_proto( nerror ) |
---|
344 | ! |
---|
345 | END SUBROUTINE cpl_prism_finalize |
---|
346 | |
---|
347 | #else |
---|
348 | !!---------------------------------------------------------------------- |
---|
349 | !! Default case Dummy module Forced Ocean/Atmosphere |
---|
350 | !!---------------------------------------------------------------------- |
---|
351 | USE in_out_manager ! I/O manager |
---|
352 | LOGICAL, PUBLIC, PARAMETER :: lk_cpl = .FALSE. !: coupled flag |
---|
353 | PUBLIC cpl_prism_init |
---|
354 | PUBLIC cpl_prism_finalize |
---|
355 | CONTAINS |
---|
356 | SUBROUTINE cpl_prism_init (kl_comm) |
---|
357 | INTEGER, INTENT(out) :: kl_comm ! local communicator of the model |
---|
358 | kl_comm = -1 |
---|
359 | WRITE(numout,*) 'cpl_prism_init: Error you sould not be there...' |
---|
360 | END SUBROUTINE cpl_prism_init |
---|
361 | SUBROUTINE cpl_prism_finalize |
---|
362 | WRITE(numout,*) 'cpl_prism_finalize: Error you sould not be there...' |
---|
363 | END SUBROUTINE cpl_prism_finalize |
---|
364 | #endif |
---|
365 | |
---|
366 | !!===================================================================== |
---|
367 | END MODULE cpl_oasis3 |
---|