[3] | 1 | MODULE dynkeg |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE dynkeg *** |
---|
| 4 | !! Ocean dynamics: kinetic energy gradient trend |
---|
| 5 | !!====================================================================== |
---|
[5321] | 6 | !! History : 1.0 ! 1987-09 (P. Andrich, M.-A. Foujols) Original code |
---|
| 7 | !! 7.0 ! 1997-05 (G. Madec) Split dynber into dynkeg and dynhpg |
---|
| 8 | !! NEMO 1.0 ! 2002-07 (G. Madec) F90: Free form and module |
---|
[5328] | 9 | !! 3.6 ! 2015-05 (N. Ducousso, G. Madec) add Hollingsworth scheme as an option |
---|
[503] | 10 | !!---------------------------------------------------------------------- |
---|
[5328] | 11 | |
---|
[3] | 12 | !!---------------------------------------------------------------------- |
---|
| 13 | !! dyn_keg : update the momentum trend with the horizontal tke |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
| 15 | USE oce ! ocean dynamics and tracers |
---|
| 16 | USE dom_oce ! ocean space and time domain |
---|
[4990] | 17 | USE trd_oce ! trends: ocean variables |
---|
| 18 | USE trddyn ! trend manager: dynamics |
---|
| 19 | ! |
---|
[2715] | 20 | USE in_out_manager ! I/O manager |
---|
[5321] | 21 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
[2715] | 22 | USE lib_mpp ! MPP library |
---|
[258] | 23 | USE prtctl ! Print control |
---|
[3294] | 24 | USE timing ! Timing |
---|
[7646] | 25 | USE bdy_oce ! ocean open boundary conditions |
---|
[3] | 26 | |
---|
| 27 | IMPLICIT NONE |
---|
| 28 | PRIVATE |
---|
| 29 | |
---|
[503] | 30 | PUBLIC dyn_keg ! routine called by step module |
---|
[5328] | 31 | |
---|
[5321] | 32 | INTEGER, PARAMETER, PUBLIC :: nkeg_C2 = 0 !: 2nd order centered scheme (standard scheme) |
---|
| 33 | INTEGER, PARAMETER, PUBLIC :: nkeg_HW = 1 !: Hollingsworth et al., QJRMS, 1983 |
---|
| 34 | ! |
---|
| 35 | REAL(wp) :: r1_48 = 1._wp / 48._wp !: =1/(4*2*6) |
---|
[5328] | 36 | |
---|
[3] | 37 | !! * Substitutions |
---|
| 38 | # include "vectopt_loop_substitute.h90" |
---|
[503] | 39 | !!---------------------------------------------------------------------- |
---|
[9598] | 40 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[5328] | 41 | !! $Id$ |
---|
[10068] | 42 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[503] | 43 | !!---------------------------------------------------------------------- |
---|
[3] | 44 | CONTAINS |
---|
| 45 | |
---|
[5321] | 46 | SUBROUTINE dyn_keg( kt, kscheme ) |
---|
[3] | 47 | !!---------------------------------------------------------------------- |
---|
| 48 | !! *** ROUTINE dyn_keg *** |
---|
| 49 | !! |
---|
| 50 | !! ** Purpose : Compute the now momentum trend due to the horizontal |
---|
[5328] | 51 | !! gradient of the horizontal kinetic energy and add it to the |
---|
[3] | 52 | !! general momentum trend. |
---|
| 53 | !! |
---|
[5328] | 54 | !! ** Method : * kscheme = nkeg_C2 : 2nd order centered scheme that |
---|
| 55 | !! conserve kinetic energy. Compute the now horizontal kinetic energy |
---|
[3] | 56 | !! zhke = 1/2 [ mi-1( un^2 ) + mj-1( vn^2 ) ] |
---|
[5321] | 57 | !! * kscheme = nkeg_HW : Hollingsworth correction following |
---|
| 58 | !! Arakawa (2001). The now horizontal kinetic energy is given by: |
---|
| 59 | !! zhke = 1/6 [ mi-1( 2 * un^2 + ((un(j+1)+un(j-1))/2)^2 ) |
---|
| 60 | !! + mj-1( 2 * vn^2 + ((vn(i+1)+vn(i-1))/2)^2 ) ] |
---|
[5328] | 61 | !! |
---|
[3] | 62 | !! Take its horizontal gradient and add it to the general momentum |
---|
| 63 | !! trend (ua,va). |
---|
| 64 | !! ua = ua - 1/e1u di[ zhke ] |
---|
| 65 | !! va = va - 1/e2v dj[ zhke ] |
---|
| 66 | !! |
---|
| 67 | !! ** Action : - Update the (ua, va) with the hor. ke gradient trend |
---|
[4990] | 68 | !! - send this trends to trd_dyn (l_trddyn=T) for post-processing |
---|
[5321] | 69 | !! |
---|
| 70 | !! ** References : Arakawa, A., International Geophysics 2001. |
---|
| 71 | !! Hollingsworth et al., Quart. J. Roy. Meteor. Soc., 1983. |
---|
[503] | 72 | !!---------------------------------------------------------------------- |
---|
[5321] | 73 | INTEGER, INTENT( in ) :: kt ! ocean time-step index |
---|
[5328] | 74 | INTEGER, INTENT( in ) :: kscheme ! =0/1 type of KEG scheme |
---|
[4990] | 75 | ! |
---|
[10996] | 76 | INTEGER :: ji, jj, jk, jb ! dummy loop indices |
---|
[11024] | 77 | INTEGER :: igrd, ib_bdy ! local integers |
---|
[10996] | 78 | REAL(wp) :: zu, zv ! local scalars |
---|
[9019] | 79 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: zhke |
---|
| 80 | REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: ztrdu, ztrdv |
---|
[10996] | 81 | REAL(wp) :: zweightu, zweightv |
---|
[3] | 82 | !!---------------------------------------------------------------------- |
---|
[3294] | 83 | ! |
---|
[9019] | 84 | IF( ln_timing ) CALL timing_start('dyn_keg') |
---|
[3294] | 85 | ! |
---|
[3] | 86 | IF( kt == nit000 ) THEN |
---|
| 87 | IF(lwp) WRITE(numout,*) |
---|
[5321] | 88 | IF(lwp) WRITE(numout,*) 'dyn_keg : kinetic energy gradient trend, scheme number=', kscheme |
---|
[3] | 89 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
| 90 | ENDIF |
---|
[216] | 91 | |
---|
[9019] | 92 | IF( l_trddyn ) THEN ! Save the input trends |
---|
| 93 | ALLOCATE( ztrdu(jpi,jpj,jpk) , ztrdv(jpi,jpj,jpk) ) |
---|
[7753] | 94 | ztrdu(:,:,:) = ua(:,:,:) |
---|
| 95 | ztrdv(:,:,:) = va(:,:,:) |
---|
[216] | 96 | ENDIF |
---|
[5328] | 97 | |
---|
[7753] | 98 | zhke(:,:,jpk) = 0._wp |
---|
[7646] | 99 | |
---|
[5328] | 100 | SELECT CASE ( kscheme ) !== Horizontal kinetic energy at T-point ==! |
---|
| 101 | ! |
---|
| 102 | CASE ( nkeg_C2 ) !-- Standard scheme --! |
---|
| 103 | DO jk = 1, jpkm1 |
---|
[5321] | 104 | DO jj = 2, jpj |
---|
| 105 | DO ji = fs_2, jpi ! vector opt. |
---|
| 106 | zu = un(ji-1,jj ,jk) * un(ji-1,jj ,jk) & |
---|
| 107 | & + un(ji ,jj ,jk) * un(ji ,jj ,jk) |
---|
| 108 | zv = vn(ji ,jj-1,jk) * vn(ji ,jj-1,jk) & |
---|
| 109 | & + vn(ji ,jj ,jk) * vn(ji ,jj ,jk) |
---|
[5328] | 110 | zhke(ji,jj,jk) = 0.25_wp * ( zv + zu ) |
---|
| 111 | END DO |
---|
[5321] | 112 | END DO |
---|
[5328] | 113 | END DO |
---|
[5321] | 114 | ! |
---|
[10996] | 115 | IF (ln_bdy) THEN |
---|
| 116 | ! Maria Luneva & Fred Wobus: July-2016 |
---|
| 117 | ! compensate for lack of turbulent kinetic energy on liquid bdy points |
---|
| 118 | DO ib_bdy = 1, nb_bdy |
---|
| 119 | IF( cn_dyn3d(ib_bdy) /= 'none' ) THEN |
---|
| 120 | igrd = 1 ! compensating null velocity on the bdy |
---|
| 121 | DO jb = 1, idx_bdy(ib_bdy)%nblenrim(igrd) |
---|
[11048] | 122 | ji = idx_bdy(ib_bdy)%nbi(jb,igrd) ! maximum extent : from 1 to jpi |
---|
| 123 | jj = idx_bdy(ib_bdy)%nbj(jb,igrd) ! maximum extent : from 1 to jpj |
---|
| 124 | IF( ji == 1 .OR. ji == jpi .OR. jj == 1 .OR. jj == jpj ) CYCLE ! to remove? |
---|
[10996] | 125 | DO jk = 1, jpkm1 |
---|
| 126 | zhke(ji,jj,jk) = 0._wp |
---|
| 127 | zweightu = umask(ji-1,jj ,jk) + umask(ji,jj,jk) |
---|
| 128 | zweightv = vmask(ji ,jj-1,jk) + vmask(ji,jj,jk) |
---|
| 129 | zu = un(ji-1,jj ,jk) * un(ji-1,jj ,jk) + un(ji ,jj ,jk) * un(ji ,jj ,jk) |
---|
| 130 | zv = vn(ji ,jj-1,jk) * vn(ji ,jj-1,jk) + vn(ji ,jj ,jk) * vn(ji ,jj ,jk) |
---|
| 131 | IF( zweightu > 0._wp ) zhke(ji,jj,jk) = zhke(ji,jj,jk) + zu / (2._wp * zweightu) |
---|
| 132 | IF( zweightv > 0._wp ) zhke(ji,jj,jk) = zhke(ji,jj,jk) + zv / (2._wp * zweightv) |
---|
| 133 | END DO |
---|
| 134 | END DO |
---|
| 135 | END IF |
---|
| 136 | CALL lbc_bdy_lnk( 'dynkeg', zhke, 'T', 1., ib_bdy ) ! send 2 and recv jpi, jpj used in the computation of the speed tendencies |
---|
| 137 | END DO |
---|
| 138 | END IF |
---|
| 139 | ! |
---|
[5328] | 140 | CASE ( nkeg_HW ) !-- Hollingsworth scheme --! |
---|
| 141 | DO jk = 1, jpkm1 |
---|
| 142 | DO jj = 2, jpjm1 |
---|
[5321] | 143 | DO ji = fs_2, jpim1 ! vector opt. |
---|
| 144 | zu = 8._wp * ( un(ji-1,jj ,jk) * un(ji-1,jj ,jk) & |
---|
| 145 | & + un(ji ,jj ,jk) * un(ji ,jj ,jk) ) & |
---|
| 146 | & + ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) ) * ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) ) & |
---|
| 147 | & + ( un(ji ,jj-1,jk) + un(ji ,jj+1,jk) ) * ( un(ji ,jj-1,jk) + un(ji ,jj+1,jk) ) |
---|
| 148 | ! |
---|
| 149 | zv = 8._wp * ( vn(ji ,jj-1,jk) * vn(ji ,jj-1,jk) & |
---|
| 150 | & + vn(ji ,jj ,jk) * vn(ji ,jj ,jk) ) & |
---|
| 151 | & + ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) ) * ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) ) & |
---|
| 152 | & + ( vn(ji-1,jj ,jk) + vn(ji+1,jj ,jk) ) * ( vn(ji-1,jj ,jk) + vn(ji+1,jj ,jk) ) |
---|
[5328] | 153 | zhke(ji,jj,jk) = r1_48 * ( zv + zu ) |
---|
| 154 | END DO |
---|
[5321] | 155 | END DO |
---|
[5328] | 156 | END DO |
---|
[10996] | 157 | IF (ln_bdy) THEN |
---|
| 158 | ! Maria Luneva & Fred Wobus: July-2016 |
---|
| 159 | ! compensate for lack of turbulent kinetic energy on liquid bdy points |
---|
| 160 | DO ib_bdy = 1, nb_bdy |
---|
| 161 | IF( cn_dyn3d(ib_bdy) /= 'none' ) THEN |
---|
| 162 | igrd = 1 ! compensation null velocity on land at the bdy |
---|
| 163 | DO jb = 1, idx_bdy(ib_bdy)%nblenrim(igrd) |
---|
[11048] | 164 | ji = idx_bdy(ib_bdy)%nbi(jb,igrd) ! maximum extent : from 1 to jpi |
---|
| 165 | jj = idx_bdy(ib_bdy)%nbj(jb,igrd) ! maximum extent : from 1 to jpj |
---|
| 166 | IF( ji == 1 .OR. ji == jpi .OR. jj == 1 .OR. jj == jpj ) CYCLE ! to remove |
---|
[10996] | 167 | DO jk = 1, jpkm1 |
---|
| 168 | zhke(ji,jj,jk) = 0._wp |
---|
| 169 | zweightu = 8._wp * ( umask(ji-1,jj ,jk) + umask(ji ,jj ,jk) ) & |
---|
| 170 | & + 2._wp * ( umask(ji-1,jj-1,jk) + umask(ji-1,jj+1,jk) + umask(ji ,jj-1,jk) + umask(ji ,jj+1,jk) ) |
---|
| 171 | zweightv = 8._wp * ( vmask(ji ,jj-1,jk) + vmask(ji ,jj-1,jk) ) & |
---|
| 172 | & + 2._wp * ( vmask(ji-1,jj-1,jk) + vmask(ji+1,jj-1,jk) + vmask(ji-1,jj ,jk) + vmask(ji+1,jj ,jk) ) |
---|
| 173 | zu = 8._wp * ( un(ji-1,jj ,jk) * un(ji-1,jj ,jk) & |
---|
| 174 | & + un(ji ,jj ,jk) * un(ji ,jj ,jk) ) & |
---|
| 175 | & + ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) ) * ( un(ji-1,jj-1,jk) + un(ji-1,jj+1,jk) ) & |
---|
| 176 | & + ( un(ji ,jj-1,jk) + un(ji ,jj+1,jk) ) * ( un(ji ,jj-1,jk) + un(ji ,jj+1,jk) ) |
---|
| 177 | zv = 8._wp * ( vn(ji ,jj-1,jk) * vn(ji ,jj-1,jk) & |
---|
| 178 | & + vn(ji ,jj ,jk) * vn(ji ,jj ,jk) ) & |
---|
| 179 | & + ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) ) * ( vn(ji-1,jj-1,jk) + vn(ji+1,jj-1,jk) ) & |
---|
| 180 | & + ( vn(ji-1,jj ,jk) + vn(ji+1,jj ,jk) ) * ( vn(ji-1,jj ,jk) + vn(ji+1,jj ,jk) ) |
---|
| 181 | IF( zweightu > 0._wp ) zhke(ji,jj,jk) = zhke(ji,jj,jk) + zu / ( 2._wp * zweightu ) |
---|
| 182 | IF( zweightv > 0._wp ) zhke(ji,jj,jk) = zhke(ji,jj,jk) + zv / ( 2._wp * zweightv ) |
---|
| 183 | END DO |
---|
| 184 | END DO |
---|
| 185 | END IF |
---|
| 186 | END DO |
---|
| 187 | END IF |
---|
[10425] | 188 | CALL lbc_lnk( 'dynkeg', zhke, 'T', 1. ) |
---|
[5321] | 189 | ! |
---|
[10996] | 190 | END SELECT |
---|
[5328] | 191 | ! |
---|
| 192 | DO jk = 1, jpkm1 !== grad( KE ) added to the general momentum trends ==! |
---|
[5321] | 193 | DO jj = 2, jpjm1 |
---|
[3] | 194 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[5328] | 195 | ua(ji,jj,jk) = ua(ji,jj,jk) - ( zhke(ji+1,jj ,jk) - zhke(ji,jj,jk) ) / e1u(ji,jj) |
---|
| 196 | va(ji,jj,jk) = va(ji,jj,jk) - ( zhke(ji ,jj+1,jk) - zhke(ji,jj,jk) ) / e2v(ji,jj) |
---|
| 197 | END DO |
---|
[3] | 198 | END DO |
---|
[5321] | 199 | END DO |
---|
| 200 | ! |
---|
| 201 | IF( l_trddyn ) THEN ! save the Kinetic Energy trends for diagnostic |
---|
[7753] | 202 | ztrdu(:,:,:) = ua(:,:,:) - ztrdu(:,:,:) |
---|
| 203 | ztrdv(:,:,:) = va(:,:,:) - ztrdv(:,:,:) |
---|
[4990] | 204 | CALL trd_dyn( ztrdu, ztrdv, jpdyn_keg, kt ) |
---|
[9019] | 205 | DEALLOCATE( ztrdu , ztrdv ) |
---|
[216] | 206 | ENDIF |
---|
[503] | 207 | ! |
---|
| 208 | IF(ln_ctl) CALL prt_ctl( tab3d_1=ua, clinfo1=' keg - Ua: ', mask1=umask, & |
---|
| 209 | & tab3d_2=va, clinfo2= ' Va: ', mask2=vmask, clinfo3='dyn' ) |
---|
| 210 | ! |
---|
[9019] | 211 | IF( ln_timing ) CALL timing_stop('dyn_keg') |
---|
[2715] | 212 | ! |
---|
[3] | 213 | END SUBROUTINE dyn_keg |
---|
| 214 | |
---|
| 215 | !!====================================================================== |
---|
| 216 | END MODULE dynkeg |
---|