1 | MODULE lib_fortran |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE lib_fortran *** |
---|
4 | !! Fortran utilities: includes some low levels fortran functionality |
---|
5 | !!====================================================================== |
---|
6 | !! History : 3.2 ! 2010-05 (M. Dunphy, R. Benshila) Original code |
---|
7 | !! 3.4 ! 2013-06 (C. Rousset) add glob_min, glob_max |
---|
8 | !! + 3d dim. of input is fexible (jpk, jpl...) |
---|
9 | !! 4.0 ! 2016-06 (T. Lovato) double precision global sum by default |
---|
10 | !!---------------------------------------------------------------------- |
---|
11 | |
---|
12 | !!---------------------------------------------------------------------- |
---|
13 | !! glob_sum : generic interface for global masked summation over |
---|
14 | !! the interior domain for 1 or 2 2D or 3D arrays |
---|
15 | !! it works only for T points |
---|
16 | !! SIGN : generic interface for SIGN to overwrite f95 behaviour |
---|
17 | !! of intrinsinc sign function |
---|
18 | !!---------------------------------------------------------------------- |
---|
19 | USE par_oce ! Ocean parameter |
---|
20 | USE dom_oce ! ocean domain |
---|
21 | USE in_out_manager ! I/O manager |
---|
22 | USE lib_mpp ! distributed memory computing |
---|
23 | |
---|
24 | IMPLICIT NONE |
---|
25 | PRIVATE |
---|
26 | |
---|
27 | PUBLIC glob_sum ! used in many places (masked with tmask_i) |
---|
28 | PUBLIC glob_sum_full ! used in many places (masked with tmask_h, ie only over the halos) |
---|
29 | PUBLIC DDPDD ! also used in closea module |
---|
30 | PUBLIC glob_min, glob_max |
---|
31 | #if defined key_nosignedzero |
---|
32 | PUBLIC SIGN |
---|
33 | #endif |
---|
34 | |
---|
35 | INTERFACE glob_sum |
---|
36 | MODULE PROCEDURE glob_sum_1d, glob_sum_2d, glob_sum_3d, & |
---|
37 | & glob_sum_2d_a, glob_sum_3d_a |
---|
38 | END INTERFACE |
---|
39 | INTERFACE glob_sum_full |
---|
40 | MODULE PROCEDURE glob_sum_full_2d, glob_sum_full_3d |
---|
41 | END INTERFACE |
---|
42 | INTERFACE glob_min |
---|
43 | MODULE PROCEDURE glob_min_2d, glob_min_3d,glob_min_2d_a, glob_min_3d_a |
---|
44 | END INTERFACE |
---|
45 | INTERFACE glob_max |
---|
46 | MODULE PROCEDURE glob_max_2d, glob_max_3d,glob_max_2d_a, glob_max_3d_a |
---|
47 | END INTERFACE |
---|
48 | |
---|
49 | #if defined key_nosignedzero |
---|
50 | INTERFACE SIGN |
---|
51 | MODULE PROCEDURE SIGN_SCALAR, SIGN_ARRAY_1D, SIGN_ARRAY_2D, SIGN_ARRAY_3D, & |
---|
52 | & SIGN_ARRAY_1D_A, SIGN_ARRAY_2D_A, SIGN_ARRAY_3D_A, & |
---|
53 | & SIGN_ARRAY_1D_B, SIGN_ARRAY_2D_B, SIGN_ARRAY_3D_B |
---|
54 | END INTERFACE |
---|
55 | #endif |
---|
56 | |
---|
57 | !!---------------------------------------------------------------------- |
---|
58 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
59 | !! $Id$ |
---|
60 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
61 | !!---------------------------------------------------------------------- |
---|
62 | CONTAINS |
---|
63 | |
---|
64 | ! --- SUM --- |
---|
65 | FUNCTION glob_sum_1d( ptab, kdim ) |
---|
66 | !!---------------------------------------------------------------------- |
---|
67 | !! *** FUNCTION glob_sum_1d *** |
---|
68 | !! |
---|
69 | !! ** Purpose : perform a sum in calling DDPDD routine |
---|
70 | !!---------------------------------------------------------------------- |
---|
71 | INTEGER , INTENT(in) :: kdim |
---|
72 | REAL(wp), INTENT(in), DIMENSION(kdim) :: ptab |
---|
73 | REAL(wp) :: glob_sum_1d ! global sum |
---|
74 | !! |
---|
75 | COMPLEX(wp):: ctmp |
---|
76 | REAL(wp) :: ztmp |
---|
77 | INTEGER :: ji ! dummy loop indices |
---|
78 | !!----------------------------------------------------------------------- |
---|
79 | ! |
---|
80 | ztmp = 0.e0 |
---|
81 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
82 | DO ji = 1, kdim |
---|
83 | ztmp = ptab(ji) |
---|
84 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
85 | END DO |
---|
86 | IF( lk_mpp ) CALL mpp_sum( ctmp ) ! sum over the global domain |
---|
87 | glob_sum_1d = REAL(ctmp,wp) |
---|
88 | ! |
---|
89 | END FUNCTION glob_sum_1d |
---|
90 | |
---|
91 | FUNCTION glob_sum_c1d(ptab, kdim) |
---|
92 | INTEGER, INTENT(IN) :: kdim |
---|
93 | COMPLEX(KIND = wp), INTENT(IN), DIMENSION(kdim) :: ptab |
---|
94 | REAL(KIND = wp) :: glob_sum_c1d |
---|
95 | COMPLEX(KIND = wp) :: ctmp |
---|
96 | INTEGER :: ji |
---|
97 | |
---|
98 | ctmp = CMPLX(0.E0, 0.E0, wp) |
---|
99 | |
---|
100 | DO ji = 1, kdim |
---|
101 | CALL DDPDD(ptab(ji), ctmp) |
---|
102 | END DO |
---|
103 | |
---|
104 | IF (lk_mpp) CALL mpp_sum(ctmp) |
---|
105 | |
---|
106 | glob_sum_c1d = REAL(ctmp, wp) |
---|
107 | END FUNCTION glob_sum_c1d |
---|
108 | |
---|
109 | FUNCTION glob_sum_2d( ptab ) |
---|
110 | !!---------------------------------------------------------------------- |
---|
111 | !! *** FUNCTION glob_sum_2d *** |
---|
112 | !! |
---|
113 | !! ** Purpose : perform a sum in calling DDPDD routine |
---|
114 | !!---------------------------------------------------------------------- |
---|
115 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab |
---|
116 | REAL(wp) :: glob_sum_2d ! global masked sum |
---|
117 | !! |
---|
118 | COMPLEX(wp):: ctmp |
---|
119 | REAL(wp) :: ztmp |
---|
120 | INTEGER :: ji, jj ! dummy loop indices |
---|
121 | COMPLEX(KIND = wp) :: hsum(jpj) |
---|
122 | !!----------------------------------------------------------------------- |
---|
123 | ! |
---|
124 | DO jj = 1, jpj |
---|
125 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
126 | DO ji =1, jpi |
---|
127 | ztmp = ptab(ji,jj) * tmask_i(ji,jj) |
---|
128 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
129 | END DO |
---|
130 | hsum(jj) = ctmp |
---|
131 | END DO |
---|
132 | glob_sum_2d = glob_sum_c1d(hsum, jpj) |
---|
133 | ! |
---|
134 | END FUNCTION glob_sum_2d |
---|
135 | |
---|
136 | |
---|
137 | FUNCTION glob_sum_3d( ptab ) |
---|
138 | !!---------------------------------------------------------------------- |
---|
139 | !! *** FUNCTION glob_sum_3d *** |
---|
140 | !! |
---|
141 | !! ** Purpose : perform a sum on a 3D array in calling DDPDD routine |
---|
142 | !!---------------------------------------------------------------------- |
---|
143 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab |
---|
144 | REAL(wp) :: glob_sum_3d ! global masked sum |
---|
145 | !! |
---|
146 | COMPLEX(wp):: ctmp |
---|
147 | REAL(wp) :: ztmp |
---|
148 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
149 | INTEGER :: ijpk ! local variables: size of ptab |
---|
150 | COMPLEX(KIND = wp), allocatable :: hsum(:) |
---|
151 | !!----------------------------------------------------------------------- |
---|
152 | ! |
---|
153 | ijpk = SIZE(ptab,3) |
---|
154 | ALLOCATE(hsum(ijpk)) |
---|
155 | ! |
---|
156 | DO jk = 1, ijpk |
---|
157 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
158 | DO jj = 1, jpj |
---|
159 | DO ji =1, jpi |
---|
160 | ztmp = ptab(ji,jj,jk) * tmask_i(ji,jj) |
---|
161 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
162 | END DO |
---|
163 | END DO |
---|
164 | hsum(jk) = ctmp |
---|
165 | END DO |
---|
166 | glob_sum_3d = glob_sum_c1d(hsum, ijpk) |
---|
167 | DEALLOCATE(hsum) |
---|
168 | ! |
---|
169 | END FUNCTION glob_sum_3d |
---|
170 | |
---|
171 | |
---|
172 | FUNCTION glob_sum_2d_a( ptab1, ptab2 ) |
---|
173 | !!---------------------------------------------------------------------- |
---|
174 | !! *** FUNCTION glob_sum_2d_a *** |
---|
175 | !! |
---|
176 | !! ** Purpose : perform a sum on two 2D arrays in calling DDPDD routine |
---|
177 | !!---------------------------------------------------------------------- |
---|
178 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab1, ptab2 |
---|
179 | REAL(wp) :: glob_sum_2d_a ! global masked sum |
---|
180 | !! |
---|
181 | COMPLEX(wp):: ctmp |
---|
182 | REAL(wp) :: ztmp |
---|
183 | INTEGER :: ji, jj ! dummy loop indices |
---|
184 | COMPLEX(KIND = wp) :: hsum(jpj) |
---|
185 | !!----------------------------------------------------------------------- |
---|
186 | ! |
---|
187 | DO jj = 1, jpj |
---|
188 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
189 | DO ji =1, jpi |
---|
190 | ztmp = ptab1(ji,jj) * tmask_i(ji,jj) |
---|
191 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
192 | ztmp = ptab2(ji,jj) * tmask_i(ji,jj) |
---|
193 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
194 | END DO |
---|
195 | hsum(jj) = ctmp |
---|
196 | END DO |
---|
197 | glob_sum_2d_a = glob_sum_c1d(hsum, jpj) |
---|
198 | ! |
---|
199 | END FUNCTION glob_sum_2d_a |
---|
200 | |
---|
201 | |
---|
202 | FUNCTION glob_sum_3d_a( ptab1, ptab2 ) |
---|
203 | !!---------------------------------------------------------------------- |
---|
204 | !! *** FUNCTION glob_sum_3d_a *** |
---|
205 | !! |
---|
206 | !! ** Purpose : perform a sum on two 3D array in calling DDPDD routine |
---|
207 | !!---------------------------------------------------------------------- |
---|
208 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab1, ptab2 |
---|
209 | REAL(wp) :: glob_sum_3d_a ! global masked sum |
---|
210 | !! |
---|
211 | COMPLEX(wp):: ctmp |
---|
212 | REAL(wp) :: ztmp |
---|
213 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
214 | INTEGER :: ijpk ! local variables: size of ptab |
---|
215 | COMPLEX(KIND = wp), allocatable :: hsum(:) |
---|
216 | !!----------------------------------------------------------------------- |
---|
217 | ! |
---|
218 | ijpk = SIZE(ptab1,3) |
---|
219 | ALLOCATE(hsum(ijpk)) |
---|
220 | ! |
---|
221 | DO jk = 1, ijpk |
---|
222 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
223 | DO jj = 1, jpj |
---|
224 | DO ji = 1, jpi |
---|
225 | ztmp = ptab1(ji,jj,jk) * tmask_i(ji,jj) |
---|
226 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
227 | ztmp = ptab2(ji,jj,jk) * tmask_i(ji,jj) |
---|
228 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
229 | END DO |
---|
230 | END DO |
---|
231 | hsum(jk) = ctmp |
---|
232 | END DO |
---|
233 | glob_sum_3d_a = glob_sum_c1d(hsum, ijpk) |
---|
234 | DEALLOCATE(hsum) |
---|
235 | ! |
---|
236 | END FUNCTION glob_sum_3d_a |
---|
237 | |
---|
238 | FUNCTION glob_sum_full_2d( ptab ) |
---|
239 | !!---------------------------------------------------------------------- |
---|
240 | !! *** FUNCTION glob_sum_full_2d *** |
---|
241 | !! |
---|
242 | !! ** Purpose : perform a sum in calling DDPDD routine |
---|
243 | !!---------------------------------------------------------------------- |
---|
244 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab |
---|
245 | REAL(wp) :: glob_sum_full_2d ! global sum (nomask) |
---|
246 | !! |
---|
247 | COMPLEX(wp):: ctmp |
---|
248 | REAL(wp) :: ztmp |
---|
249 | INTEGER :: ji, jj ! dummy loop indices |
---|
250 | COMPLEX(KIND = wp) :: hsum(jpj) |
---|
251 | !!----------------------------------------------------------------------- |
---|
252 | ! |
---|
253 | DO jj = 1, jpj |
---|
254 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
255 | DO ji =1, jpi |
---|
256 | ztmp = ptab(ji,jj) * tmask_h(ji,jj) |
---|
257 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
258 | END DO |
---|
259 | hsum(jj) = ctmp |
---|
260 | END DO |
---|
261 | glob_sum_full_2d = glob_sum_c1d(hsum, jpj) |
---|
262 | ! |
---|
263 | END FUNCTION glob_sum_full_2d |
---|
264 | |
---|
265 | FUNCTION glob_sum_full_3d( ptab ) |
---|
266 | !!---------------------------------------------------------------------- |
---|
267 | !! *** FUNCTION glob_sum_full_3d *** |
---|
268 | !! |
---|
269 | !! ** Purpose : perform a sum on a 3D array in calling DDPDD routine |
---|
270 | !!---------------------------------------------------------------------- |
---|
271 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab |
---|
272 | REAL(wp) :: glob_sum_full_3d ! global sum (nomask) |
---|
273 | !! |
---|
274 | COMPLEX(wp):: ctmp |
---|
275 | REAL(wp) :: ztmp |
---|
276 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
277 | INTEGER :: ijpk ! local variables: size of ptab |
---|
278 | COMPLEX(KIND = wp), allocatable :: hsum(:) |
---|
279 | !!----------------------------------------------------------------------- |
---|
280 | ! |
---|
281 | ijpk = SIZE(ptab,3) |
---|
282 | ALLOCATE(hsum(ijpk)) |
---|
283 | ! |
---|
284 | DO jk = 1, ijpk |
---|
285 | ctmp = CMPLX( 0.e0, 0.e0, wp ) |
---|
286 | DO jj = 1, jpj |
---|
287 | DO ji =1, jpi |
---|
288 | ztmp = ptab(ji,jj,jk) * tmask_h(ji,jj) |
---|
289 | CALL DDPDD( CMPLX( ztmp, 0.e0, wp ), ctmp ) |
---|
290 | END DO |
---|
291 | END DO |
---|
292 | hsum(jk) = ctmp |
---|
293 | END DO |
---|
294 | glob_sum_full_3d = glob_sum_c1d(hsum, ijpk) |
---|
295 | DEALLOCATE(hsum) |
---|
296 | ! |
---|
297 | END FUNCTION glob_sum_full_3d |
---|
298 | |
---|
299 | ! --- MIN --- |
---|
300 | FUNCTION glob_min_2d( ptab ) |
---|
301 | !!----------------------------------------------------------------------- |
---|
302 | !! *** FUNCTION glob_min_2D *** |
---|
303 | !! |
---|
304 | !! ** Purpose : perform a masked min on the inner global domain of a 2D array |
---|
305 | !!----------------------------------------------------------------------- |
---|
306 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab ! input 2D array |
---|
307 | REAL(wp) :: glob_min_2d ! global masked min |
---|
308 | !!----------------------------------------------------------------------- |
---|
309 | ! |
---|
310 | glob_min_2d = MINVAL( ptab(:,:)*tmask_i(:,:) ) |
---|
311 | IF( lk_mpp ) CALL mpp_min( glob_min_2d ) |
---|
312 | ! |
---|
313 | END FUNCTION glob_min_2d |
---|
314 | |
---|
315 | FUNCTION glob_min_3d( ptab ) |
---|
316 | !!----------------------------------------------------------------------- |
---|
317 | !! *** FUNCTION glob_min_3D *** |
---|
318 | !! |
---|
319 | !! ** Purpose : perform a masked min on the inner global domain of a 3D array |
---|
320 | !!----------------------------------------------------------------------- |
---|
321 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab ! input 3D array |
---|
322 | REAL(wp) :: glob_min_3d ! global masked min |
---|
323 | !! |
---|
324 | INTEGER :: jk |
---|
325 | INTEGER :: ijpk ! local variable: size of the 3d dimension of ptab |
---|
326 | !!----------------------------------------------------------------------- |
---|
327 | ! |
---|
328 | ijpk = SIZE(ptab,3) |
---|
329 | ! |
---|
330 | glob_min_3d = MINVAL( ptab(:,:,1)*tmask_i(:,:) ) |
---|
331 | DO jk = 2, ijpk |
---|
332 | glob_min_3d = MIN( glob_min_3d, MINVAL( ptab(:,:,jk)*tmask_i(:,:) ) ) |
---|
333 | END DO |
---|
334 | IF( lk_mpp ) CALL mpp_min( glob_min_3d ) |
---|
335 | ! |
---|
336 | END FUNCTION glob_min_3d |
---|
337 | |
---|
338 | |
---|
339 | FUNCTION glob_min_2d_a( ptab1, ptab2 ) |
---|
340 | !!----------------------------------------------------------------------- |
---|
341 | !! *** FUNCTION glob_min_2D _a *** |
---|
342 | !! |
---|
343 | !! ** Purpose : perform a masked min on the inner global domain of two 2D array |
---|
344 | !!----------------------------------------------------------------------- |
---|
345 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab1, ptab2 ! input 2D array |
---|
346 | REAL(wp) , DIMENSION(2) :: glob_min_2d_a ! global masked min |
---|
347 | !!----------------------------------------------------------------------- |
---|
348 | ! |
---|
349 | glob_min_2d_a(1) = MINVAL( ptab1(:,:)*tmask_i(:,:) ) |
---|
350 | glob_min_2d_a(2) = MINVAL( ptab2(:,:)*tmask_i(:,:) ) |
---|
351 | IF( lk_mpp ) CALL mpp_min( glob_min_2d_a, 2 ) |
---|
352 | ! |
---|
353 | END FUNCTION glob_min_2d_a |
---|
354 | |
---|
355 | |
---|
356 | FUNCTION glob_min_3d_a( ptab1, ptab2 ) |
---|
357 | !!----------------------------------------------------------------------- |
---|
358 | !! *** FUNCTION glob_min_3D_a *** |
---|
359 | !! |
---|
360 | !! ** Purpose : perform a masked min on the inner global domain of two 3D array |
---|
361 | !!----------------------------------------------------------------------- |
---|
362 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab1, ptab2 ! input 3D array |
---|
363 | REAL(wp) , DIMENSION(2) :: glob_min_3d_a ! global masked min |
---|
364 | !! |
---|
365 | INTEGER :: jk |
---|
366 | INTEGER :: ijpk ! local variable: size of the 3d dimension of ptab |
---|
367 | !!----------------------------------------------------------------------- |
---|
368 | ! |
---|
369 | ijpk = SIZE(ptab1,3) |
---|
370 | ! |
---|
371 | glob_min_3d_a(1) = MINVAL( ptab1(:,:,1)*tmask_i(:,:) ) |
---|
372 | glob_min_3d_a(2) = MINVAL( ptab2(:,:,1)*tmask_i(:,:) ) |
---|
373 | DO jk = 2, ijpk |
---|
374 | glob_min_3d_a(1) = MIN( glob_min_3d_a(1), MINVAL( ptab1(:,:,jk)*tmask_i(:,:) ) ) |
---|
375 | glob_min_3d_a(2) = MIN( glob_min_3d_a(2), MINVAL( ptab2(:,:,jk)*tmask_i(:,:) ) ) |
---|
376 | END DO |
---|
377 | IF( lk_mpp ) CALL mpp_min( glob_min_3d_a, 2 ) |
---|
378 | ! |
---|
379 | END FUNCTION glob_min_3d_a |
---|
380 | |
---|
381 | ! --- MAX --- |
---|
382 | FUNCTION glob_max_2d( ptab ) |
---|
383 | !!----------------------------------------------------------------------- |
---|
384 | !! *** FUNCTION glob_max_2D *** |
---|
385 | !! |
---|
386 | !! ** Purpose : perform a masked max on the inner global domain of a 2D array |
---|
387 | !!----------------------------------------------------------------------- |
---|
388 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab ! input 2D array |
---|
389 | REAL(wp) :: glob_max_2d ! global masked max |
---|
390 | !!----------------------------------------------------------------------- |
---|
391 | ! |
---|
392 | glob_max_2d = MAXVAL( ptab(:,:)*tmask_i(:,:) ) |
---|
393 | IF( lk_mpp ) CALL mpp_max( glob_max_2d ) |
---|
394 | ! |
---|
395 | END FUNCTION glob_max_2d |
---|
396 | |
---|
397 | FUNCTION glob_max_3d( ptab ) |
---|
398 | !!----------------------------------------------------------------------- |
---|
399 | !! *** FUNCTION glob_max_3D *** |
---|
400 | !! |
---|
401 | !! ** Purpose : perform a masked max on the inner global domain of a 3D array |
---|
402 | !!----------------------------------------------------------------------- |
---|
403 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab ! input 3D array |
---|
404 | REAL(wp) :: glob_max_3d ! global masked max |
---|
405 | !! |
---|
406 | INTEGER :: jk |
---|
407 | INTEGER :: ijpk ! local variable: size of the 3d dimension of ptab |
---|
408 | !!----------------------------------------------------------------------- |
---|
409 | ! |
---|
410 | ijpk = SIZE(ptab,3) |
---|
411 | ! |
---|
412 | glob_max_3d = MAXVAL( ptab(:,:,1)*tmask_i(:,:) ) |
---|
413 | DO jk = 2, ijpk |
---|
414 | glob_max_3d = MAX( glob_max_3d, MAXVAL( ptab(:,:,jk)*tmask_i(:,:) ) ) |
---|
415 | END DO |
---|
416 | IF( lk_mpp ) CALL mpp_max( glob_max_3d ) |
---|
417 | ! |
---|
418 | END FUNCTION glob_max_3d |
---|
419 | |
---|
420 | |
---|
421 | FUNCTION glob_max_2d_a( ptab1, ptab2 ) |
---|
422 | !!----------------------------------------------------------------------- |
---|
423 | !! *** FUNCTION glob_max_2D _a *** |
---|
424 | !! |
---|
425 | !! ** Purpose : perform a masked max on the inner global domain of two 2D array |
---|
426 | !!----------------------------------------------------------------------- |
---|
427 | REAL(wp), INTENT(in), DIMENSION(:,:) :: ptab1, ptab2 ! input 2D array |
---|
428 | REAL(wp) , DIMENSION(2) :: glob_max_2d_a ! global masked max |
---|
429 | !!----------------------------------------------------------------------- |
---|
430 | ! |
---|
431 | glob_max_2d_a(1) = MAXVAL( ptab1(:,:)*tmask_i(:,:) ) |
---|
432 | glob_max_2d_a(2) = MAXVAL( ptab2(:,:)*tmask_i(:,:) ) |
---|
433 | IF( lk_mpp ) CALL mpp_max( glob_max_2d_a, 2 ) |
---|
434 | ! |
---|
435 | END FUNCTION glob_max_2d_a |
---|
436 | |
---|
437 | |
---|
438 | FUNCTION glob_max_3d_a( ptab1, ptab2 ) |
---|
439 | !!----------------------------------------------------------------------- |
---|
440 | !! *** FUNCTION glob_max_3D_a *** |
---|
441 | !! |
---|
442 | !! ** Purpose : perform a masked max on the inner global domain of two 3D array |
---|
443 | !!----------------------------------------------------------------------- |
---|
444 | REAL(wp), INTENT(in), DIMENSION(:,:,:) :: ptab1, ptab2 ! input 3D array |
---|
445 | REAL(wp) , DIMENSION(2) :: glob_max_3d_a ! global masked max |
---|
446 | !! |
---|
447 | INTEGER :: jk |
---|
448 | INTEGER :: ijpk ! local variable: size of the 3d dimension of ptab |
---|
449 | !!----------------------------------------------------------------------- |
---|
450 | ! |
---|
451 | ijpk = SIZE(ptab1,3) |
---|
452 | ! |
---|
453 | glob_max_3d_a(1) = MAXVAL( ptab1(:,:,1)*tmask_i(:,:) ) |
---|
454 | glob_max_3d_a(2) = MAXVAL( ptab2(:,:,1)*tmask_i(:,:) ) |
---|
455 | DO jk = 2, ijpk |
---|
456 | glob_max_3d_a(1) = MAX( glob_max_3d_a(1), MAXVAL( ptab1(:,:,jk)*tmask_i(:,:) ) ) |
---|
457 | glob_max_3d_a(2) = MAX( glob_max_3d_a(2), MAXVAL( ptab2(:,:,jk)*tmask_i(:,:) ) ) |
---|
458 | END DO |
---|
459 | IF( lk_mpp ) CALL mpp_max( glob_max_3d_a, 2 ) |
---|
460 | ! |
---|
461 | END FUNCTION glob_max_3d_a |
---|
462 | |
---|
463 | |
---|
464 | SUBROUTINE DDPDD( ydda, yddb ) |
---|
465 | !!---------------------------------------------------------------------- |
---|
466 | !! *** ROUTINE DDPDD *** |
---|
467 | !! |
---|
468 | !! ** Purpose : Add a scalar element to a sum |
---|
469 | !! |
---|
470 | !! |
---|
471 | !! ** Method : The code uses the compensated summation with doublet |
---|
472 | !! (sum,error) emulated useing complex numbers. ydda is the |
---|
473 | !! scalar to add to the summ yddb |
---|
474 | !! |
---|
475 | !! ** Action : This does only work for MPI. |
---|
476 | !! |
---|
477 | !! References : Using Acurate Arithmetics to Improve Numerical |
---|
478 | !! Reproducibility and Sability in Parallel Applications |
---|
479 | !! Yun HE and Chris H. Q. DING, Journal of Supercomputing 18, 259-277, 2001 |
---|
480 | !!---------------------------------------------------------------------- |
---|
481 | COMPLEX(wp), INTENT(in ) :: ydda |
---|
482 | COMPLEX(wp), INTENT(inout) :: yddb |
---|
483 | ! |
---|
484 | REAL(wp) :: zerr, zt1, zt2 ! local work variables |
---|
485 | !!----------------------------------------------------------------------- |
---|
486 | ! |
---|
487 | ! Compute ydda + yddb using Knuth's trick. |
---|
488 | zt1 = REAL(ydda) + REAL(yddb) |
---|
489 | zerr = zt1 - REAL(ydda) |
---|
490 | zt2 = ( (REAL(yddb) - zerr) + (REAL(ydda) - (zt1 - zerr)) ) & |
---|
491 | & + AIMAG(ydda) + AIMAG(yddb) |
---|
492 | ! |
---|
493 | ! The result is t1 + t2, after normalization. |
---|
494 | yddb = CMPLX( zt1 + zt2, zt2 - ((zt1 + zt2) - zt1), wp ) |
---|
495 | ! |
---|
496 | END SUBROUTINE DDPDD |
---|
497 | |
---|
498 | #if defined key_nosignedzero |
---|
499 | !!---------------------------------------------------------------------- |
---|
500 | !! 'key_nosignedzero' F90 SIGN |
---|
501 | !!---------------------------------------------------------------------- |
---|
502 | |
---|
503 | FUNCTION SIGN_SCALAR( pa, pb ) |
---|
504 | !!----------------------------------------------------------------------- |
---|
505 | !! *** FUNCTION SIGN_SCALAR *** |
---|
506 | !! |
---|
507 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
508 | !!----------------------------------------------------------------------- |
---|
509 | REAL(wp) :: pa,pb ! input |
---|
510 | REAL(wp) :: SIGN_SCALAR ! result |
---|
511 | !!----------------------------------------------------------------------- |
---|
512 | IF ( pb >= 0.e0) THEN ; SIGN_SCALAR = ABS(pa) |
---|
513 | ELSE ; SIGN_SCALAR =-ABS(pa) |
---|
514 | ENDIF |
---|
515 | END FUNCTION SIGN_SCALAR |
---|
516 | |
---|
517 | |
---|
518 | FUNCTION SIGN_ARRAY_1D( pa, pb ) |
---|
519 | !!----------------------------------------------------------------------- |
---|
520 | !! *** FUNCTION SIGN_ARRAY_1D *** |
---|
521 | !! |
---|
522 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
523 | !!----------------------------------------------------------------------- |
---|
524 | REAL(wp) :: pa,pb(:) ! input |
---|
525 | REAL(wp) :: SIGN_ARRAY_1D(SIZE(pb,1)) ! result |
---|
526 | !!----------------------------------------------------------------------- |
---|
527 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_1D = ABS(pa) |
---|
528 | ELSEWHERE ; SIGN_ARRAY_1D =-ABS(pa) |
---|
529 | END WHERE |
---|
530 | END FUNCTION SIGN_ARRAY_1D |
---|
531 | |
---|
532 | |
---|
533 | FUNCTION SIGN_ARRAY_2D(pa,pb) |
---|
534 | !!----------------------------------------------------------------------- |
---|
535 | !! *** FUNCTION SIGN_ARRAY_2D *** |
---|
536 | !! |
---|
537 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
538 | !!----------------------------------------------------------------------- |
---|
539 | REAL(wp) :: pa,pb(:,:) ! input |
---|
540 | REAL(wp) :: SIGN_ARRAY_2D(SIZE(pb,1),SIZE(pb,2)) ! result |
---|
541 | !!----------------------------------------------------------------------- |
---|
542 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_2D = ABS(pa) |
---|
543 | ELSEWHERE ; SIGN_ARRAY_2D =-ABS(pa) |
---|
544 | END WHERE |
---|
545 | END FUNCTION SIGN_ARRAY_2D |
---|
546 | |
---|
547 | FUNCTION SIGN_ARRAY_3D(pa,pb) |
---|
548 | !!----------------------------------------------------------------------- |
---|
549 | !! *** FUNCTION SIGN_ARRAY_3D *** |
---|
550 | !! |
---|
551 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
552 | !!----------------------------------------------------------------------- |
---|
553 | REAL(wp) :: pa,pb(:,:,:) ! input |
---|
554 | REAL(wp) :: SIGN_ARRAY_3D(SIZE(pb,1),SIZE(pb,2),SIZE(pb,3)) ! result |
---|
555 | !!----------------------------------------------------------------------- |
---|
556 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_3D = ABS(pa) |
---|
557 | ELSEWHERE ; SIGN_ARRAY_3D =-ABS(pa) |
---|
558 | END WHERE |
---|
559 | END FUNCTION SIGN_ARRAY_3D |
---|
560 | |
---|
561 | |
---|
562 | FUNCTION SIGN_ARRAY_1D_A(pa,pb) |
---|
563 | !!----------------------------------------------------------------------- |
---|
564 | !! *** FUNCTION SIGN_ARRAY_1D_A *** |
---|
565 | !! |
---|
566 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
567 | !!----------------------------------------------------------------------- |
---|
568 | REAL(wp) :: pa(:),pb(:) ! input |
---|
569 | REAL(wp) :: SIGN_ARRAY_1D_A(SIZE(pb,1)) ! result |
---|
570 | !!----------------------------------------------------------------------- |
---|
571 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_1D_A = ABS(pa) |
---|
572 | ELSEWHERE ; SIGN_ARRAY_1D_A =-ABS(pa) |
---|
573 | END WHERE |
---|
574 | END FUNCTION SIGN_ARRAY_1D_A |
---|
575 | |
---|
576 | |
---|
577 | FUNCTION SIGN_ARRAY_2D_A(pa,pb) |
---|
578 | !!----------------------------------------------------------------------- |
---|
579 | !! *** FUNCTION SIGN_ARRAY_2D_A *** |
---|
580 | !! |
---|
581 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
582 | !!----------------------------------------------------------------------- |
---|
583 | REAL(wp) :: pa(:,:),pb(:,:) ! input |
---|
584 | REAL(wp) :: SIGN_ARRAY_2D_A(SIZE(pb,1),SIZE(pb,2)) ! result |
---|
585 | !!----------------------------------------------------------------------- |
---|
586 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_2D_A = ABS(pa) |
---|
587 | ELSEWHERE ; SIGN_ARRAY_2D_A =-ABS(pa) |
---|
588 | END WHERE |
---|
589 | END FUNCTION SIGN_ARRAY_2D_A |
---|
590 | |
---|
591 | |
---|
592 | FUNCTION SIGN_ARRAY_3D_A(pa,pb) |
---|
593 | !!----------------------------------------------------------------------- |
---|
594 | !! *** FUNCTION SIGN_ARRAY_3D_A *** |
---|
595 | !! |
---|
596 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
597 | !!----------------------------------------------------------------------- |
---|
598 | REAL(wp) :: pa(:,:,:),pb(:,:,:) ! input |
---|
599 | REAL(wp) :: SIGN_ARRAY_3D_A(SIZE(pb,1),SIZE(pb,2),SIZE(pb,3)) ! result |
---|
600 | !!----------------------------------------------------------------------- |
---|
601 | WHERE ( pb >= 0.e0 ) ; SIGN_ARRAY_3D_A = ABS(pa) |
---|
602 | ELSEWHERE ; SIGN_ARRAY_3D_A =-ABS(pa) |
---|
603 | END WHERE |
---|
604 | END FUNCTION SIGN_ARRAY_3D_A |
---|
605 | |
---|
606 | |
---|
607 | FUNCTION SIGN_ARRAY_1D_B(pa,pb) |
---|
608 | !!----------------------------------------------------------------------- |
---|
609 | !! *** FUNCTION SIGN_ARRAY_1D_B *** |
---|
610 | !! |
---|
611 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
612 | !!----------------------------------------------------------------------- |
---|
613 | REAL(wp) :: pa(:),pb ! input |
---|
614 | REAL(wp) :: SIGN_ARRAY_1D_B(SIZE(pa,1)) ! result |
---|
615 | !!----------------------------------------------------------------------- |
---|
616 | IF( pb >= 0.e0 ) THEN ; SIGN_ARRAY_1D_B = ABS(pa) |
---|
617 | ELSE ; SIGN_ARRAY_1D_B =-ABS(pa) |
---|
618 | ENDIF |
---|
619 | END FUNCTION SIGN_ARRAY_1D_B |
---|
620 | |
---|
621 | |
---|
622 | FUNCTION SIGN_ARRAY_2D_B(pa,pb) |
---|
623 | !!----------------------------------------------------------------------- |
---|
624 | !! *** FUNCTION SIGN_ARRAY_2D_B *** |
---|
625 | !! |
---|
626 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
627 | !!----------------------------------------------------------------------- |
---|
628 | REAL(wp) :: pa(:,:),pb ! input |
---|
629 | REAL(wp) :: SIGN_ARRAY_2D_B(SIZE(pa,1),SIZE(pa,2)) ! result |
---|
630 | !!----------------------------------------------------------------------- |
---|
631 | IF( pb >= 0.e0 ) THEN ; SIGN_ARRAY_2D_B = ABS(pa) |
---|
632 | ELSE ; SIGN_ARRAY_2D_B =-ABS(pa) |
---|
633 | ENDIF |
---|
634 | END FUNCTION SIGN_ARRAY_2D_B |
---|
635 | |
---|
636 | |
---|
637 | FUNCTION SIGN_ARRAY_3D_B(pa,pb) |
---|
638 | !!----------------------------------------------------------------------- |
---|
639 | !! *** FUNCTION SIGN_ARRAY_3D_B *** |
---|
640 | !! |
---|
641 | !! ** Purpose : overwrite f95 behaviour of intrinsinc sign function |
---|
642 | !!----------------------------------------------------------------------- |
---|
643 | REAL(wp) :: pa(:,:,:),pb ! input |
---|
644 | REAL(wp) :: SIGN_ARRAY_3D_B(SIZE(pa,1),SIZE(pa,2),SIZE(pa,3)) ! result |
---|
645 | !!----------------------------------------------------------------------- |
---|
646 | IF( pb >= 0.e0 ) THEN ; SIGN_ARRAY_3D_B = ABS(pa) |
---|
647 | ELSE ; SIGN_ARRAY_3D_B =-ABS(pa) |
---|
648 | ENDIF |
---|
649 | END FUNCTION SIGN_ARRAY_3D_B |
---|
650 | #endif |
---|
651 | |
---|
652 | !!====================================================================== |
---|
653 | END MODULE lib_fortran |
---|