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/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/OPA_SRC/ZDF – NEMO

source: branches/2016/dev_r6519_HPC_4/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfbfr.F90 @ 7508

Last change on this file since 7508 was 7508, checked in by mocavero, 8 years ago

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