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 @ 6748

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

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