[3] | 1 | MODULE ldfdyn |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE ldfdyn *** |
---|
| 4 | !! Ocean physics: lateral viscosity coefficient |
---|
| 5 | !!===================================================================== |
---|
[1601] | 6 | !! History : OPA ! 1997-07 (G. Madec) multi dimensional coefficients |
---|
| 7 | !! NEMO 1.0 ! 2002-09 (G. Madec) F90: Free form and module |
---|
[5836] | 8 | !! 3.7 ! 2014-01 (F. Lemarie, G. Madec) restructuration/simplification of ahm specification, |
---|
| 9 | !! ! add velocity dependent coefficient and optional read in file |
---|
[1601] | 10 | !!---------------------------------------------------------------------- |
---|
[3] | 11 | |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
[5836] | 13 | !! ldf_dyn_init : initialization, namelist read, and parameters control |
---|
| 14 | !! ldf_dyn : update lateral eddy viscosity coefficients at each time step |
---|
[3] | 15 | !!---------------------------------------------------------------------- |
---|
| 16 | USE oce ! ocean dynamics and tracers |
---|
| 17 | USE dom_oce ! ocean space and time domain |
---|
| 18 | USE phycst ! physical constants |
---|
[9490] | 19 | USE ldfslp ! lateral diffusion: slopes of mixing orientation |
---|
[5836] | 20 | USE ldfc1d_c2d ! lateral diffusion: 1D and 2D cases |
---|
| 21 | ! |
---|
[3] | 22 | USE in_out_manager ! I/O manager |
---|
[5836] | 23 | USE iom ! I/O module for ehanced bottom friction file |
---|
| 24 | USE timing ! Timing |
---|
[3] | 25 | USE lib_mpp ! distribued memory computing library |
---|
| 26 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
| 27 | |
---|
| 28 | IMPLICIT NONE |
---|
| 29 | PRIVATE |
---|
| 30 | |
---|
[5836] | 31 | PUBLIC ldf_dyn_init ! called by nemogcm.F90 |
---|
| 32 | PUBLIC ldf_dyn ! called by step.F90 |
---|
[3] | 33 | |
---|
[9490] | 34 | ! !!* Namelist namdyn_ldf : lateral mixing on momentum * |
---|
[9526] | 35 | LOGICAL , PUBLIC :: ln_dynldf_OFF !: No operator (i.e. no explicit diffusion) |
---|
[5836] | 36 | LOGICAL , PUBLIC :: ln_dynldf_lap !: laplacian operator |
---|
| 37 | LOGICAL , PUBLIC :: ln_dynldf_blp !: bilaplacian operator |
---|
| 38 | LOGICAL , PUBLIC :: ln_dynldf_lev !: iso-level direction |
---|
| 39 | LOGICAL , PUBLIC :: ln_dynldf_hor !: horizontal (geopotential) direction |
---|
[9490] | 40 | ! LOGICAL , PUBLIC :: ln_dynldf_iso !: iso-neutral direction (see ldfslp) |
---|
[5836] | 41 | INTEGER , PUBLIC :: nn_ahm_ijk_t !: choice of time & space variations of the lateral eddy viscosity coef. |
---|
[9490] | 42 | ! ! time invariant coefficients: aht = 1/2 Ud*Ld (lap case) |
---|
| 43 | ! ! bht = 1/12 Ud*Ld^3 (blp case) |
---|
| 44 | REAL(wp), PUBLIC :: rn_Uv !: lateral viscous velocity [m/s] |
---|
| 45 | REAL(wp), PUBLIC :: rn_Lv !: lateral viscous length [m] |
---|
| 46 | ! ! Smagorinsky viscosity (nn_ahm_ijk_t = 32) |
---|
| 47 | REAL(wp), PUBLIC :: rn_csmc !: Smagorinsky constant of proportionality |
---|
| 48 | REAL(wp), PUBLIC :: rn_minfac !: Multiplicative factor of theorectical minimum Smagorinsky viscosity |
---|
| 49 | REAL(wp), PUBLIC :: rn_maxfac !: Multiplicative factor of theorectical maximum Smagorinsky viscosity |
---|
| 50 | ! ! iso-neutral laplacian (ln_dynldf_lap=ln_dynldf_iso=T) |
---|
| 51 | REAL(wp), PUBLIC :: rn_ahm_b !: lateral laplacian background eddy viscosity [m2/s] |
---|
[3] | 52 | |
---|
[9490] | 53 | ! !!* Parameter to control the type of lateral viscous operator |
---|
| 54 | INTEGER, PARAMETER, PUBLIC :: np_ERROR =-10 !: error in setting the operator |
---|
| 55 | INTEGER, PARAMETER, PUBLIC :: np_no_ldf = 00 !: without operator (i.e. no lateral viscous trend) |
---|
| 56 | ! !! laplacian ! bilaplacian ! |
---|
| 57 | INTEGER, PARAMETER, PUBLIC :: np_lap = 10 , np_blp = 20 !: iso-level operator |
---|
| 58 | INTEGER, PARAMETER, PUBLIC :: np_lap_i = 11 !: iso-neutral or geopotential operator |
---|
| 59 | ! |
---|
| 60 | INTEGER , PUBLIC :: nldf_dyn !: type of lateral diffusion used defined from ln_dynldf_... (namlist logicals) |
---|
| 61 | LOGICAL , PUBLIC :: l_ldfdyn_time !: flag for time variation of the lateral eddy viscosity coef. |
---|
[5836] | 62 | |
---|
[9490] | 63 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: ahmt, ahmf !: eddy viscosity coef. at T- and F-points [m2/s or m4/s] |
---|
[10784] | 64 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: dtensq !: horizontal tension squared (Smagorinsky only) |
---|
| 65 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: dshesq !: horizontal shearing strain squared (Smagorinsky only) |
---|
[7646] | 66 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: esqt, esqf !: Square of the local gridscale (e1e2/(e1+e2))**2 |
---|
[5836] | 67 | |
---|
[9490] | 68 | REAL(wp) :: r1_2 = 0.5_wp ! =1/2 |
---|
[5836] | 69 | REAL(wp) :: r1_4 = 0.25_wp ! =1/4 |
---|
[7646] | 70 | REAL(wp) :: r1_8 = 0.125_wp ! =1/8 |
---|
[9490] | 71 | REAL(wp) :: r1_12 = 1._wp / 12._wp ! =1/12 |
---|
[5836] | 72 | REAL(wp) :: r1_288 = 1._wp / 288._wp ! =1/( 12^2 * 2 ) |
---|
| 73 | |
---|
[3] | 74 | !! * Substitutions |
---|
[5836] | 75 | # include "vectopt_loop_substitute.h90" |
---|
[3] | 76 | !!---------------------------------------------------------------------- |
---|
[9598] | 77 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[11715] | 78 | !! $Id$ |
---|
[10068] | 79 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[3] | 80 | !!---------------------------------------------------------------------- |
---|
| 81 | CONTAINS |
---|
| 82 | |
---|
| 83 | SUBROUTINE ldf_dyn_init |
---|
| 84 | !!---------------------------------------------------------------------- |
---|
| 85 | !! *** ROUTINE ldf_dyn_init *** |
---|
| 86 | !! |
---|
| 87 | !! ** Purpose : set the horizontal ocean dynamics physics |
---|
| 88 | !! |
---|
[5836] | 89 | !! ** Method : the eddy viscosity coef. specification depends on: |
---|
| 90 | !! - the operator: |
---|
| 91 | !! ln_dynldf_lap = T laplacian operator |
---|
| 92 | !! ln_dynldf_blp = T bilaplacian operator |
---|
| 93 | !! - the parameter nn_ahm_ijk_t: |
---|
| 94 | !! nn_ahm_ijk_t = 0 => = constant |
---|
| 95 | !! = 10 => = F(z) : = constant with a reduction of 1/4 with depth |
---|
| 96 | !! =-20 => = F(i,j) = shape read in 'eddy_viscosity.nc' file |
---|
| 97 | !! = 20 = F(i,j) = F(e1,e2) or F(e1^3,e2^3) (lap or bilap case) |
---|
| 98 | !! =-30 => = F(i,j,k) = shape read in 'eddy_viscosity.nc' file |
---|
| 99 | !! = 30 = F(i,j,k) = 2D (case 20) + decrease with depth (case 10) |
---|
| 100 | !! = 31 = F(i,j,k,t) = F(local velocity) ( |u|e /12 laplacian operator |
---|
| 101 | !! or |u|e^3/12 bilaplacian operator ) |
---|
[7646] | 102 | !! = 32 = F(i,j,k,t) = F(local deformation rate and gridscale) (D and L) (Smagorinsky) |
---|
| 103 | !! ( L^2|D| laplacian operator |
---|
| 104 | !! or L^4|D|/8 bilaplacian operator ) |
---|
[3] | 105 | !!---------------------------------------------------------------------- |
---|
[9490] | 106 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
| 107 | INTEGER :: ioptio, ierr, inum, ios, inn ! local integer |
---|
| 108 | REAL(wp) :: zah0, zah_max, zUfac ! local scalar |
---|
| 109 | CHARACTER(len=5) :: cl_Units ! units (m2/s or m4/s) |
---|
| 110 | !! |
---|
[9526] | 111 | NAMELIST/namdyn_ldf/ ln_dynldf_OFF, ln_dynldf_lap, ln_dynldf_blp, & ! type of operator |
---|
| 112 | & ln_dynldf_lev, ln_dynldf_hor, ln_dynldf_iso, & ! acting direction of the operator |
---|
| 113 | & nn_ahm_ijk_t , rn_Uv , rn_Lv, rn_ahm_b, & ! lateral eddy coefficient |
---|
| 114 | & rn_csmc , rn_minfac , rn_maxfac ! Smagorinsky settings |
---|
[5836] | 115 | !!---------------------------------------------------------------------- |
---|
| 116 | ! |
---|
[4147] | 117 | REWIND( numnam_ref ) ! Namelist namdyn_ldf in reference namelist : Lateral physics |
---|
| 118 | READ ( numnam_ref, namdyn_ldf, IOSTAT = ios, ERR = 901) |
---|
[11536] | 119 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_ldf in reference namelist' ) |
---|
[3] | 120 | |
---|
[4147] | 121 | REWIND( numnam_cfg ) ! Namelist namdyn_ldf in configuration namelist : Lateral physics |
---|
| 122 | READ ( numnam_cfg, namdyn_ldf, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 123 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namdyn_ldf in configuration namelist' ) |
---|
[4624] | 124 | IF(lwm) WRITE ( numond, namdyn_ldf ) |
---|
[4147] | 125 | |
---|
[1601] | 126 | IF(lwp) THEN ! Parameter print |
---|
[3] | 127 | WRITE(numout,*) |
---|
| 128 | WRITE(numout,*) 'ldf_dyn : lateral momentum physics' |
---|
| 129 | WRITE(numout,*) '~~~~~~~' |
---|
[4147] | 130 | WRITE(numout,*) ' Namelist namdyn_ldf : set lateral mixing parameters' |
---|
[5836] | 131 | ! |
---|
| 132 | WRITE(numout,*) ' type :' |
---|
[9526] | 133 | WRITE(numout,*) ' no explicit diffusion ln_dynldf_OFF = ', ln_dynldf_OFF |
---|
[5836] | 134 | WRITE(numout,*) ' laplacian operator ln_dynldf_lap = ', ln_dynldf_lap |
---|
| 135 | WRITE(numout,*) ' bilaplacian operator ln_dynldf_blp = ', ln_dynldf_blp |
---|
| 136 | ! |
---|
| 137 | WRITE(numout,*) ' direction of action :' |
---|
| 138 | WRITE(numout,*) ' iso-level ln_dynldf_lev = ', ln_dynldf_lev |
---|
| 139 | WRITE(numout,*) ' horizontal (geopotential) ln_dynldf_hor = ', ln_dynldf_hor |
---|
| 140 | WRITE(numout,*) ' iso-neutral ln_dynldf_iso = ', ln_dynldf_iso |
---|
| 141 | ! |
---|
| 142 | WRITE(numout,*) ' coefficients :' |
---|
| 143 | WRITE(numout,*) ' type of time-space variation nn_ahm_ijk_t = ', nn_ahm_ijk_t |
---|
[9490] | 144 | WRITE(numout,*) ' lateral viscous velocity (if cst) rn_Uv = ', rn_Uv, ' m/s' |
---|
| 145 | WRITE(numout,*) ' lateral viscous length (if cst) rn_Lv = ', rn_Lv, ' m' |
---|
| 146 | WRITE(numout,*) ' background viscosity (iso-lap case) rn_ahm_b = ', rn_ahm_b, ' m2/s' |
---|
| 147 | ! |
---|
[9019] | 148 | WRITE(numout,*) ' Smagorinsky settings (nn_ahm_ijk_t = 32) :' |
---|
[7646] | 149 | WRITE(numout,*) ' Smagorinsky coefficient rn_csmc = ', rn_csmc |
---|
[9490] | 150 | WRITE(numout,*) ' factor multiplier for eddy visc.' |
---|
| 151 | WRITE(numout,*) ' lower limit (default 1.0) rn_minfac = ', rn_minfac |
---|
| 152 | WRITE(numout,*) ' upper limit (default 1.0) rn_maxfac = ', rn_maxfac |
---|
[3] | 153 | ENDIF |
---|
| 154 | |
---|
[9490] | 155 | ! |
---|
| 156 | ! !== type of lateral operator used ==! (set nldf_dyn) |
---|
| 157 | ! !=====================================! |
---|
| 158 | ! |
---|
| 159 | nldf_dyn = np_ERROR |
---|
| 160 | ioptio = 0 |
---|
[9526] | 161 | IF( ln_dynldf_OFF ) THEN ; nldf_dyn = np_no_ldf ; ioptio = ioptio + 1 ; ENDIF |
---|
| 162 | IF( ln_dynldf_lap ) THEN ; ioptio = ioptio + 1 ; ENDIF |
---|
| 163 | IF( ln_dynldf_blp ) THEN ; ioptio = ioptio + 1 ; ENDIF |
---|
| 164 | IF( ioptio /= 1 ) CALL ctl_stop( 'dyn_ldf_init: use ONE of the 3 operator options (NONE/lap/blp)' ) |
---|
[9490] | 165 | ! |
---|
[9526] | 166 | IF(.NOT.ln_dynldf_OFF ) THEN !== direction ==>> type of operator ==! |
---|
[9490] | 167 | ioptio = 0 |
---|
| 168 | IF( ln_dynldf_lev ) ioptio = ioptio + 1 |
---|
| 169 | IF( ln_dynldf_hor ) ioptio = ioptio + 1 |
---|
| 170 | IF( ln_dynldf_iso ) ioptio = ioptio + 1 |
---|
| 171 | IF( ioptio /= 1 ) CALL ctl_stop( 'dyn_ldf_init: use ONE of the 3 direction options (level/hor/iso)' ) |
---|
| 172 | ! |
---|
| 173 | ! ! Set nldf_dyn, the type of lateral diffusion, from ln_dynldf_... logicals |
---|
| 174 | ierr = 0 |
---|
| 175 | IF( ln_dynldf_lap ) THEN ! laplacian operator |
---|
| 176 | IF( ln_zco ) THEN ! z-coordinate |
---|
| 177 | IF ( ln_dynldf_lev ) nldf_dyn = np_lap ! iso-level = horizontal (no rotation) |
---|
| 178 | IF ( ln_dynldf_hor ) nldf_dyn = np_lap ! iso-level = horizontal (no rotation) |
---|
| 179 | IF ( ln_dynldf_iso ) nldf_dyn = np_lap_i ! iso-neutral ( rotation) |
---|
| 180 | ENDIF |
---|
| 181 | IF( ln_zps ) THEN ! z-coordinate with partial step |
---|
| 182 | IF ( ln_dynldf_lev ) nldf_dyn = np_lap ! iso-level (no rotation) |
---|
| 183 | IF ( ln_dynldf_hor ) nldf_dyn = np_lap ! iso-level (no rotation) |
---|
| 184 | IF ( ln_dynldf_iso ) nldf_dyn = np_lap_i ! iso-neutral ( rotation) |
---|
| 185 | ENDIF |
---|
| 186 | IF( ln_sco ) THEN ! s-coordinate |
---|
| 187 | IF ( ln_dynldf_lev ) nldf_dyn = np_lap ! iso-level = horizontal (no rotation) |
---|
| 188 | IF ( ln_dynldf_hor ) nldf_dyn = np_lap_i ! horizontal ( rotation) |
---|
| 189 | IF ( ln_dynldf_iso ) nldf_dyn = np_lap_i ! iso-neutral ( rotation) |
---|
| 190 | ENDIF |
---|
| 191 | ENDIF |
---|
| 192 | ! |
---|
| 193 | IF( ln_dynldf_blp ) THEN ! bilaplacian operator |
---|
| 194 | IF( ln_zco ) THEN ! z-coordinate |
---|
| 195 | IF( ln_dynldf_lev ) nldf_dyn = np_blp ! iso-level = horizontal (no rotation) |
---|
| 196 | IF( ln_dynldf_hor ) nldf_dyn = np_blp ! iso-level = horizontal (no rotation) |
---|
| 197 | IF( ln_dynldf_iso ) ierr = 2 ! iso-neutral ( rotation) |
---|
| 198 | ENDIF |
---|
| 199 | IF( ln_zps ) THEN ! z-coordinate with partial step |
---|
| 200 | IF( ln_dynldf_lev ) nldf_dyn = np_blp ! iso-level (no rotation) |
---|
| 201 | IF( ln_dynldf_hor ) nldf_dyn = np_blp ! iso-level (no rotation) |
---|
| 202 | IF( ln_dynldf_iso ) ierr = 2 ! iso-neutral ( rotation) |
---|
| 203 | ENDIF |
---|
| 204 | IF( ln_sco ) THEN ! s-coordinate |
---|
| 205 | IF( ln_dynldf_lev ) nldf_dyn = np_blp ! iso-level (no rotation) |
---|
| 206 | IF( ln_dynldf_hor ) ierr = 2 ! horizontal ( rotation) |
---|
| 207 | IF( ln_dynldf_iso ) ierr = 2 ! iso-neutral ( rotation) |
---|
| 208 | ENDIF |
---|
| 209 | ENDIF |
---|
| 210 | ! |
---|
| 211 | IF( ierr == 2 ) CALL ctl_stop( 'rotated bi-laplacian operator does not exist' ) |
---|
| 212 | ! |
---|
| 213 | IF( nldf_dyn == np_lap_i ) l_ldfslp = .TRUE. ! rotation require the computation of the slopes |
---|
| 214 | ! |
---|
[3] | 215 | ENDIF |
---|
[5836] | 216 | ! |
---|
[9490] | 217 | IF(lwp) THEN |
---|
| 218 | WRITE(numout,*) |
---|
| 219 | SELECT CASE( nldf_dyn ) |
---|
| 220 | CASE( np_no_ldf ) ; WRITE(numout,*) ' ==>>> NO lateral viscosity' |
---|
| 221 | CASE( np_lap ) ; WRITE(numout,*) ' ==>>> iso-level laplacian operator' |
---|
| 222 | CASE( np_lap_i ) ; WRITE(numout,*) ' ==>>> rotated laplacian operator with iso-level background' |
---|
| 223 | CASE( np_blp ) ; WRITE(numout,*) ' ==>>> iso-level bi-laplacian operator' |
---|
| 224 | END SELECT |
---|
| 225 | WRITE(numout,*) |
---|
[3] | 226 | ENDIF |
---|
[9490] | 227 | |
---|
[1601] | 228 | ! |
---|
[9490] | 229 | ! !== Space/time variation of eddy coefficients ==! |
---|
| 230 | ! !=================================================! |
---|
[5836] | 231 | ! |
---|
[9490] | 232 | l_ldfdyn_time = .FALSE. ! no time variation except in case defined below |
---|
[1601] | 233 | ! |
---|
[9526] | 234 | IF( ln_dynldf_OFF ) THEN |
---|
[9490] | 235 | IF(lwp) WRITE(numout,*) ' ==>>> No viscous operator selected. ahmt and ahmf are not allocated' |
---|
| 236 | RETURN |
---|
[5836] | 237 | ! |
---|
[9490] | 238 | ELSE !== a lateral diffusion operator is used ==! |
---|
[5836] | 239 | ! |
---|
[9490] | 240 | ! ! allocate the ahm arrays |
---|
| 241 | ALLOCATE( ahmt(jpi,jpj,jpk) , ahmf(jpi,jpj,jpk) , STAT=ierr ) |
---|
| 242 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'ldf_dyn_init: failed to allocate arrays') |
---|
| 243 | ! |
---|
[10784] | 244 | ahmt(:,:,:) = 0._wp ! init to 0 needed |
---|
| 245 | ahmf(:,:,:) = 0._wp |
---|
[9490] | 246 | ! |
---|
| 247 | ! ! value of lap/blp eddy mixing coef. |
---|
| 248 | IF( ln_dynldf_lap ) THEN ; zUfac = r1_2 *rn_Uv ; inn = 1 ; cl_Units = ' m2/s' ! laplacian |
---|
| 249 | ELSEIF( ln_dynldf_blp ) THEN ; zUfac = r1_12*rn_Uv ; inn = 3 ; cl_Units = ' m4/s' ! bilaplacian |
---|
| 250 | ENDIF |
---|
| 251 | zah0 = zUfac * rn_Lv**inn ! mixing coefficient |
---|
| 252 | zah_max = zUfac * (ra*rad)**inn ! maximum reachable coefficient (value at the Equator) |
---|
| 253 | ! |
---|
| 254 | SELECT CASE( nn_ahm_ijk_t ) !* Specification of space-time variations of ahmt, ahmf |
---|
| 255 | ! |
---|
[5836] | 256 | CASE( 0 ) !== constant ==! |
---|
[9490] | 257 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity. = constant = ', zah0, cl_Units |
---|
| 258 | ahmt(:,:,1:jpkm1) = zah0 |
---|
| 259 | ahmf(:,:,1:jpkm1) = zah0 |
---|
[5836] | 260 | ! |
---|
| 261 | CASE( 10 ) !== fixed profile ==! |
---|
[9490] | 262 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F( depth )' |
---|
| 263 | IF(lwp) WRITE(numout,*) ' surface viscous coef. = constant = ', zah0, cl_Units |
---|
| 264 | ahmt(:,:,1) = zah0 ! constant surface value |
---|
| 265 | ahmf(:,:,1) = zah0 |
---|
| 266 | CALL ldf_c1d( 'DYN', ahmt(:,:,1), ahmf(:,:,1), ahmt, ahmf ) |
---|
[5836] | 267 | ! |
---|
| 268 | CASE ( -20 ) !== fixed horizontal shape read in file ==! |
---|
[9490] | 269 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F(i,j) read in eddy_viscosity.nc file' |
---|
[5836] | 270 | CALL iom_open( 'eddy_viscosity_2D.nc', inum ) |
---|
| 271 | CALL iom_get ( inum, jpdom_data, 'ahmt_2d', ahmt(:,:,1) ) |
---|
| 272 | CALL iom_get ( inum, jpdom_data, 'ahmf_2d', ahmf(:,:,1) ) |
---|
| 273 | CALL iom_close( inum ) |
---|
| 274 | DO jk = 2, jpkm1 |
---|
[9490] | 275 | ahmt(:,:,jk) = ahmt(:,:,1) |
---|
| 276 | ahmf(:,:,jk) = ahmf(:,:,1) |
---|
[5836] | 277 | END DO |
---|
| 278 | ! |
---|
| 279 | CASE( 20 ) !== fixed horizontal shape ==! |
---|
[9490] | 280 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F( e1, e2 ) or F( e1^3, e2^3 ) (lap. or blp. case)' |
---|
| 281 | IF(lwp) WRITE(numout,*) ' using a fixed viscous velocity = ', rn_Uv ,' m/s and Lv = Max(e1,e2)' |
---|
| 282 | IF(lwp) WRITE(numout,*) ' maximum reachable coefficient (at the Equator) = ', zah_max, cl_Units, ' for e1=1°)' |
---|
| 283 | CALL ldf_c2d( 'DYN', zUfac , inn , ahmt, ahmf ) ! surface value proportional to scale factor^inn |
---|
[5836] | 284 | ! |
---|
| 285 | CASE( -30 ) !== fixed 3D shape read in file ==! |
---|
[9490] | 286 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F(i,j,k) read in eddy_viscosity_3D.nc file' |
---|
[5836] | 287 | CALL iom_open( 'eddy_viscosity_3D.nc', inum ) |
---|
| 288 | CALL iom_get ( inum, jpdom_data, 'ahmt_3d', ahmt ) |
---|
| 289 | CALL iom_get ( inum, jpdom_data, 'ahmf_3d', ahmf ) |
---|
| 290 | CALL iom_close( inum ) |
---|
| 291 | ! |
---|
| 292 | CASE( 30 ) !== fixed 3D shape ==! |
---|
[9490] | 293 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F( latitude, longitude, depth )' |
---|
| 294 | IF(lwp) WRITE(numout,*) ' using a fixed viscous velocity = ', rn_Uv ,' m/s and Ld = Max(e1,e2)' |
---|
| 295 | IF(lwp) WRITE(numout,*) ' maximum reachable coefficient (at the Equator) = ', zah_max, cl_Units, ' for e1=1°)' |
---|
| 296 | CALL ldf_c2d( 'DYN', zUfac , inn , ahmt, ahmf ) ! surface value proportional to scale factor^inn |
---|
| 297 | CALL ldf_c1d( 'DYN', ahmt(:,:,1), ahmf(:,:,1), ahmt, ahmf ) ! reduction with depth |
---|
[5836] | 298 | ! |
---|
| 299 | CASE( 31 ) !== time varying 3D field ==! |
---|
[9490] | 300 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F( latitude, longitude, depth , time )' |
---|
| 301 | IF(lwp) WRITE(numout,*) ' proportional to the local velocity : 1/2 |u|e (lap) or 1/12 |u|e^3 (blp)' |
---|
[5836] | 302 | ! |
---|
| 303 | l_ldfdyn_time = .TRUE. ! will be calculated by call to ldf_dyn routine in step.F90 |
---|
| 304 | ! |
---|
[7646] | 305 | CASE( 32 ) !== time varying 3D field ==! |
---|
[9490] | 306 | IF(lwp) WRITE(numout,*) ' ==>>> eddy viscosity = F( latitude, longitude, depth , time )' |
---|
| 307 | IF(lwp) WRITE(numout,*) ' proportional to the local deformation rate and gridscale (Smagorinsky)' |
---|
[7646] | 308 | ! |
---|
| 309 | l_ldfdyn_time = .TRUE. ! will be calculated by call to ldf_dyn routine in step.F90 |
---|
| 310 | ! |
---|
[9490] | 311 | ! ! allocate arrays used in ldf_dyn. |
---|
[10784] | 312 | ALLOCATE( dtensq(jpi,jpj,jpk) , dshesq(jpi,jpj,jpk) , esqt(jpi,jpj) , esqf(jpi,jpj) , STAT=ierr ) |
---|
[7646] | 313 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'ldf_dyn_init: failed to allocate Smagorinsky arrays') |
---|
| 314 | ! |
---|
[10784] | 315 | DO jj = 1, jpj ! Set local gridscale values |
---|
| 316 | DO ji = 1, jpi |
---|
[11653] | 317 | esqt(ji,jj) = ( 2._wp * e1e2t(ji,jj) / ( e1t(ji,jj) + e2t(ji,jj) ) )**2 |
---|
| 318 | esqf(ji,jj) = ( 2._wp * e1e2f(ji,jj) / ( e1f(ji,jj) + e2f(ji,jj) ) )**2 |
---|
[7646] | 319 | END DO |
---|
| 320 | END DO |
---|
| 321 | ! |
---|
[5836] | 322 | CASE DEFAULT |
---|
| 323 | CALL ctl_stop('ldf_dyn_init: wrong choice for nn_ahm_ijk_t, the type of space-time variation of ahm') |
---|
| 324 | END SELECT |
---|
| 325 | ! |
---|
[9490] | 326 | IF( .NOT.l_ldfdyn_time ) THEN !* No time variation |
---|
| 327 | IF( ln_dynldf_lap ) THEN ! laplacian operator (mask only) |
---|
| 328 | ahmt(:,:,1:jpkm1) = ahmt(:,:,1:jpkm1) * tmask(:,:,1:jpkm1) |
---|
| 329 | ahmf(:,:,1:jpkm1) = ahmf(:,:,1:jpkm1) * fmask(:,:,1:jpkm1) |
---|
| 330 | ELSEIF( ln_dynldf_blp ) THEN ! bilaplacian operator (square root + mask) |
---|
| 331 | ahmt(:,:,1:jpkm1) = SQRT( ahmt(:,:,1:jpkm1) ) * tmask(:,:,1:jpkm1) |
---|
| 332 | ahmf(:,:,1:jpkm1) = SQRT( ahmf(:,:,1:jpkm1) ) * fmask(:,:,1:jpkm1) |
---|
| 333 | ENDIF |
---|
[5836] | 334 | ENDIF |
---|
| 335 | ! |
---|
[71] | 336 | ENDIF |
---|
[1601] | 337 | ! |
---|
[5836] | 338 | END SUBROUTINE ldf_dyn_init |
---|
[71] | 339 | |
---|
| 340 | |
---|
[5836] | 341 | SUBROUTINE ldf_dyn( kt ) |
---|
[3] | 342 | !!---------------------------------------------------------------------- |
---|
[5836] | 343 | !! *** ROUTINE ldf_dyn *** |
---|
| 344 | !! |
---|
| 345 | !! ** Purpose : update at kt the momentum lateral mixing coeff. (ahmt and ahmf) |
---|
[3] | 346 | !! |
---|
[5836] | 347 | !! ** Method : time varying eddy viscosity coefficients: |
---|
[3] | 348 | !! |
---|
[5836] | 349 | !! nn_ahm_ijk_t = 31 ahmt, ahmf = F(i,j,k,t) = F(local velocity) |
---|
| 350 | !! ( |u|e /12 or |u|e^3/12 for laplacian or bilaplacian operator ) |
---|
[3] | 351 | !! |
---|
[7646] | 352 | !! nn_ahm_ijk_t = 32 ahmt, ahmf = F(i,j,k,t) = F(local deformation rate and gridscale) (D and L) (Smagorinsky) |
---|
| 353 | !! ( L^2|D| or L^4|D|/8 for laplacian or bilaplacian operator ) |
---|
| 354 | !! |
---|
| 355 | !! ** note : in BLP cases the sqrt of the eddy coef is returned, since bilaplacian is en re-entrant laplacian |
---|
| 356 | !! ** action : ahmt, ahmf updated at each time step |
---|
[3] | 357 | !!---------------------------------------------------------------------- |
---|
[5836] | 358 | INTEGER, INTENT(in) :: kt ! time step index |
---|
[1601] | 359 | ! |
---|
[5836] | 360 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
[10784] | 361 | REAL(wp) :: zu2pv2_ij_p1, zu2pv2_ij, zu2pv2_ij_m1, zemax ! local scalar (option 31) |
---|
| 362 | REAL(wp) :: zcmsmag, zstabf_lo, zstabf_up, zdelta, zdb ! local scalar (option 32) |
---|
[5836] | 363 | !!---------------------------------------------------------------------- |
---|
| 364 | ! |
---|
[9019] | 365 | IF( ln_timing ) CALL timing_start('ldf_dyn') |
---|
[5836] | 366 | ! |
---|
| 367 | SELECT CASE( nn_ahm_ijk_t ) !== Eddy vicosity coefficients ==! |
---|
| 368 | ! |
---|
| 369 | CASE( 31 ) !== time varying 3D field ==! = F( local velocity ) |
---|
| 370 | ! |
---|
[7646] | 371 | IF( ln_dynldf_lap ) THEN ! laplacian operator : |u| e /12 = |u/144| e |
---|
[5836] | 372 | DO jk = 1, jpkm1 |
---|
| 373 | DO jj = 2, jpjm1 |
---|
| 374 | DO ji = fs_2, fs_jpim1 |
---|
| 375 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 376 | zu2pv2_ij_m1 = ub(ji-1,jj ,jk) * ub(ji-1,jj ,jk) + vb(ji ,jj-1,jk) * vb(ji ,jj-1,jk) |
---|
[10784] | 377 | zemax = MAX( e1t(ji,jj) , e2t(ji,jj) ) |
---|
| 378 | ahmt(ji,jj,jk) = SQRT( (zu2pv2_ij + zu2pv2_ij_m1) * r1_288 ) * zemax * tmask(ji,jj,jk) ! 288= 12*12 * 2 |
---|
[5836] | 379 | END DO |
---|
| 380 | END DO |
---|
[10784] | 381 | DO jj = 1, jpjm1 |
---|
| 382 | DO ji = 1, fs_jpim1 |
---|
| 383 | zu2pv2_ij_p1 = ub(ji ,jj+1,jk) * ub(ji ,jj+1,jk) + vb(ji+1,jj ,jk) * vb(ji+1,jj ,jk) |
---|
| 384 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 385 | zemax = MAX( e1f(ji,jj) , e2f(ji,jj) ) |
---|
| 386 | ahmf(ji,jj,jk) = SQRT( (zu2pv2_ij + zu2pv2_ij_p1) * r1_288 ) * zemax * fmask(ji,jj,jk) ! 288= 12*12 * 2 |
---|
| 387 | END DO |
---|
| 388 | END DO |
---|
[5836] | 389 | END DO |
---|
| 390 | ELSEIF( ln_dynldf_blp ) THEN ! bilaplacian operator : sqrt( |u| e^3 /12 ) = sqrt( |u/144| e ) * e |
---|
| 391 | DO jk = 1, jpkm1 |
---|
| 392 | DO jj = 2, jpjm1 |
---|
| 393 | DO ji = fs_2, fs_jpim1 |
---|
| 394 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 395 | zu2pv2_ij_m1 = ub(ji-1,jj ,jk) * ub(ji-1,jj ,jk) + vb(ji ,jj-1,jk) * vb(ji ,jj-1,jk) |
---|
[10784] | 396 | zemax = MAX( e1t(ji,jj) , e2t(ji,jj) ) |
---|
| 397 | ahmt(ji,jj,jk) = SQRT( SQRT( (zu2pv2_ij + zu2pv2_ij_m1) * r1_288 ) * zemax ) * zemax * tmask(ji,jj,jk) |
---|
[5836] | 398 | END DO |
---|
| 399 | END DO |
---|
[10784] | 400 | DO jj = 1, jpjm1 |
---|
| 401 | DO ji = 1, fs_jpim1 |
---|
| 402 | zu2pv2_ij_p1 = ub(ji ,jj+1,jk) * ub(ji ,jj+1,jk) + vb(ji+1,jj ,jk) * vb(ji+1,jj ,jk) |
---|
| 403 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 404 | zemax = MAX( e1f(ji,jj) , e2f(ji,jj) ) |
---|
| 405 | ahmf(ji,jj,jk) = SQRT( SQRT( (zu2pv2_ij + zu2pv2_ij_p1) * r1_288 ) * zemax ) * zemax * fmask(ji,jj,jk) |
---|
| 406 | END DO |
---|
| 407 | END DO |
---|
[5836] | 408 | END DO |
---|
| 409 | ENDIF |
---|
| 410 | ! |
---|
[10425] | 411 | CALL lbc_lnk_multi( 'ldfdyn', ahmt, 'T', 1., ahmf, 'F', 1. ) |
---|
[5836] | 412 | ! |
---|
[7646] | 413 | ! |
---|
| 414 | CASE( 32 ) !== time varying 3D field ==! = F( local deformation rate and gridscale ) (Smagorinsky) |
---|
| 415 | ! |
---|
| 416 | IF( ln_dynldf_lap .OR. ln_dynldf_blp ) THEN ! laplacian operator : (C_smag/pi)^2 L^2 |D| |
---|
| 417 | ! |
---|
[10784] | 418 | zcmsmag = (rn_csmc/rpi)**2 ! (C_smag/pi)^2 |
---|
| 419 | zstabf_lo = rn_minfac * rn_minfac / ( 2._wp * 4._wp * zcmsmag ) ! lower limit stability factor scaling |
---|
| 420 | zstabf_up = rn_maxfac / ( 4._wp * zcmsmag * 2._wp * rdt ) ! upper limit stability factor scaling |
---|
[7646] | 421 | IF( ln_dynldf_blp ) zstabf_lo = ( 16._wp / 9._wp ) * zstabf_lo ! provide |U|L^3/12 lower limit instead |
---|
| 422 | ! ! of |U|L^3/16 in blp case |
---|
| 423 | DO jk = 1, jpkm1 |
---|
| 424 | ! |
---|
[10784] | 425 | DO jj = 2, jpjm1 |
---|
| 426 | DO ji = 2, jpim1 |
---|
| 427 | zdb = ( ub(ji,jj,jk) * r1_e2u(ji,jj) - ub(ji-1,jj,jk) * r1_e2u(ji-1,jj) ) * r1_e1t(ji,jj) * e2t(ji,jj) & |
---|
| 428 | & - ( vb(ji,jj,jk) * r1_e1v(ji,jj) - vb(ji,jj-1,jk) * r1_e1v(ji,jj-1) ) * r1_e2t(ji,jj) * e1t(ji,jj) |
---|
| 429 | dtensq(ji,jj,jk) = zdb * zdb * tmask(ji,jj,jk) |
---|
[7646] | 430 | END DO |
---|
| 431 | END DO |
---|
| 432 | ! |
---|
| 433 | DO jj = 1, jpjm1 |
---|
| 434 | DO ji = 1, jpim1 |
---|
[10784] | 435 | zdb = ( ub(ji,jj+1,jk) * r1_e1u(ji,jj+1) - ub(ji,jj,jk) * r1_e1u(ji,jj) ) * r1_e2f(ji,jj) * e1f(ji,jj) & |
---|
| 436 | & + ( vb(ji+1,jj,jk) * r1_e2v(ji+1,jj) - vb(ji,jj,jk) * r1_e2v(ji,jj) ) * r1_e1f(ji,jj) * e2f(ji,jj) |
---|
| 437 | dshesq(ji,jj,jk) = zdb * zdb * fmask(ji,jj,jk) |
---|
[7646] | 438 | END DO |
---|
| 439 | END DO |
---|
| 440 | ! |
---|
[10784] | 441 | END DO |
---|
| 442 | ! |
---|
| 443 | CALL lbc_lnk_multi( 'ldfdyn', dtensq, 'T', 1. ) ! lbc_lnk on dshesq not needed |
---|
| 444 | ! |
---|
| 445 | DO jk = 1, jpkm1 |
---|
| 446 | ! |
---|
| 447 | DO jj = 2, jpjm1 ! T-point value |
---|
[7646] | 448 | DO ji = fs_2, fs_jpim1 |
---|
| 449 | ! |
---|
| 450 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 451 | zu2pv2_ij_m1 = ub(ji-1,jj ,jk) * ub(ji-1,jj ,jk) + vb(ji ,jj-1,jk) * vb(ji ,jj-1,jk) |
---|
[10784] | 452 | ! |
---|
[7646] | 453 | zdelta = zcmsmag * esqt(ji,jj) ! L^2 * (C_smag/pi)^2 |
---|
[10784] | 454 | ahmt(ji,jj,jk) = zdelta * SQRT( dtensq(ji ,jj,jk) + & |
---|
| 455 | & r1_4 * ( dshesq(ji ,jj,jk) + dshesq(ji ,jj-1,jk) + & |
---|
| 456 | & dshesq(ji-1,jj,jk) + dshesq(ji-1,jj-1,jk) ) ) |
---|
| 457 | ahmt(ji,jj,jk) = MAX( ahmt(ji,jj,jk), SQRT( (zu2pv2_ij + zu2pv2_ij_m1) * zdelta * zstabf_lo ) ) ! Impose lower limit == minfac * |U|L/2 |
---|
| 458 | ahmt(ji,jj,jk) = MIN( ahmt(ji,jj,jk), zdelta * zstabf_up ) ! Impose upper limit == maxfac * L^2/(4*2dt) |
---|
| 459 | ! |
---|
| 460 | END DO |
---|
| 461 | END DO |
---|
| 462 | ! |
---|
| 463 | DO jj = 1, jpjm1 ! F-point value |
---|
| 464 | DO ji = 1, fs_jpim1 |
---|
| 465 | ! |
---|
| 466 | zu2pv2_ij_p1 = ub(ji ,jj+1,jk) * ub(ji ,jj+1,jk) + vb(ji+1,jj ,jk) * vb(ji+1,jj ,jk) |
---|
| 467 | zu2pv2_ij = ub(ji ,jj ,jk) * ub(ji ,jj ,jk) + vb(ji ,jj ,jk) * vb(ji ,jj ,jk) |
---|
| 468 | ! |
---|
[7646] | 469 | zdelta = zcmsmag * esqf(ji,jj) ! L^2 * (C_smag/pi)^2 |
---|
[10784] | 470 | ahmf(ji,jj,jk) = zdelta * SQRT( dshesq(ji ,jj,jk) + & |
---|
| 471 | & r1_4 * ( dtensq(ji ,jj,jk) + dtensq(ji ,jj+1,jk) + & |
---|
| 472 | & dtensq(ji+1,jj,jk) + dtensq(ji+1,jj+1,jk) ) ) |
---|
| 473 | ahmf(ji,jj,jk) = MAX( ahmf(ji,jj,jk), SQRT( (zu2pv2_ij + zu2pv2_ij_p1) * zdelta * zstabf_lo ) ) ! Impose lower limit == minfac * |U|L/2 |
---|
| 474 | ahmf(ji,jj,jk) = MIN( ahmf(ji,jj,jk), zdelta * zstabf_up ) ! Impose upper limit == maxfac * L^2/(4*2dt) |
---|
[7646] | 475 | ! |
---|
| 476 | END DO |
---|
| 477 | END DO |
---|
[10784] | 478 | ! |
---|
[7646] | 479 | END DO |
---|
| 480 | ! |
---|
| 481 | ENDIF |
---|
| 482 | ! |
---|
| 483 | IF( ln_dynldf_blp ) THEN ! bilaplacian operator : sqrt( (C_smag/pi)^2 L^4 |D|/8) |
---|
[9490] | 484 | ! ! = sqrt( A_lap_smag L^2/8 ) |
---|
| 485 | ! ! stability limits already applied to laplacian values |
---|
| 486 | ! ! effective default limits are 1/12 |U|L^3 < B_hm < 1//(32*2dt) L^4 |
---|
[7646] | 487 | DO jk = 1, jpkm1 |
---|
| 488 | DO jj = 2, jpjm1 |
---|
| 489 | DO ji = fs_2, fs_jpim1 |
---|
[9490] | 490 | ahmt(ji,jj,jk) = SQRT( r1_8 * esqt(ji,jj) * ahmt(ji,jj,jk) ) |
---|
[10784] | 491 | END DO |
---|
| 492 | END DO |
---|
| 493 | DO jj = 1, jpjm1 |
---|
| 494 | DO ji = 1, fs_jpim1 |
---|
[9490] | 495 | ahmf(ji,jj,jk) = SQRT( r1_8 * esqf(ji,jj) * ahmf(ji,jj,jk) ) |
---|
[7646] | 496 | END DO |
---|
| 497 | END DO |
---|
| 498 | END DO |
---|
| 499 | ! |
---|
| 500 | ENDIF |
---|
| 501 | ! |
---|
[10425] | 502 | CALL lbc_lnk_multi( 'ldfdyn', ahmt, 'T', 1. , ahmf, 'F', 1. ) |
---|
[7646] | 503 | ! |
---|
[5836] | 504 | END SELECT |
---|
| 505 | ! |
---|
| 506 | CALL iom_put( "ahmt_2d", ahmt(:,:,1) ) ! surface u-eddy diffusivity coeff. |
---|
| 507 | CALL iom_put( "ahmf_2d", ahmf(:,:,1) ) ! surface v-eddy diffusivity coeff. |
---|
| 508 | CALL iom_put( "ahmt_3d", ahmt(:,:,:) ) ! 3D u-eddy diffusivity coeff. |
---|
| 509 | CALL iom_put( "ahmf_3d", ahmf(:,:,:) ) ! 3D v-eddy diffusivity coeff. |
---|
| 510 | ! |
---|
[9019] | 511 | IF( ln_timing ) CALL timing_stop('ldf_dyn') |
---|
[5836] | 512 | ! |
---|
| 513 | END SUBROUTINE ldf_dyn |
---|
[3] | 514 | |
---|
| 515 | !!====================================================================== |
---|
| 516 | END MODULE ldfdyn |
---|