New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
zdfbfr.F90 in branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfbfr.F90 @ 9366

Last change on this file since 9366 was 9366, checked in by andmirek, 6 years ago

#2050 first version. Compiled OK in moci test suite

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