1 | |
---|
2 | MODULE wadlmt |
---|
3 | !!============================================================================== |
---|
4 | !! *** MODULE wadlmt *** |
---|
5 | !! compute and apply flux limiters and preserve water depth positivity |
---|
6 | !! only effects if wetting/drying is on (ln_wd == .true. |
---|
7 | !!============================================================================== |
---|
8 | !! History : |
---|
9 | !! NEMO 3.6 ! 2014-09 ((H.Liu) Original code |
---|
10 | !! ! will add the runoff and periodic BC case later |
---|
11 | !!---------------------------------------------------------------------- |
---|
12 | |
---|
13 | !!---------------------------------------------------------------------- |
---|
14 | !! wad_lmt : Compute the horizontal flux limiter and the limited velocity |
---|
15 | !! when wetting and drying happens |
---|
16 | !!---------------------------------------------------------------------- |
---|
17 | USE oce ! ocean dynamics and tracers |
---|
18 | USE dom_oce ! ocean space and time domain |
---|
19 | USE sbc_oce, ONLY : ln_rnf ! surface boundary condition: ocean |
---|
20 | USE sbcrnf ! river runoff |
---|
21 | USE cla ! cross land advection (cla_div routine) |
---|
22 | USE in_out_manager ! I/O manager |
---|
23 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
24 | USE lib_mpp ! MPP library |
---|
25 | USE wrk_nemo ! Memory Allocation |
---|
26 | USE timing ! Timing |
---|
27 | |
---|
28 | IMPLICIT NONE |
---|
29 | PRIVATE |
---|
30 | |
---|
31 | |
---|
32 | PUBLIC wad_lmt, wad_lmt_bt ! routine called by step.F90 |
---|
33 | |
---|
34 | !! * Substitutions |
---|
35 | # include "domzgr_substitute.h90" |
---|
36 | # include "vectopt_loop_substitute.h90" |
---|
37 | CONTAINS |
---|
38 | |
---|
39 | SUBROUTINE wad_lmt( sshb1, sshemp, z2dt ) |
---|
40 | !!---------------------------------------------------------------------- |
---|
41 | !! *** ROUTINE wad_lmt *** |
---|
42 | !! |
---|
43 | !! ** Purpose : generate flux limiters for wetting/drying |
---|
44 | !! |
---|
45 | !! ** Method : - Prevent negative depth occurring (Not ready for Agrif) |
---|
46 | !! |
---|
47 | !! ** Action : - calculate flux limiter and W/D flag |
---|
48 | !!---------------------------------------------------------------------- |
---|
49 | REAL(wp), DIMENSION(:,:), INTENT(inout) :: sshb1 |
---|
50 | REAL(wp), DIMENSION(:,:), INTENT(in) :: sshemp |
---|
51 | REAL(wp), INTENT(in) :: z2dt |
---|
52 | ! |
---|
53 | INTEGER :: ji, jj, jk, jk1 ! dummy loop indices |
---|
54 | INTEGER :: zflag ! local scalar |
---|
55 | REAL(wp) :: zcoef, zdep1, zdep2 ! local scalars |
---|
56 | REAL(wp) :: zzflxp, zzflxn ! local scalars |
---|
57 | REAL(wp) :: zdepwd ! local scalar, always wet cell depth |
---|
58 | REAL(wp) :: ztmp ! local scalars |
---|
59 | REAL(wp), POINTER, DIMENSION(:,:) :: zwdlmtu, zwdlmtv !: W/D flux limiters |
---|
60 | REAL(wp), POINTER, DIMENSION(:,:) :: zflxp, zflxn ! local 2D workspace |
---|
61 | REAL(wp), POINTER, DIMENSION(:,:) :: zflxu, zflxv ! local 2D workspace |
---|
62 | REAL(wp), POINTER, DIMENSION(:,:) :: zflxu1, zflxv1 ! local 2D workspace |
---|
63 | |
---|
64 | !!---------------------------------------------------------------------- |
---|
65 | ! |
---|
66 | |
---|
67 | IF( nn_timing == 1 ) CALL timing_start('wad_lmt') |
---|
68 | |
---|
69 | IF(ln_wd) THEN |
---|
70 | |
---|
71 | CALL wrk_alloc( jpi, jpj, zflxp, zflxn, zflxu, zflxv, zflxu1, zflxv1 ) |
---|
72 | CALL wrk_alloc( jpi, jpj, zwdlmtu, zwdlmtv) |
---|
73 | ! |
---|
74 | |
---|
75 | IF(lwp) WRITE(numout,*) |
---|
76 | IF(lwp) WRITE(numout,*) 'wad_lmt : wetting/drying limiters and velocity limiting' |
---|
77 | |
---|
78 | zflag = 0 |
---|
79 | zdepwd = 50._wp !maximum depth that ocean cells can have W/D processes |
---|
80 | |
---|
81 | |
---|
82 | zflxp(:,:) = 0._wp |
---|
83 | zflxn(:,:) = 0._wp |
---|
84 | zflxu(:,:) = 0._wp |
---|
85 | zflxv(:,:) = 0._wp |
---|
86 | |
---|
87 | zwdlmtu(:,:) = 1._wp |
---|
88 | zwdlmtv(:,:) = 1._wp |
---|
89 | |
---|
90 | ! Horizontal Flux in u and v direction |
---|
91 | DO jk = 1, jpkm1 |
---|
92 | DO jj = 1, jpjm1 |
---|
93 | DO ji = 1, jpim1 |
---|
94 | zflxu(ji,jj) = zflxu(ji,jj) + fse3u(ji,jj,jk) * un(ji,jj,jk) * umask(ji,jj,jk) |
---|
95 | zflxv(ji,jj) = zflxv(ji,jj) + fse3v(ji,jj,jk) * vn(ji,jj,jk) * vmask(ji,jj,jk) |
---|
96 | END DO |
---|
97 | END DO |
---|
98 | END DO |
---|
99 | |
---|
100 | zflxu(:,:) = zflxu(:,:) * e2u(:,:) |
---|
101 | zflxv(:,:) = zflxv(:,:) * e1v(:,:) |
---|
102 | |
---|
103 | DO jj = 2, jpjm1 |
---|
104 | DO ji = 2, jpim1 |
---|
105 | |
---|
106 | IF(tmask(ji, jj, 1) < 0.5_wp) CYCLE ! we don't care about land cells |
---|
107 | IF(bathy(ji,jj) > zdepwd) CYCLE ! and cells which will unlikely go dried out |
---|
108 | |
---|
109 | zflxp(ji,jj) = max(zflxu(ji,jj), 0._wp) - min(zflxu(ji-1,jj), 0._wp) + & |
---|
110 | & max(zflxv(ji,jj), 0._wp) - min(zflxv(ji, jj-1), 0._wp) |
---|
111 | zflxn(ji,jj) = min(zflxu(ji,jj), 0._wp) - max(zflxu(ji-1,jj), 0._wp) + & |
---|
112 | & min(zflxv(ji,jj), 0._wp) - max(zflxv(ji, jj-1), 0._wp) |
---|
113 | |
---|
114 | zdep2 = bathy(ji,jj) + sshb1(ji,jj) - rn_wdmin1 |
---|
115 | IF(zdep2 < 0._wp) THEN !add more safty, but not necessary |
---|
116 | !zdep2 = 0._wp |
---|
117 | sshb1(ji,jj) = rn_wdmin1 - bathy(ji,jj) |
---|
118 | END IF |
---|
119 | ENDDO |
---|
120 | END DO |
---|
121 | |
---|
122 | |
---|
123 | !! start limiter iterations |
---|
124 | DO jk1 = 1, nn_wdit + 1 |
---|
125 | |
---|
126 | |
---|
127 | zflxu1(:,:) = zflxu(:,:) * zwdlmtu(:,:) |
---|
128 | zflxv1(:,:) = zflxv(:,:) * zwdlmtv(:,:) |
---|
129 | |
---|
130 | DO jj = 2, jpjm1 |
---|
131 | DO ji = 2, jpim1 |
---|
132 | |
---|
133 | ! wdmask(ji,jj) = 0 |
---|
134 | IF(tmask(ji, jj, 1) < 0.5_wp) CYCLE |
---|
135 | IF(bathy(ji,jj) > zdepwd) CYCLE |
---|
136 | |
---|
137 | !ztmp = e1t(ji,jj) * e2t(ji,jj) !there must be an array ready for this |
---|
138 | ztmp = e12t(ji,jj) |
---|
139 | |
---|
140 | zzflxp = max(zflxu1(ji,jj), 0._wp) - min(zflxu1(ji-1,jj), 0._wp) + & |
---|
141 | & max(zflxv1(ji,jj), 0._wp) - min(zflxv1(ji, jj-1), 0._wp) |
---|
142 | zzflxn = min(zflxu1(ji,jj), 0._wp) - max(zflxu1(ji-1,jj), 0._wp) + & |
---|
143 | & min(zflxv1(ji,jj), 0._wp) - max(zflxv1(ji, jj-1), 0._wp) |
---|
144 | |
---|
145 | zdep1 = (zzflxp + zzflxn) * z2dt / ztmp |
---|
146 | zdep2 = bathy(ji,jj) + sshb1(ji,jj) - rn_wdmin1 - z2dt * sshemp(ji,jj) ! this one can be moved out of the loop |
---|
147 | |
---|
148 | IF(zdep1 > zdep2) THEN |
---|
149 | zflag = 1 |
---|
150 | ! wdmask(ji, jj) = 1 |
---|
151 | zcoef = ( ( zdep2 - rn_wdmin2 ) * ztmp - zzflxn * z2dt ) / ( zflxp(ji,jj) * z2dt ) |
---|
152 | zcoef = max(zcoef, 0._wp) |
---|
153 | IF(jk1 > nn_wdit) zcoef = 0._wp |
---|
154 | IF(zflxu1(ji, jj) > 0._wp) zwdlmtu(ji ,jj) = zcoef |
---|
155 | IF(zflxu1(ji-1,jj) < 0._wp) zwdlmtu(ji-1,jj) = zcoef |
---|
156 | IF(zflxv1(ji, jj) > 0._wp) zwdlmtv(ji ,jj) = zcoef |
---|
157 | IF(zflxv1(ji,jj-1) < 0._wp) zwdlmtv(ji-1,jj) = zcoef |
---|
158 | END IF |
---|
159 | END DO ! ji loop |
---|
160 | END DO ! jj loop |
---|
161 | |
---|
162 | CALL lbc_lnk( zwdlmtu, 'U', 1. ) |
---|
163 | CALL lbc_lnk( zwdlmtv, 'V', 1. ) |
---|
164 | |
---|
165 | IF(lk_mpp) CALL mpp_max(zflag) !max over the global domain |
---|
166 | |
---|
167 | IF(zflag == 0) EXIT |
---|
168 | |
---|
169 | zflag = 0 ! flag indicating if any further iteration is needed? |
---|
170 | END DO ! jk1 loop |
---|
171 | |
---|
172 | DO jk = 1, jpkm1 |
---|
173 | un(:,:,jk) = un(:,:,jk) * zwdlmtu(:, :) |
---|
174 | vn(:,:,jk) = vn(:,:,jk) * zwdlmtv(:, :) |
---|
175 | END DO |
---|
176 | |
---|
177 | CALL lbc_lnk( un, 'U', -1. ) |
---|
178 | CALL lbc_lnk( vn, 'V', -1. ) |
---|
179 | |
---|
180 | IF(zflag == 1 .AND. lwp) WRITE(numout,*) 'Need more iterations in wad_lmt!!!' |
---|
181 | |
---|
182 | !IF( ln_rnf ) CALL sbc_rnf_div( hdivn ) ! runoffs (update hdivn field) |
---|
183 | !IF( nn_cla == 1 ) CALL cla_div ( kt ) ! Cross Land Advection (update hdivn field) |
---|
184 | ! |
---|
185 | ! |
---|
186 | CALL wrk_dealloc( jpi, jpj, zflxp, zflxn, zflxu, zflxv, zflxu1, zflxv1 ) |
---|
187 | CALL wrk_dealloc( jpi, jpj, zwdlmtu, zwdlmtv) |
---|
188 | ! |
---|
189 | END IF |
---|
190 | |
---|
191 | IF( nn_timing == 1 ) CALL timing_stop('wad_lmt') |
---|
192 | END SUBROUTINE wad_lmt |
---|
193 | |
---|
194 | SUBROUTINE wad_lmt_bt( zflxu, zflxv, sshn_e, zssh_frc, rdtbt ) |
---|
195 | !!---------------------------------------------------------------------- |
---|
196 | !! *** ROUTINE wad_lmt *** |
---|
197 | !! |
---|
198 | !! ** Purpose : limiting flux in the barotropic stepping (dynspg_ts) |
---|
199 | !! |
---|
200 | !! ** Method : - Prevent negative depth occurring (Not ready for Agrif) |
---|
201 | !! |
---|
202 | !! ** Action : - calculate flux limiter and W/D flag |
---|
203 | !!---------------------------------------------------------------------- |
---|
204 | REAL(wp), INTENT(in) :: rdtbt ! ocean time-step index |
---|
205 | REAL(wp), DIMENSION(:,:), INTENT(inout) :: zflxu, zflxv, sshn_e, zssh_frc |
---|
206 | ! |
---|
207 | INTEGER :: ji, jj, jk, jk1 ! dummy loop indices |
---|
208 | INTEGER :: zflag ! local scalar |
---|
209 | REAL(wp) :: z2dt |
---|
210 | REAL(wp) :: zcoef, zdep1, zdep2 ! local scalars |
---|
211 | REAL(wp) :: zzflxp, zzflxn ! local scalars |
---|
212 | REAL(wp) :: zdepwd ! local scalar, always wet cell depth |
---|
213 | REAL(wp) :: ztmp ! local scalars |
---|
214 | REAL(wp), POINTER, DIMENSION(:,:) :: zwdlmtu, zwdlmtv !: W/D flux limiters |
---|
215 | REAL(wp), POINTER, DIMENSION(:,:) :: zflxp, zflxn ! local 2D workspace |
---|
216 | REAL(wp), POINTER, DIMENSION(:,:) :: zflxu1, zflxv1 ! local 2D workspace |
---|
217 | REAL(wp), POINTER, DIMENSION(:,:) :: sum_e3u, sum_e3v ! local 2D workspace |
---|
218 | |
---|
219 | !!---------------------------------------------------------------------- |
---|
220 | ! |
---|
221 | |
---|
222 | IF( nn_timing == 1 ) CALL timing_start('wad_lmt_bt') |
---|
223 | |
---|
224 | IF(ln_wd) THEN |
---|
225 | |
---|
226 | CALL wrk_alloc( jpi, jpj, zflxp, zflxn, zflxu1, zflxv1 ) |
---|
227 | CALL wrk_alloc( jpi, jpj, zwdlmtu, zwdlmtv) |
---|
228 | CALL wrk_alloc( jpi, jpj, sum_e3u, sum_e3v) |
---|
229 | ! |
---|
230 | |
---|
231 | IF(lwp) WRITE(numout,*) |
---|
232 | IF(lwp) WRITE(numout,*) 'wad_lmt_bt : wetting/drying limiters and velocity limiting' |
---|
233 | |
---|
234 | zflag = 0 |
---|
235 | zdepwd = 50._wp !maximum depth that ocean cells can have W/D processes |
---|
236 | |
---|
237 | z2dt = rdtbt |
---|
238 | |
---|
239 | zflxp(:,:) = 0._wp |
---|
240 | zflxn(:,:) = 0._wp |
---|
241 | !RF bug fix! zflxu(:,:) = 0._wp |
---|
242 | !RF bug fix! zflxv(:,:) = 0._wp |
---|
243 | |
---|
244 | zwdlmtu(:,:) = 1._wp |
---|
245 | zwdlmtv(:,:) = 1._wp |
---|
246 | |
---|
247 | ! Horizontal Flux in u and v direction |
---|
248 | |
---|
249 | !RF bug fix zflxu(:,:) = zflxu(:,:) * e2u(:,:) |
---|
250 | !RF bug fix zflxv(:,:) = zflxv(:,:) * e1v(:,:) |
---|
251 | |
---|
252 | DO jj = 2, jpjm1 |
---|
253 | DO ji = 2, jpim1 |
---|
254 | |
---|
255 | IF(tmask(ji, jj, 1) < 0.5_wp) CYCLE ! we don't care about land cells |
---|
256 | IF(bathy(ji,jj) > zdepwd) CYCLE ! and cells which will unlikely go dried out |
---|
257 | |
---|
258 | zflxp(ji,jj) = max(zflxu(ji,jj), 0._wp) - min(zflxu(ji-1,jj), 0._wp) + & |
---|
259 | & max(zflxv(ji,jj), 0._wp) - min(zflxv(ji, jj-1), 0._wp) |
---|
260 | zflxn(ji,jj) = min(zflxu(ji,jj), 0._wp) - max(zflxu(ji-1,jj), 0._wp) + & |
---|
261 | & min(zflxv(ji,jj), 0._wp) - max(zflxv(ji, jj-1), 0._wp) |
---|
262 | |
---|
263 | zdep2 = bathy(ji,jj) + sshn_e(ji,jj) - rn_wdmin1 |
---|
264 | IF(zdep2 < 0._wp) THEN !add more safty, but not necessary |
---|
265 | !zdep2 = 0._wp |
---|
266 | sshn_e(ji,jj) = rn_wdmin1 - bathy(ji,jj) |
---|
267 | END IF |
---|
268 | ENDDO |
---|
269 | END DO |
---|
270 | |
---|
271 | |
---|
272 | !! start limiter iterations |
---|
273 | DO jk1 = 1, nn_wdit + 1 |
---|
274 | |
---|
275 | |
---|
276 | zflxu1(:,:) = zflxu(:,:) * zwdlmtu(:,:) |
---|
277 | zflxv1(:,:) = zflxv(:,:) * zwdlmtv(:,:) |
---|
278 | |
---|
279 | DO jj = 2, jpjm1 |
---|
280 | DO ji = 2, jpim1 |
---|
281 | |
---|
282 | ! wdmask(ji,jj) = 0 |
---|
283 | IF(tmask(ji, jj, 1) < 0.5_wp) CYCLE ! we don't care about land cells |
---|
284 | IF(bathy(ji,jj) > zdepwd) CYCLE ! and cells which will unlikely go dried out |
---|
285 | |
---|
286 | ztmp = e12t(ji,jj) |
---|
287 | |
---|
288 | zzflxp = max(zflxu1(ji,jj), 0._wp) - min(zflxu1(ji-1,jj), 0._wp) + & |
---|
289 | & max(zflxv1(ji,jj), 0._wp) - min(zflxv1(ji, jj-1), 0._wp) |
---|
290 | zzflxn = min(zflxu1(ji,jj), 0._wp) - max(zflxu1(ji-1,jj), 0._wp) + & |
---|
291 | & min(zflxv1(ji,jj), 0._wp) - max(zflxv1(ji, jj-1), 0._wp) |
---|
292 | |
---|
293 | zdep1 = (zzflxp + zzflxn) * z2dt / ztmp |
---|
294 | zdep2 = bathy(ji,jj) + sshn_e(ji,jj) - rn_wdmin1 ! this one can be moved out of the loop |
---|
295 | zdep2 = zdep2 - z2dt * zssh_frc(ji,jj) |
---|
296 | |
---|
297 | IF(zdep1 > zdep2) THEN |
---|
298 | zflag = 1 |
---|
299 | !wdmask(ji, jj) = 1 |
---|
300 | zcoef = ( ( zdep2 - rn_wdmin2 ) * ztmp - zzflxn * z2dt ) / ( zflxp(ji,jj) * z2dt ) |
---|
301 | zcoef = max(zcoef, 0._wp) |
---|
302 | IF(jk1 > nn_wdit) zcoef = 0._wp |
---|
303 | IF(zflxu1(ji, jj) > 0._wp) zwdlmtu(ji ,jj) = zcoef |
---|
304 | IF(zflxu1(ji-1,jj) < 0._wp) zwdlmtu(ji-1,jj) = zcoef |
---|
305 | IF(zflxv1(ji, jj) > 0._wp) zwdlmtv(ji ,jj) = zcoef |
---|
306 | IF(zflxv1(ji,jj-1) < 0._wp) zwdlmtv(ji-1,jj) = zcoef |
---|
307 | END IF |
---|
308 | END DO ! ji loop |
---|
309 | END DO ! jj loop |
---|
310 | |
---|
311 | CALL lbc_lnk( zwdlmtu, 'U', 1. ) |
---|
312 | CALL lbc_lnk( zwdlmtv, 'V', 1. ) |
---|
313 | |
---|
314 | IF(lk_mpp) CALL mpp_max(zflag) !max over the global domain |
---|
315 | |
---|
316 | IF(zflag == 0) EXIT |
---|
317 | |
---|
318 | zflag = 0 ! flag indicating if any further iteration is needed? |
---|
319 | END DO ! jk1 loop |
---|
320 | |
---|
321 | zflxu(:,:) = zflxu(:,:) * zwdlmtu(:, :) |
---|
322 | zflxv(:,:) = zflxv(:,:) * zwdlmtv(:, :) |
---|
323 | |
---|
324 | CALL lbc_lnk( zflxu, 'U', -1. ) |
---|
325 | CALL lbc_lnk( zflxv, 'V', -1. ) |
---|
326 | |
---|
327 | IF(zflag == 1 .AND. lwp) WRITE(numout,*) 'Need more iterations in wad_lmt_bt!!!' |
---|
328 | |
---|
329 | !IF( ln_rnf ) CALL sbc_rnf_div( hdivn ) ! runoffs (update hdivn field) |
---|
330 | !IF( nn_cla == 1 ) CALL cla_div ( kt ) ! Cross Land Advection (update hdivn field) |
---|
331 | ! |
---|
332 | ! |
---|
333 | CALL wrk_dealloc( jpi, jpj, zflxp, zflxn, zflxu1, zflxv1 ) |
---|
334 | CALL wrk_dealloc( jpi, jpj, zwdlmtu, zwdlmtv) |
---|
335 | CALL wrk_dealloc( jpi, jpj, sum_e3u, sum_e3v) |
---|
336 | ! |
---|
337 | END IF |
---|
338 | |
---|
339 | IF( nn_timing == 1 ) CALL timing_stop('wad_lmt') |
---|
340 | END SUBROUTINE wad_lmt_bt |
---|
341 | !!====================================================================== |
---|
342 | END MODULE wadlmt |
---|