1 | MODULE zdfbfr |
---|
2 | !!====================================================================== |
---|
3 | !! *** MODULE zdfbfr *** |
---|
4 | !! Ocean physics: Bottom friction |
---|
5 | !!====================================================================== |
---|
6 | !! History : OPA ! 1997-06 (G. Madec, A.-M. Treguier) Original code |
---|
7 | !! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module |
---|
8 | !! 3.2 ! 2009-09 (A.C.Coward) Correction to include barotropic contribution |
---|
9 | !! 3.3 ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase |
---|
10 | !! 3.4 ! 2011-11 (H. Liu) implementation of semi-implicit bottom friction option |
---|
11 | !! ! 2012-06 (H. Liu) implementation of Log Layer bottom friction option |
---|
12 | !!---------------------------------------------------------------------- |
---|
13 | |
---|
14 | !!---------------------------------------------------------------------- |
---|
15 | !! zdf_bfr : update bottom friction coefficient (non-linear bottom friction only) |
---|
16 | !! zdf_bfr_init : read in namelist and control the bottom friction parameters. |
---|
17 | !!---------------------------------------------------------------------- |
---|
18 | USE oce ! ocean dynamics and tracers variables |
---|
19 | USE dom_oce ! ocean space and time domain variables |
---|
20 | USE zdf_oce ! ocean vertical physics variables |
---|
21 | USE in_out_manager ! I/O manager |
---|
22 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
23 | USE lib_mpp ! distributed memory computing |
---|
24 | USE prtctl ! Print control |
---|
25 | USE timing ! Timing |
---|
26 | USE wrk_nemo ! Memory Allocation |
---|
27 | USE phycst, ONLY: vkarmn |
---|
28 | |
---|
29 | IMPLICIT NONE |
---|
30 | PRIVATE |
---|
31 | |
---|
32 | PUBLIC zdf_bfr ! called by step.F90 |
---|
33 | PUBLIC zdf_bfr_init ! called by nemogcm.F90 |
---|
34 | |
---|
35 | ! !!* Namelist nambfr: bottom friction namelist * |
---|
36 | INTEGER , PUBLIC :: nn_bfr ! = 0/1/2/3 type of bottom friction (PUBLIC for TAM) |
---|
37 | REAL(wp), PUBLIC :: rn_bfri1 ! bottom drag coefficient (linear case) (PUBLIC for TAM) |
---|
38 | REAL(wp), PUBLIC :: rn_bfri2 ! bottom drag coefficient (non linear case) (PUBLIC for TAM) |
---|
39 | REAL(wp), PUBLIC :: rn_bfri2_max ! Maximum bottom drag coefficient (non linear case and ln_loglayer=T) (PUBLIC for TAM) |
---|
40 | REAL(wp), PUBLIC :: rn_bfeb2 ! background bottom turbulent kinetic energy [m2/s2] (PUBLIC for TAM) |
---|
41 | REAL(wp), PUBLIC :: rn_bfrien ! local factor to enhance coefficient bfri (PUBLIC for TAM) |
---|
42 | LOGICAL , PUBLIC :: ln_bfr2d ! logical switch for 2D enhancement (PUBLIC for TAM) |
---|
43 | REAL(wp), PUBLIC :: rn_tfri1 ! top drag coefficient (linear case) (PUBLIC for TAM) |
---|
44 | REAL(wp), PUBLIC :: rn_tfri2 ! top drag coefficient (non linear case) (PUBLIC for TAM) |
---|
45 | REAL(wp), PUBLIC :: rn_tfri2_max ! Maximum top drag coefficient (non linear case and ln_loglayer=T) (PUBLIC for TAM) |
---|
46 | REAL(wp), PUBLIC :: rn_tfeb2 ! background top turbulent kinetic energy [m2/s2] (PUBLIC for TAM) |
---|
47 | REAL(wp), PUBLIC :: rn_tfrien ! local factor to enhance coefficient tfri (PUBLIC for TAM) |
---|
48 | LOGICAL , PUBLIC :: ln_tfr2d ! logical switch for 2D enhancement (PUBLIC for TAM) |
---|
49 | |
---|
50 | LOGICAL , PUBLIC :: ln_loglayer ! switch for log layer bfr coeff. (PUBLIC for TAM) |
---|
51 | REAL(wp), PUBLIC :: rn_bfrz0 ! bottom roughness for loglayer bfr coeff (PUBLIC for TAM) |
---|
52 | REAL(wp), PUBLIC :: rn_tfrz0 ! bottom roughness for loglayer bfr coeff (PUBLIC for TAM) |
---|
53 | LOGICAL , PUBLIC :: ln_bfrimp ! logical switch for implicit bottom friction |
---|
54 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:), PUBLIC :: bfrcoef2d, tfrcoef2d ! 2D bottom/top drag coefficient (PUBLIC for TAM) |
---|
55 | |
---|
56 | !! * Substitutions |
---|
57 | # include "vectopt_loop_substitute.h90" |
---|
58 | # include "domzgr_substitute.h90" |
---|
59 | !!---------------------------------------------------------------------- |
---|
60 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
---|
61 | !! $Id$ |
---|
62 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
63 | !!---------------------------------------------------------------------- |
---|
64 | CONTAINS |
---|
65 | |
---|
66 | INTEGER FUNCTION zdf_bfr_alloc() |
---|
67 | !!---------------------------------------------------------------------- |
---|
68 | !! *** FUNCTION zdf_bfr_alloc *** |
---|
69 | !!---------------------------------------------------------------------- |
---|
70 | ALLOCATE( bfrcoef2d(jpi,jpj), tfrcoef2d(jpi,jpj), STAT=zdf_bfr_alloc ) |
---|
71 | ! |
---|
72 | IF( lk_mpp ) CALL mpp_sum ( zdf_bfr_alloc ) |
---|
73 | IF( zdf_bfr_alloc /= 0 ) CALL ctl_warn('zdf_bfr_alloc: failed to allocate arrays.') |
---|
74 | END FUNCTION zdf_bfr_alloc |
---|
75 | |
---|
76 | |
---|
77 | SUBROUTINE zdf_bfr( kt ) |
---|
78 | !!---------------------------------------------------------------------- |
---|
79 | !! *** ROUTINE zdf_bfr *** |
---|
80 | !! |
---|
81 | !! ** Purpose : compute the bottom friction coefficient. |
---|
82 | !! |
---|
83 | !! ** Method : Calculate and store part of the momentum trend due |
---|
84 | !! to bottom friction following the chosen friction type |
---|
85 | !! (free-slip, linear, or quadratic). The component |
---|
86 | !! calculated here is multiplied by the bottom velocity in |
---|
87 | !! dyn_bfr to provide the trend term. |
---|
88 | !! The coefficients are updated at each time step only |
---|
89 | !! in the quadratic case. |
---|
90 | !! |
---|
91 | !! ** Action : bfrua , bfrva bottom friction coefficients |
---|
92 | !!---------------------------------------------------------------------- |
---|
93 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
94 | !! |
---|
95 | INTEGER :: ji, jj ! dummy loop indices |
---|
96 | INTEGER :: ikbt, ikbu, ikbv ! local integers |
---|
97 | REAL(wp) :: zvu, zuv, zecu, zecv, ztmp ! temporary scalars |
---|
98 | REAL(wp), POINTER, DIMENSION(:,:) :: zbfrt, ztfrt |
---|
99 | !!---------------------------------------------------------------------- |
---|
100 | ! |
---|
101 | IF( nn_timing == 1 ) CALL timing_start('zdf_bfr') |
---|
102 | ! |
---|
103 | IF( kt == nit000 .AND. lwp ) THEN |
---|
104 | WRITE(numout,*) |
---|
105 | WRITE(numout,*) 'zdf_bfr : Set bottom friction coefficient (non-linear case)' |
---|
106 | WRITE(numout,*) '~~~~~~~~' |
---|
107 | ENDIF |
---|
108 | ! |
---|
109 | IF( nn_bfr == 2 ) THEN ! quadratic bottom friction only |
---|
110 | ! |
---|
111 | CALL wrk_alloc( jpi, jpj, zbfrt, ztfrt ) |
---|
112 | |
---|
113 | IF ( ln_loglayer.AND.lk_vvl ) THEN ! "log layer" bottom friction coefficient |
---|
114 | |
---|
115 | DO jj = 1, jpj |
---|
116 | DO ji = 1, jpi |
---|
117 | ikbt = mbkt(ji,jj) |
---|
118 | !! JC: possible WAD implementation should modify line below if layers vanish |
---|
119 | ztmp = tmask(ji,jj,ikbt) * ( vkarmn / LOG( 0.5_wp * fse3t_n(ji,jj,ikbt) / rn_bfrz0 ))**2._wp |
---|
120 | zbfrt(ji,jj) = MAX(bfrcoef2d(ji,jj), ztmp) |
---|
121 | zbfrt(ji,jj) = MIN(zbfrt(ji,jj), rn_bfri2_max) |
---|
122 | END DO |
---|
123 | END DO |
---|
124 | ! (ISF) |
---|
125 | IF ( ln_isfcav ) THEN |
---|
126 | DO jj = 1, jpj |
---|
127 | DO ji = 1, jpi |
---|
128 | ikbt = mikt(ji,jj) |
---|
129 | ! JC: possible WAD implementation should modify line below if layers vanish |
---|
130 | ztmp = (1-tmask(ji,jj,1)) * ( vkarmn / LOG( 0.5_wp * fse3t_n(ji,jj,ikbt) / rn_bfrz0 ))**2._wp |
---|
131 | ztfrt(ji,jj) = MAX(tfrcoef2d(ji,jj), ztmp) |
---|
132 | ztfrt(ji,jj) = MIN(ztfrt(ji,jj), rn_tfri2_max) |
---|
133 | END DO |
---|
134 | END DO |
---|
135 | END IF |
---|
136 | ! |
---|
137 | ELSE |
---|
138 | zbfrt(:,:) = bfrcoef2d(:,:) |
---|
139 | ztfrt(:,:) = tfrcoef2d(:,:) |
---|
140 | ENDIF |
---|
141 | |
---|
142 | DO jj = 2, jpjm1 |
---|
143 | DO ji = 2, jpim1 |
---|
144 | ikbu = mbku(ji,jj) ! ocean bottom level at u- and v-points |
---|
145 | ikbv = mbkv(ji,jj) ! (deepest ocean u- and v-points) |
---|
146 | ! |
---|
147 | zvu = 0.25 * ( vn(ji,jj ,ikbu) + vn(ji+1,jj ,ikbu) & |
---|
148 | & + vn(ji,jj-1,ikbu) + vn(ji+1,jj-1,ikbu) ) |
---|
149 | zuv = 0.25 * ( un(ji,jj ,ikbv) + un(ji-1,jj ,ikbv) & |
---|
150 | & + un(ji,jj+1,ikbv) + un(ji-1,jj+1,ikbv) ) |
---|
151 | ! |
---|
152 | zecu = SQRT( un(ji,jj,ikbu) * un(ji,jj,ikbu) + zvu*zvu + rn_bfeb2 ) |
---|
153 | zecv = SQRT( vn(ji,jj,ikbv) * vn(ji,jj,ikbv) + zuv*zuv + rn_bfeb2 ) |
---|
154 | ! |
---|
155 | bfrua(ji,jj) = - 0.5_wp * ( zbfrt(ji,jj) + zbfrt(ji+1,jj ) ) * zecu |
---|
156 | bfrva(ji,jj) = - 0.5_wp * ( zbfrt(ji,jj) + zbfrt(ji ,jj+1) ) * zecv |
---|
157 | ! |
---|
158 | ! in case of 2 cell water column, we assume each cell feels the top and bottom friction |
---|
159 | IF ( ln_isfcav ) THEN |
---|
160 | IF ( miku(ji,jj) + 1 .GE. mbku(ji,jj) ) THEN |
---|
161 | bfrua(ji,jj) = - 0.5_wp * ( ( zbfrt(ji,jj) + zbfrt(ji+1,jj ) ) & |
---|
162 | & + ( ztfrt(ji,jj) + ztfrt(ji+1,jj ) ) ) & |
---|
163 | & * zecu * (1._wp - umask(ji,jj,1)) |
---|
164 | END IF |
---|
165 | IF ( mikv(ji,jj) + 1 .GE. mbkv(ji,jj) ) THEN |
---|
166 | bfrva(ji,jj) = - 0.5_wp * ( ( zbfrt(ji,jj) + zbfrt(ji ,jj+1) ) & |
---|
167 | & + ( ztfrt(ji,jj) + ztfrt(ji ,jj+1) ) ) & |
---|
168 | & * zecv * (1._wp - vmask(ji,jj,1)) |
---|
169 | END IF |
---|
170 | END IF |
---|
171 | END DO |
---|
172 | END DO |
---|
173 | CALL lbc_lnk( bfrua, 'U', 1. ) ; CALL lbc_lnk( bfrva, 'V', 1. ) ! Lateral boundary condition |
---|
174 | |
---|
175 | IF ( ln_isfcav ) THEN |
---|
176 | DO jj = 2, jpjm1 |
---|
177 | DO ji = 2, jpim1 |
---|
178 | ! (ISF) ======================================================================== |
---|
179 | ikbu = miku(ji,jj) ! ocean top level at u- and v-points |
---|
180 | ikbv = mikv(ji,jj) ! (1st wet ocean u- and v-points) |
---|
181 | ! |
---|
182 | zvu = 0.25 * ( vn(ji,jj ,ikbu) + vn(ji+1,jj ,ikbu) & |
---|
183 | & + vn(ji,jj-1,ikbu) + vn(ji+1,jj-1,ikbu) ) |
---|
184 | zuv = 0.25 * ( un(ji,jj ,ikbv) + un(ji-1,jj ,ikbv) & |
---|
185 | & + un(ji,jj+1,ikbv) + un(ji-1,jj+1,ikbv) ) |
---|
186 | ! |
---|
187 | zecu = SQRT( un(ji,jj,ikbu) * un(ji,jj,ikbu) + zvu*zvu + rn_tfeb2 ) |
---|
188 | zecv = SQRT( vn(ji,jj,ikbv) * vn(ji,jj,ikbv) + zuv*zuv + rn_tfeb2 ) |
---|
189 | ! |
---|
190 | tfrua(ji,jj) = - 0.5_wp * ( ztfrt(ji,jj) + ztfrt(ji+1,jj ) ) * zecu * (1._wp - umask(ji,jj,1)) |
---|
191 | tfrva(ji,jj) = - 0.5_wp * ( ztfrt(ji,jj) + ztfrt(ji ,jj+1) ) * zecv * (1._wp - vmask(ji,jj,1)) |
---|
192 | ! (ISF) END ==================================================================== |
---|
193 | ! in case of 2 cell water column, we assume each cell feels the top and bottom friction |
---|
194 | IF ( miku(ji,jj) + 1 .GE. mbku(ji,jj) ) THEN |
---|
195 | tfrua(ji,jj) = - 0.5_wp * ( ( ztfrt(ji,jj) + ztfrt(ji+1,jj ) ) & |
---|
196 | & + ( zbfrt(ji,jj) + zbfrt(ji+1,jj ) ) ) & |
---|
197 | & * zecu * (1._wp - umask(ji,jj,1)) |
---|
198 | END IF |
---|
199 | IF ( mikv(ji,jj) + 1 .GE. mbkv(ji,jj) ) THEN |
---|
200 | tfrva(ji,jj) = - 0.5_wp * ( ( ztfrt(ji,jj) + ztfrt(ji ,jj+1) ) & |
---|
201 | & + ( zbfrt(ji,jj) + zbfrt(ji ,jj+1) ) ) & |
---|
202 | & * zecv * (1._wp - vmask(ji,jj,1)) |
---|
203 | END IF |
---|
204 | END DO |
---|
205 | END DO |
---|
206 | CALL lbc_lnk( tfrua, 'U', 1. ) ; CALL lbc_lnk( tfrva, 'V', 1. ) ! Lateral boundary condition |
---|
207 | END IF |
---|
208 | ! |
---|
209 | ! |
---|
210 | IF(ln_ctl) CALL prt_ctl( tab2d_1=bfrua, clinfo1=' bfr - u: ', mask1=umask, & |
---|
211 | & tab2d_2=bfrva, clinfo2= ' v: ', mask2=vmask,ovlap=1 ) |
---|
212 | CALL wrk_dealloc( jpi,jpj,zbfrt, ztfrt ) |
---|
213 | ENDIF |
---|
214 | ! |
---|
215 | IF( nn_timing == 1 ) CALL timing_stop('zdf_bfr') |
---|
216 | ! |
---|
217 | END SUBROUTINE zdf_bfr |
---|
218 | |
---|
219 | |
---|
220 | SUBROUTINE zdf_bfr_init |
---|
221 | !!---------------------------------------------------------------------- |
---|
222 | !! *** ROUTINE zdf_bfr_init *** |
---|
223 | !! |
---|
224 | !! ** Purpose : Initialization of the bottom friction |
---|
225 | !! |
---|
226 | !! ** Method : Read the nambfr namelist and check their consistency |
---|
227 | !! called at the first timestep (nit000) |
---|
228 | !!---------------------------------------------------------------------- |
---|
229 | USE iom ! I/O module for ehanced bottom friction file |
---|
230 | !! |
---|
231 | INTEGER :: inum ! logical unit for enhanced bottom friction file |
---|
232 | INTEGER :: ji, jj ! dummy loop indexes |
---|
233 | INTEGER :: ikbt, ikbu, ikbv ! temporary integers |
---|
234 | INTEGER :: ictu, ictv ! - - |
---|
235 | INTEGER :: ios |
---|
236 | REAL(wp) :: zminbfr, zmaxbfr ! temporary scalars |
---|
237 | REAL(wp) :: zmintfr, zmaxtfr ! temporary scalars |
---|
238 | REAL(wp) :: ztmp, zfru, zfrv ! - - |
---|
239 | !! |
---|
240 | NAMELIST/nambfr/ nn_bfr, rn_bfri1, rn_bfri2, rn_bfri2_max, rn_bfeb2, rn_bfrz0, ln_bfr2d, & |
---|
241 | & rn_tfri1, rn_tfri2, rn_tfri2_max, rn_tfeb2, rn_tfrz0, ln_tfr2d, & |
---|
242 | & rn_bfrien, rn_tfrien, ln_bfrimp, ln_loglayer |
---|
243 | !!---------------------------------------------------------------------- |
---|
244 | ! |
---|
245 | IF( nn_timing == 1 ) CALL timing_start('zdf_bfr_init') |
---|
246 | ! |
---|
247 | ! !* Allocate zdfbfr arrays |
---|
248 | IF( zdf_bfr_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'zdf_bfr_init : unable to allocate arrays' ) |
---|
249 | ! |
---|
250 | ! !* Parameter control and print |
---|
251 | ! |
---|
252 | REWIND( numnam_ref ) ! Namelist nambfr in reference namelist : Bottom momentum boundary condition |
---|
253 | READ ( numnam_ref, nambfr, IOSTAT = ios, ERR = 901) |
---|
254 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambfr in reference namelist', lwp ) |
---|
255 | |
---|
256 | REWIND( numnam_cfg ) ! Namelist nambfr in configuration namelist : Bottom momentum boundary condition |
---|
257 | READ ( numnam_cfg, nambfr, IOSTAT = ios, ERR = 902 ) |
---|
258 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambfr in configuration namelist', lwp ) |
---|
259 | IF(lwm) WRITE ( numond, nambfr ) |
---|
260 | IF(lwp) WRITE(numout,*) |
---|
261 | IF(lwp) WRITE(numout,*) 'zdf_bfr_init : momentum bottom friction' |
---|
262 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~' |
---|
263 | IF(lwp) WRITE(numout,*) ' Namelist nam_bfr : set bottom friction parameters' |
---|
264 | ! |
---|
265 | SELECT CASE (nn_bfr) |
---|
266 | ! |
---|
267 | CASE( 0 ) |
---|
268 | IF(lwp) WRITE(numout,*) ' free-slip ' |
---|
269 | bfrua(:,:) = 0.e0 |
---|
270 | bfrva(:,:) = 0.e0 |
---|
271 | tfrua(:,:) = 0.e0 |
---|
272 | tfrva(:,:) = 0.e0 |
---|
273 | ! |
---|
274 | CASE( 1 ) |
---|
275 | IF(lwp) WRITE(numout,*) ' linear botton friction' |
---|
276 | IF(lwp) WRITE(numout,*) ' bottom friction coef. rn_bfri1 = ', rn_bfri1 |
---|
277 | IF( ln_bfr2d ) THEN |
---|
278 | IF(lwp) WRITE(numout,*) ' read coef. enhancement distribution from file ln_bfr2d = ', ln_bfr2d |
---|
279 | IF(lwp) WRITE(numout,*) ' coef rn_bfri2 enhancement factor rn_bfrien = ',rn_bfrien |
---|
280 | ENDIF |
---|
281 | IF ( ln_isfcav ) THEN |
---|
282 | IF(lwp) WRITE(numout,*) ' top friction coef. rn_bfri1 = ', rn_tfri1 |
---|
283 | IF( ln_tfr2d ) THEN |
---|
284 | IF(lwp) WRITE(numout,*) ' read coef. enhancement distribution from file ln_tfr2d = ', ln_tfr2d |
---|
285 | IF(lwp) WRITE(numout,*) ' coef rn_tfri2 enhancement factor rn_tfrien = ',rn_tfrien |
---|
286 | ENDIF |
---|
287 | END IF |
---|
288 | ! |
---|
289 | IF(ln_bfr2d) THEN |
---|
290 | ! bfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement |
---|
291 | CALL iom_open('bfr_coef.nc',inum) |
---|
292 | CALL iom_get (inum, jpdom_data, 'bfr_coef',bfrcoef2d,1) ! bfrcoef2d is used as tmp array |
---|
293 | CALL iom_close(inum) |
---|
294 | bfrcoef2d(:,:) = rn_bfri1 * ( 1 + rn_bfrien * bfrcoef2d(:,:) ) |
---|
295 | ELSE |
---|
296 | bfrcoef2d(:,:) = rn_bfri1 ! initialize bfrcoef2d to the namelist variable |
---|
297 | ENDIF |
---|
298 | ! |
---|
299 | bfrua(:,:) = - bfrcoef2d(:,:) |
---|
300 | bfrva(:,:) = - bfrcoef2d(:,:) |
---|
301 | ! |
---|
302 | IF ( ln_isfcav ) THEN |
---|
303 | IF(ln_tfr2d) THEN |
---|
304 | ! tfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement |
---|
305 | CALL iom_open('tfr_coef.nc',inum) |
---|
306 | CALL iom_get (inum, jpdom_data, 'tfr_coef',tfrcoef2d,1) ! tfrcoef2d is used as tmp array |
---|
307 | CALL iom_close(inum) |
---|
308 | tfrcoef2d(:,:) = rn_tfri1 * ( 1 + rn_tfrien * tfrcoef2d(:,:) ) |
---|
309 | ELSE |
---|
310 | tfrcoef2d(:,:) = rn_tfri1 ! initialize tfrcoef2d to the namelist variable |
---|
311 | ENDIF |
---|
312 | ! |
---|
313 | tfrua(:,:) = - tfrcoef2d(:,:) |
---|
314 | tfrva(:,:) = - tfrcoef2d(:,:) |
---|
315 | END IF |
---|
316 | ! |
---|
317 | CASE( 2 ) |
---|
318 | IF(lwp) WRITE(numout,*) ' quadratic bottom friction' |
---|
319 | IF(lwp) WRITE(numout,*) ' friction coef. rn_bfri2 = ', rn_bfri2 |
---|
320 | IF(lwp) WRITE(numout,*) ' Max. coef. (log case) rn_bfri2_max = ', rn_bfri2_max |
---|
321 | IF(lwp) WRITE(numout,*) ' background tke rn_bfeb2 = ', rn_bfeb2 |
---|
322 | IF(lwp) WRITE(numout,*) ' log formulation ln_bfr2d = ', ln_loglayer |
---|
323 | IF(lwp) WRITE(numout,*) ' bottom roughness rn_bfrz0 [m] = ', rn_bfrz0 |
---|
324 | IF( rn_bfrz0<=0.e0 ) THEN |
---|
325 | WRITE(ctmp1,*) ' bottom roughness must be strictly positive' |
---|
326 | CALL ctl_stop( ctmp1 ) |
---|
327 | ENDIF |
---|
328 | IF( ln_bfr2d ) THEN |
---|
329 | IF(lwp) WRITE(numout,*) ' read coef. enhancement distribution from file ln_bfr2d = ', ln_bfr2d |
---|
330 | IF(lwp) WRITE(numout,*) ' coef rn_bfri2 enhancement factor rn_bfrien = ',rn_bfrien |
---|
331 | ENDIF |
---|
332 | IF ( ln_isfcav ) THEN |
---|
333 | IF(lwp) WRITE(numout,*) ' quadratic top friction' |
---|
334 | IF(lwp) WRITE(numout,*) ' friction coef. rn_tfri2 = ', rn_tfri2 |
---|
335 | IF(lwp) WRITE(numout,*) ' Max. coef. (log case) rn_tfri2_max = ', rn_tfri2_max |
---|
336 | IF(lwp) WRITE(numout,*) ' background tke rn_tfeb2 = ', rn_tfeb2 |
---|
337 | IF(lwp) WRITE(numout,*) ' log formulation ln_tfr2d = ', ln_loglayer |
---|
338 | IF(lwp) WRITE(numout,*) ' top roughness rn_tfrz0 [m] = ', rn_tfrz0 |
---|
339 | IF( rn_tfrz0<=0.e0 ) THEN |
---|
340 | WRITE(ctmp1,*) ' top roughness must be strictly positive' |
---|
341 | CALL ctl_stop( ctmp1 ) |
---|
342 | ENDIF |
---|
343 | IF( ln_tfr2d ) THEN |
---|
344 | IF(lwp) WRITE(numout,*) ' read coef. enhancement distribution from file ln_tfr2d = ', ln_tfr2d |
---|
345 | IF(lwp) WRITE(numout,*) ' coef rn_tfri2 enhancement factor rn_tfrien = ',rn_tfrien |
---|
346 | ENDIF |
---|
347 | END IF |
---|
348 | ! |
---|
349 | IF(ln_bfr2d) THEN |
---|
350 | ! bfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement |
---|
351 | CALL iom_open('bfr_coef.nc',inum) |
---|
352 | CALL iom_get (inum, jpdom_data, 'bfr_coef',bfrcoef2d,1) ! bfrcoef2d is used as tmp array |
---|
353 | CALL iom_close(inum) |
---|
354 | ! |
---|
355 | bfrcoef2d(:,:) = rn_bfri2 * ( 1 + rn_bfrien * bfrcoef2d(:,:) ) |
---|
356 | ELSE |
---|
357 | bfrcoef2d(:,:) = rn_bfri2 ! initialize bfrcoef2d to the namelist variable |
---|
358 | ENDIF |
---|
359 | |
---|
360 | IF ( ln_isfcav ) THEN |
---|
361 | IF(ln_tfr2d) THEN |
---|
362 | ! tfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement |
---|
363 | CALL iom_open('tfr_coef.nc',inum) |
---|
364 | CALL iom_get (inum, jpdom_data, 'tfr_coef',tfrcoef2d,1) ! tfrcoef2d is used as tmp array |
---|
365 | CALL iom_close(inum) |
---|
366 | ! |
---|
367 | tfrcoef2d(:,:) = rn_tfri2 * ( 1 + rn_tfrien * tfrcoef2d(:,:) ) |
---|
368 | ELSE |
---|
369 | tfrcoef2d(:,:) = rn_tfri2 ! initialize tfrcoef2d to the namelist variable |
---|
370 | ENDIF |
---|
371 | END IF |
---|
372 | ! |
---|
373 | IF ( ln_loglayer.AND.(.NOT.lk_vvl) ) THEN ! set "log layer" bottom friction once for all |
---|
374 | DO jj = 1, jpj |
---|
375 | DO ji = 1, jpi |
---|
376 | ikbt = mbkt(ji,jj) |
---|
377 | ztmp = tmask(ji,jj,ikbt) * ( vkarmn / LOG( 0.5_wp * fse3t_n(ji,jj,ikbt) / rn_bfrz0 ))**2._wp |
---|
378 | bfrcoef2d(ji,jj) = MAX(bfrcoef2d(ji,jj), ztmp) |
---|
379 | bfrcoef2d(ji,jj) = MIN(bfrcoef2d(ji,jj), rn_bfri2_max) |
---|
380 | END DO |
---|
381 | END DO |
---|
382 | IF ( ln_isfcav ) THEN |
---|
383 | DO jj = 1, jpj |
---|
384 | DO ji = 1, jpi |
---|
385 | ikbt = mikt(ji,jj) |
---|
386 | ztmp = tmask(ji,jj,ikbt) * ( vkarmn / LOG( 0.5_wp * fse3t_n(ji,jj,ikbt) / rn_tfrz0 ))**2._wp |
---|
387 | tfrcoef2d(ji,jj) = MAX(tfrcoef2d(ji,jj), ztmp) |
---|
388 | tfrcoef2d(ji,jj) = MIN(tfrcoef2d(ji,jj), rn_tfri2_max) |
---|
389 | END DO |
---|
390 | END DO |
---|
391 | END IF |
---|
392 | ENDIF |
---|
393 | ! |
---|
394 | CASE DEFAULT |
---|
395 | IF(lwp) WRITE(ctmp1,*) ' bad flag value for nn_bfr = ', nn_bfr |
---|
396 | CALL ctl_stop( ctmp1 ) |
---|
397 | ! |
---|
398 | END SELECT |
---|
399 | ! |
---|
400 | IF(lwp) WRITE(numout,*) ' implicit bottom friction switch ln_bfrimp = ', ln_bfrimp |
---|
401 | ! |
---|
402 | ! ! Make sure ln_zdfexp=.false. when use implicit bfr |
---|
403 | IF( ln_bfrimp .AND. ln_zdfexp ) THEN |
---|
404 | IF(lwp) THEN |
---|
405 | WRITE(numout,*) |
---|
406 | WRITE(numout,*) 'Implicit bottom friction can only be used when ln_zdfexp=.false.' |
---|
407 | WRITE(numout,*) ' but you set: ln_bfrimp=.true. and ln_zdfexp=.true.!!!!' |
---|
408 | WRITE(ctmp1,*) ' set either ln_zdfexp = .false or ln_bfrimp = .false.' |
---|
409 | CALL ctl_stop( ctmp1 ) |
---|
410 | END IF |
---|
411 | END IF |
---|
412 | ! |
---|
413 | ! Basic stability check on bottom friction coefficient |
---|
414 | ! |
---|
415 | ictu = 0 ! counter for stability criterion breaches at U-pts |
---|
416 | ictv = 0 ! counter for stability criterion breaches at V-pts |
---|
417 | zminbfr = 1.e10_wp ! initialise tracker for minimum of bottom friction coefficient |
---|
418 | zmaxbfr = -1.e10_wp ! initialise tracker for maximum of bottom friction coefficient |
---|
419 | zmintfr = 1.e10_wp ! initialise tracker for minimum of bottom friction coefficient |
---|
420 | zmaxtfr = -1.e10_wp ! initialise tracker for maximum of bottom friction coefficient |
---|
421 | ! |
---|
422 | DO jj = 2, jpjm1 |
---|
423 | DO ji = 2, jpim1 |
---|
424 | ikbu = mbku(ji,jj) ! deepest ocean level at u- and v-points |
---|
425 | ikbv = mbkv(ji,jj) |
---|
426 | zfru = 0.5 * fse3u(ji,jj,ikbu) / rdt |
---|
427 | zfrv = 0.5 * fse3v(ji,jj,ikbv) / rdt |
---|
428 | IF( ABS( bfrcoef2d(ji,jj) ) > zfru ) THEN |
---|
429 | IF( ln_ctl ) THEN |
---|
430 | WRITE(numout,*) 'BFR ', narea, nimpp+ji, njmpp+jj, ikbu |
---|
431 | WRITE(numout,*) 'BFR ', ABS( bfrcoef2d(ji,jj) ), zfru |
---|
432 | ENDIF |
---|
433 | ictu = ictu + 1 |
---|
434 | ENDIF |
---|
435 | IF( ABS( bfrcoef2d(ji,jj) ) > zfrv ) THEN |
---|
436 | IF( ln_ctl ) THEN |
---|
437 | WRITE(numout,*) 'BFR ', narea, nimpp+ji, njmpp+jj, ikbv |
---|
438 | WRITE(numout,*) 'BFR ', bfrcoef2d(ji,jj), zfrv |
---|
439 | ENDIF |
---|
440 | ictv = ictv + 1 |
---|
441 | ENDIF |
---|
442 | zminbfr = MIN( zminbfr, MIN( zfru, ABS( bfrcoef2d(ji,jj) ) ) ) |
---|
443 | zmaxbfr = MAX( zmaxbfr, MIN( zfrv, ABS( bfrcoef2d(ji,jj) ) ) ) |
---|
444 | ! (ISF) |
---|
445 | IF ( ln_isfcav ) THEN |
---|
446 | ikbu = miku(ji,jj) ! 1st wet ocean level at u- and v-points |
---|
447 | ikbv = mikv(ji,jj) |
---|
448 | zfru = 0.5 * fse3u(ji,jj,ikbu) / rdt |
---|
449 | zfrv = 0.5 * fse3v(ji,jj,ikbv) / rdt |
---|
450 | IF( ABS( tfrcoef2d(ji,jj) ) > zfru ) THEN |
---|
451 | IF( ln_ctl ) THEN |
---|
452 | WRITE(numout,*) 'TFR ', narea, nimpp+ji, njmpp+jj, ikbu |
---|
453 | WRITE(numout,*) 'TFR ', ABS( tfrcoef2d(ji,jj) ), zfru |
---|
454 | ENDIF |
---|
455 | ictu = ictu + 1 |
---|
456 | ENDIF |
---|
457 | IF( ABS( tfrcoef2d(ji,jj) ) > zfrv ) THEN |
---|
458 | IF( ln_ctl ) THEN |
---|
459 | WRITE(numout,*) 'TFR ', narea, nimpp+ji, njmpp+jj, ikbv |
---|
460 | WRITE(numout,*) 'TFR ', tfrcoef2d(ji,jj), zfrv |
---|
461 | ENDIF |
---|
462 | ictv = ictv + 1 |
---|
463 | ENDIF |
---|
464 | zmintfr = MIN( zmintfr, MIN( zfru, ABS( tfrcoef2d(ji,jj) ) ) ) |
---|
465 | zmaxtfr = MAX( zmaxtfr, MIN( zfrv, ABS( tfrcoef2d(ji,jj) ) ) ) |
---|
466 | END IF |
---|
467 | ! END ISF |
---|
468 | END DO |
---|
469 | END DO |
---|
470 | IF( lk_mpp ) THEN |
---|
471 | CALL mpp_sum( ictu ) |
---|
472 | CALL mpp_sum( ictv ) |
---|
473 | CALL mpp_min( zminbfr ) |
---|
474 | CALL mpp_max( zmaxbfr ) |
---|
475 | IF ( ln_isfcav) CALL mpp_min( zmintfr ) |
---|
476 | IF ( ln_isfcav) CALL mpp_max( zmaxtfr ) |
---|
477 | ENDIF |
---|
478 | IF( .NOT.ln_bfrimp) THEN |
---|
479 | IF( lwp .AND. ictu + ictv > 0 ) THEN |
---|
480 | WRITE(numout,*) ' Bottom/Top friction stability check failed at ', ictu, ' U-points ' |
---|
481 | WRITE(numout,*) ' Bottom/Top friction stability check failed at ', ictv, ' V-points ' |
---|
482 | WRITE(numout,*) ' Bottom friction coefficient now ranges from: ', zminbfr, ' to ', zmaxbfr |
---|
483 | IF ( ln_isfcav ) WRITE(numout,*) ' Top friction coefficient now ranges from: ', zmintfr, ' to ', zmaxtfr |
---|
484 | WRITE(numout,*) ' Bottom/Top friction coefficient will be reduced where necessary' |
---|
485 | ENDIF |
---|
486 | ENDIF |
---|
487 | ! |
---|
488 | IF( nn_timing == 1 ) CALL timing_stop('zdf_bfr_init') |
---|
489 | ! |
---|
490 | END SUBROUTINE zdf_bfr_init |
---|
491 | |
---|
492 | !!====================================================================== |
---|
493 | END MODULE zdfbfr |
---|