source: branches/2011/dev_r2802_NOCL_bfrimp/NEMOGCM/NEMO/OPA_SRC/ZDF/zdfbfr.F90 @ 2872

Last change on this file since 2872 was 2872, checked in by hliu, 9 years ago

1) added the semi-implicit bottom friction code (3 in DYN, 1 in ZDF), 2) added par_AMM7/12.h90, 3) added two arch files for NOCL mobius and ubuntu linux

  • Property svn:keywords set to Id
File size: 12.6 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   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   zdf_bfr      : update momentum Kz at the ocean bottom due to the type of bottom friction chosen
14   !!   zdf_bfr_init : read in namelist and control the bottom friction parameters.
15   !!   zdf_bfr_2d   : read in namelist and control the bottom friction parameters.
16   !!----------------------------------------------------------------------
17   USE oce             ! ocean dynamics and tracers variables
18   USE dom_oce         ! ocean space and time domain variables
19   USE zdf_oce         ! ocean vertical physics variables
20   USE in_out_manager  ! I/O manager
21   USE lbclnk          ! ocean lateral boundary conditions (or mpp link)
22   USE lib_mpp         ! distributed memory computing
23   USE prtctl          ! Print control
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   zdf_bfr         ! called by step.F90
29   PUBLIC   zdf_bfr_init    ! called by opa.F90
30
31   !                                    !!* Namelist nambfr: bottom friction namelist *
32   INTEGER  ::   nn_bfr    = 0           ! = 0/1/2/3 type of bottom friction
33   REAL(wp) ::   rn_bfri1  = 4.0e-4_wp   ! bottom drag coefficient (linear case)
34   REAL(wp) ::   rn_bfri2  = 1.0e-3_wp   ! bottom drag coefficient (non linear case)
35   REAL(wp) ::   rn_bfeb2  = 2.5e-3_wp   ! background bottom turbulent kinetic energy  [m2/s2]
36   REAL(wp) ::   rn_bfrien = 30._wp      ! local factor to enhance coefficient bfri
37   LOGICAL  ::   ln_bfr2d  = .false.     ! logical switch for 2D enhancement
38   LOGICAL, PUBLIC  ::   ln_bfrimp = .false.     ! logical switch for implicit bottom friction
39   
40   REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) ::  bfrcoef2d   ! 2D bottom drag coefficient
41
42   !! * Substitutions
43#  include "vectopt_loop_substitute.h90"
44#  include "domzgr_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52   INTEGER FUNCTION zdf_bfr_alloc()
53      !!----------------------------------------------------------------------
54      !!                ***  FUNCTION zdf_bfr_alloc  ***
55      !!----------------------------------------------------------------------
56      ALLOCATE( bfrcoef2d(jpi,jpj), STAT=zdf_bfr_alloc )
57      !
58      IF( lk_mpp             )   CALL mpp_sum ( zdf_bfr_alloc )
59      IF( zdf_bfr_alloc /= 0 )   CALL ctl_warn('zdf_bfr_alloc: failed to allocate arrays.')
60   END FUNCTION zdf_bfr_alloc
61
62
63   SUBROUTINE zdf_bfr( kt )
64      !!----------------------------------------------------------------------
65      !!                   ***  ROUTINE zdf_bfr  ***
66      !!                 
67      !! ** Purpose :   compute the bottom friction coefficient.
68      !!
69      !! ** Method  :   Calculate and store part of the momentum trend due   
70      !!              to bottom friction following the chosen friction type
71      !!              (free-slip, linear, or quadratic). The component
72      !!              calculated here is multiplied by the bottom velocity in
73      !!              dyn_bfr to provide the trend term.
74      !!                The coefficients are updated at each time step only
75      !!              in the quadratic case.
76      !!
77      !! ** Action  :   bfrua , bfrva   bottom friction coefficients
78      !!----------------------------------------------------------------------
79      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
80      !!
81      INTEGER  ::   ji, jj       ! dummy loop indices
82      INTEGER  ::   ikbu, ikbv   ! local integers
83      REAL(wp) ::   zvu, zuv, zecu, zecv   ! temporary scalars
84      !!----------------------------------------------------------------------
85
86      IF( nn_bfr == 2 ) THEN                 ! quadratic botton friction
87         ! Calculate and store the quadratic bottom friction coefficient bfrua and bfrva
88         ! where bfrUa = C_d*SQRT(u_bot^2 + v_bot^2 + e_b) {U=[u,v]}
89         ! from these the trend due to bottom friction:  -F_h/e3U  can be calculated
90         ! where -F_h/e3U_bot = bfrUa*Ub/e3U_bot {U=[u,v]}
91         !
92# if defined key_vectopt_loop
93         DO jj = 1, 1
94!CDIR NOVERRCHK
95            DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
96# else
97!CDIR NOVERRCHK
98         DO jj = 2, jpjm1
99!CDIR NOVERRCHK
100            DO ji = 2, jpim1
101# endif
102               ikbu = mbku(ji,jj)         ! ocean bottom level at u- and v-points
103               ikbv = mbkv(ji,jj)         ! (deepest ocean u- and v-points)
104               !
105               zvu  = 0.25 * (  vn(ji,jj  ,ikbu) + vn(ji+1,jj  ,ikbu)     &
106                  &           + vn(ji,jj-1,ikbu) + vn(ji+1,jj-1,ikbu)  )
107               zuv  = 0.25 * (  un(ji,jj  ,ikbv) + un(ji-1,jj  ,ikbv)     &
108                  &           + un(ji,jj+1,ikbv) + un(ji-1,jj+1,ikbv)  )
109               !
110               zecu = SQRT(  un(ji,jj,ikbu) * un(ji,jj,ikbu) + zvu*zvu + rn_bfeb2  )
111               zecv = SQRT(  vn(ji,jj,ikbv) * vn(ji,jj,ikbv) + zuv*zuv + rn_bfeb2  )
112               !
113               bfrua(ji,jj) = - 0.5_wp * ( bfrcoef2d(ji,jj) + bfrcoef2d(ji+1,jj  ) ) * zecu 
114               bfrva(ji,jj) = - 0.5_wp * ( bfrcoef2d(ji,jj) + bfrcoef2d(ji  ,jj+1) ) * zecv
115            END DO
116         END DO
117         !
118         CALL lbc_lnk( bfrua, 'U', 1. )   ;   CALL lbc_lnk( bfrva, 'V', 1. )      ! Lateral boundary condition
119         !
120         IF(ln_ctl)   CALL prt_ctl( tab2d_1=bfrua, clinfo1=' bfr  - u: ', mask1=umask,        &
121            &                       tab2d_2=bfrva, clinfo2=       ' v: ', mask2=vmask,ovlap=1 )
122      ENDIF
123      !
124   END SUBROUTINE zdf_bfr
125
126
127   SUBROUTINE zdf_bfr_init
128      !!----------------------------------------------------------------------
129      !!                  ***  ROUTINE zdf_bfr_init  ***
130      !!                   
131      !! ** Purpose :   Initialization of the bottom friction
132      !!
133      !! ** Method  :   Read the nammbf namelist and check their consistency
134      !!              called at the first timestep (nit000)
135      !!----------------------------------------------------------------------
136      USE iom   ! I/O module for ehanced bottom friction file
137      !!
138      INTEGER ::   inum         ! logical unit for enhanced bottom friction file
139      INTEGER ::   ji, jj       ! dummy loop indexes
140      INTEGER ::   ikbu, ikbv   ! temporary integers
141      INTEGER ::   ictu, ictv   !    -          -
142      REAL(wp) ::  zminbfr, zmaxbfr   ! temporary scalars
143      REAL(wp) ::  zfru, zfrv         !    -         -
144      !!
145      NAMELIST/nambfr/ nn_bfr, rn_bfri1, rn_bfri2, rn_bfeb2, ln_bfr2d, rn_bfrien, ln_bfrimp
146      !!----------------------------------------------------------------------
147
148      REWIND ( numnam )               !* Read Namelist nam_bfr : bottom momentum boundary condition
149      READ   ( numnam, nambfr )
150
151      !                               !* Parameter control and print
152      IF(lwp) WRITE(numout,*)
153      IF(lwp) WRITE(numout,*) 'zdf_bfr : momentum bottom friction'
154      IF(lwp) WRITE(numout,*) '~~~~~~~'
155      IF(lwp) WRITE(numout,*) '   Namelist nam_bfr : set bottom friction parameters'
156
157      !                              ! allocate zdfbfr arrays
158      IF( zdf_bfr_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'zdf_bfr_init : unable to allocate arrays' )
159
160      SELECT CASE (nn_bfr)
161      !
162      CASE( 0 )
163         IF(lwp) WRITE(numout,*) '      free-slip '
164         bfrua(:,:) = 0.e0
165         bfrva(:,:) = 0.e0
166         !
167      CASE( 1 )
168         IF(lwp) WRITE(numout,*) '      linear botton friction'
169         IF(lwp) WRITE(numout,*) '      friction coef.   rn_bfri1  = ', rn_bfri1
170         IF( ln_bfr2d ) THEN
171            IF(lwp) WRITE(numout,*) '      read coef. enhancement distribution from file   ln_bfr2d  = ', ln_bfr2d
172            IF(lwp) WRITE(numout,*) '      coef rn_bfri2 enhancement factor                rn_bfrien  = ',rn_bfrien
173         ENDIF
174         !
175         bfrcoef2d(:,:) = rn_bfri1  ! initialize bfrcoef2d to the namelist variable
176         !
177         IF(ln_bfr2d) THEN 
178            ! bfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement
179            CALL iom_open('bfr_coef.nc',inum)
180            CALL iom_get (inum, jpdom_data, 'bfr_coef',bfrcoef2d,1) ! bfrcoef2d is used as tmp array
181            CALL iom_close(inum)
182            bfrcoef2d(:,:) = rn_bfri1 * ( 1 + rn_bfrien * bfrcoef2d(:,:) )
183         ENDIF
184         bfrua(:,:) = - bfrcoef2d(:,:)
185         bfrva(:,:) = - bfrcoef2d(:,:)
186         !
187      CASE( 2 )
188         IF(lwp) WRITE(numout,*) '      quadratic botton friction'
189         IF(lwp) WRITE(numout,*) '      friction coef.   rn_bfri2  = ', rn_bfri2
190         IF(lwp) WRITE(numout,*) '      background tke   rn_bfeb2  = ', rn_bfeb2
191         IF( ln_bfr2d ) THEN
192            IF(lwp) WRITE(numout,*) '      read coef. enhancement distribution from file   ln_bfr2d  = ', ln_bfr2d
193            IF(lwp) WRITE(numout,*) '      coef rn_bfri2 enhancement factor                rn_bfrien  = ',rn_bfrien
194         ENDIF
195         bfrcoef2d(:,:) = rn_bfri2  ! initialize bfrcoef2d to the namelist variable
196         !
197         IF(ln_bfr2d) THEN 
198            ! bfr_coef is a coefficient in [0,1] giving the mask where to apply the bfr enhancement
199            CALL iom_open('bfr_coef.nc',inum)
200            CALL iom_get (inum, jpdom_data, 'bfr_coef',bfrcoef2d,1) ! bfrcoef2d is used as tmp array
201            CALL iom_close(inum)
202            bfrcoef2d(:,:)= rn_bfri2 * ( 1 + rn_bfrien * bfrcoef2d(:,:) )
203         ENDIF
204         !
205      CASE DEFAULT
206         IF(lwp) WRITE(ctmp1,*) '         bad flag value for nn_bfr = ', nn_bfr
207         CALL ctl_stop( ctmp1 )
208         !
209      END SELECT
210      !
211      ! Basic stability check on bottom friction coefficient
212      !
213      ictu = 0               ! counter for stability criterion breaches at U-pts
214      ictv = 0               ! counter for stability criterion breaches at V-pts
215      zminbfr =  1.e10_wp    ! initialise tracker for minimum of bottom friction coefficient
216      zmaxbfr = -1.e10_wp    ! initialise tracker for maximum of bottom friction coefficient
217      !
218#  if defined key_vectopt_loop
219      DO jj = 1, 1
220!CDIR NOVERRCHK
221         DO ji = jpi+2, jpij-jpi-1   ! vector opt. (forced unrolling)
222#  else
223!CDIR NOVERRCHK
224      DO jj = 2, jpjm1
225!CDIR NOVERRCHK
226         DO ji = 2, jpim1
227#  endif
228             ikbu = mbku(ji,jj)       ! deepest ocean level at u- and v-points
229             ikbv = mbkv(ji,jj)
230             zfru = 0.5 * fse3u(ji,jj,ikbu) / rdt
231             zfrv = 0.5 * fse3v(ji,jj,ikbv) / rdt
232             IF( ABS( bfrcoef2d(ji,jj) ) > zfru ) THEN
233                IF( ln_ctl ) THEN
234                   WRITE(numout,*) 'BFR ', narea, nimpp+ji, njmpp+jj, ikbu
235                   WRITE(numout,*) 'BFR ', ABS( bfrcoef2d(ji,jj) ), zfru
236                ENDIF
237                ictu = ictu + 1
238             ENDIF
239             IF( ABS( bfrcoef2d(ji,jj) ) > zfrv ) THEN
240                 IF( ln_ctl ) THEN
241                     WRITE(numout,*) 'BFR ', narea, nimpp+ji, njmpp+jj, ikbv
242                     WRITE(numout,*) 'BFR ', bfrcoef2d(ji,jj), zfrv
243                 ENDIF
244                 ictv = ictv + 1
245             ENDIF
246             zminbfr = MIN(  zminbfr, MIN( zfru, ABS( bfrcoef2d(ji,jj) ) )  )
247             zmaxbfr = MAX(  zmaxbfr, MIN( zfrv, ABS( bfrcoef2d(ji,jj) ) )  )
248         END DO
249      END DO
250      IF( lk_mpp ) THEN
251         CALL mpp_sum( ictu )
252         CALL mpp_sum( ictv )
253         CALL mpp_min( zminbfr )
254         CALL mpp_max( zmaxbfr )
255      ENDIF
256      IF( lwp .AND. ictu + ictv > 0 ) THEN
257         WRITE(numout,*) ' Bottom friction stability check failed at ', ictu, ' U-points '
258         WRITE(numout,*) ' Bottom friction stability check failed at ', ictv, ' V-points '
259         WRITE(numout,*) ' Bottom friction coefficient now ranges from: ', zminbfr, ' to ', zmaxbfr
260         WRITE(numout,*) ' Bottom friction coefficient will be reduced where necessary'
261      ENDIF
262      !
263   END SUBROUTINE zdf_bfr_init
264
265   !!======================================================================
266END MODULE zdfbfr
Note: See TracBrowser for help on using the repository browser.