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