[3] | 1 | MODULE dynldf_bilap |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE dynldf_bilap *** |
---|
| 4 | !! Ocean dynamics: lateral viscosity trend |
---|
| 5 | !!====================================================================== |
---|
[2715] | 6 | !! History : OPA ! 1990-09 (G. Madec) Original code |
---|
| 7 | !! 4.0 ! 1993-03 (M. Guyon) symetrical conditions (M. Guyon) |
---|
| 8 | !! 6.0 ! 1996-01 (G. Madec) statement function for e3 |
---|
| 9 | !! 8.0 ! 1997-07 (G. Madec) lbc calls |
---|
| 10 | !! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and module |
---|
| 11 | !! 2.0 ! 2004-08 (C. Talandier) New trends organization |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
[3] | 13 | |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
| 15 | !! dyn_ldf_bilap : update the momentum trend with the lateral diffusion |
---|
| 16 | !! using an iso-level bilaplacian operator |
---|
| 17 | !!---------------------------------------------------------------------- |
---|
| 18 | USE oce ! ocean dynamics and tracers |
---|
| 19 | USE dom_oce ! ocean space and time domain |
---|
| 20 | USE ldfdyn_oce ! ocean dynamics: lateral physics |
---|
[4990] | 21 | ! |
---|
[3] | 22 | USE in_out_manager ! I/O manager |
---|
| 23 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
[3294] | 24 | USE wrk_nemo ! Memory Allocation |
---|
| 25 | USE timing ! Timing |
---|
[3] | 26 | |
---|
[11738] | 27 | USE yomhook, ONLY: lhook, dr_hook |
---|
| 28 | USE parkind1, ONLY: jprb, jpim |
---|
| 29 | |
---|
[3] | 30 | IMPLICIT NONE |
---|
| 31 | PRIVATE |
---|
| 32 | |
---|
[2715] | 33 | PUBLIC dyn_ldf_bilap ! called by step.F90 |
---|
[3] | 34 | |
---|
| 35 | !! * Substitutions |
---|
| 36 | # include "domzgr_substitute.h90" |
---|
| 37 | # include "ldfdyn_substitute.h90" |
---|
| 38 | # include "vectopt_loop_substitute.h90" |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
[2528] | 40 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[6486] | 41 | !! $Id$ |
---|
[2715] | 42 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[3] | 43 | !!---------------------------------------------------------------------- |
---|
| 44 | CONTAINS |
---|
| 45 | |
---|
| 46 | SUBROUTINE dyn_ldf_bilap( kt ) |
---|
| 47 | !!---------------------------------------------------------------------- |
---|
| 48 | !! *** ROUTINE dyn_ldf_bilap *** |
---|
| 49 | !! |
---|
| 50 | !! ** Purpose : Compute the before trend of the lateral momentum |
---|
| 51 | !! diffusion and add it to the general trend of momentum equation. |
---|
| 52 | !! |
---|
| 53 | !! ** Method : The before horizontal momentum diffusion trend is a |
---|
| 54 | !! bi-harmonic operator (bilaplacian type) which separates the |
---|
| 55 | !! divergent and rotational parts of the flow. |
---|
| 56 | !! Its horizontal components are computed as follow: |
---|
| 57 | !! laplacian: |
---|
| 58 | !! zlu = 1/e1u di[ hdivb ] - 1/(e2u*e3u) dj-1[ e3f rotb ] |
---|
| 59 | !! zlv = 1/e2v dj[ hdivb ] + 1/(e1v*e3v) di-1[ e3f rotb ] |
---|
| 60 | !! third derivative: |
---|
| 61 | !! * multiply by the eddy viscosity coef. at u-, v-point, resp. |
---|
| 62 | !! zlu = ahmu * zlu |
---|
| 63 | !! zlv = ahmv * zlv |
---|
| 64 | !! * curl and divergence of the laplacian |
---|
| 65 | !! zuf = 1/(e1f*e2f) ( di[e2v zlv] - dj[e1u zlu] ) |
---|
| 66 | !! zut = 1/(e1t*e2t*e3t) ( di[e2u*e3u zlu] + dj[e1v*e3v zlv] ) |
---|
| 67 | !! bilaplacian: |
---|
| 68 | !! diffu = 1/e1u di[ zut ] - 1/(e2u*e3u) dj-1[ e3f zuf ] |
---|
| 69 | !! diffv = 1/e2v dj[ zut ] + 1/(e1v*e3v) di-1[ e3f zuf ] |
---|
[455] | 70 | !! If ln_sco=F and ln_zps=F, the vertical scale factors in the |
---|
[3] | 71 | !! rotational part of the diffusion are simplified |
---|
| 72 | !! Add this before trend to the general trend (ua,va): |
---|
| 73 | !! (ua,va) = (ua,va) + (diffu,diffv) |
---|
| 74 | !! |
---|
| 75 | !! ** Action : - Update (ua,va) with the before iso-level biharmonic |
---|
| 76 | !! mixing trend. |
---|
| 77 | !!---------------------------------------------------------------------- |
---|
[2715] | 78 | INTEGER, INTENT(in) :: kt ! ocean time-step index |
---|
| 79 | ! |
---|
| 80 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
| 81 | REAL(wp) :: zua, zva, zbt, ze2u, ze2v ! temporary scalar |
---|
[3294] | 82 | REAL(wp), POINTER, DIMENSION(:,: ) :: zcu, zcv |
---|
| 83 | REAL(wp), POINTER, DIMENSION(:,:,:) :: zuf, zut, zlu, zlv |
---|
[11738] | 84 | INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0 |
---|
| 85 | INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1 |
---|
| 86 | REAL(KIND=jprb) :: zhook_handle |
---|
| 87 | |
---|
| 88 | CHARACTER(LEN=*), PARAMETER :: RoutineName='DYN_LDF_BILAP' |
---|
| 89 | |
---|
| 90 | IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle) |
---|
| 91 | |
---|
[3] | 92 | !!---------------------------------------------------------------------- |
---|
[3294] | 93 | ! |
---|
| 94 | IF( nn_timing == 1 ) CALL timing_start('dyn_ldf_bilap') |
---|
| 95 | ! |
---|
| 96 | CALL wrk_alloc( jpi, jpj, zcu, zcv ) |
---|
| 97 | CALL wrk_alloc( jpi, jpj, jpk, zuf, zut, zlu, zlv ) |
---|
| 98 | ! |
---|
[2715] | 99 | IF( kt == nit000 .AND. lwp ) THEN |
---|
| 100 | WRITE(numout,*) |
---|
| 101 | WRITE(numout,*) 'dyn_ldf_bilap : iso-level bilaplacian operator' |
---|
| 102 | WRITE(numout,*) '~~~~~~~~~~~~~' |
---|
| 103 | ENDIF |
---|
| 104 | |
---|
[474] | 105 | !!bug gm this should be enough |
---|
| 106 | !!$ zuf(:,:,jpk) = 0.e0 |
---|
| 107 | !!$ zut(:,:,jpk) = 0.e0 |
---|
| 108 | !!$ zlu(:,:,jpk) = 0.e0 |
---|
| 109 | !!$ zlv(:,:,jpk) = 0.e0 |
---|
[2715] | 110 | zuf(:,:,:) = 0._wp |
---|
| 111 | zut(:,:,:) = 0._wp |
---|
| 112 | zlu(:,:,:) = 0._wp |
---|
| 113 | zlv(:,:,:) = 0._wp |
---|
[474] | 114 | |
---|
[3] | 115 | ! ! =============== |
---|
| 116 | DO jk = 1, jpkm1 ! Horizontal slab |
---|
| 117 | ! ! =============== |
---|
| 118 | ! Laplacian |
---|
| 119 | ! --------- |
---|
| 120 | |
---|
[455] | 121 | IF( ln_sco .OR. ln_zps ) THEN ! s-coordinate or z-coordinate with partial steps |
---|
[474] | 122 | zuf(:,:,jk) = rotb(:,:,jk) * fse3f(:,:,jk) |
---|
[3] | 123 | DO jj = 2, jpjm1 |
---|
| 124 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[474] | 125 | zlu(ji,jj,jk) = - ( zuf(ji,jj,jk) - zuf(ji,jj-1,jk) ) / ( e2u(ji,jj) * fse3u(ji,jj,jk) ) & |
---|
[3] | 126 | & + ( hdivb(ji+1,jj,jk) - hdivb(ji,jj,jk) ) / e1u(ji,jj) |
---|
| 127 | |
---|
[474] | 128 | zlv(ji,jj,jk) = + ( zuf(ji,jj,jk) - zuf(ji-1,jj,jk) ) / ( e1v(ji,jj) * fse3v(ji,jj,jk) ) & |
---|
[3] | 129 | & + ( hdivb(ji,jj+1,jk) - hdivb(ji,jj,jk) ) / e2v(ji,jj) |
---|
| 130 | END DO |
---|
| 131 | END DO |
---|
[455] | 132 | ELSE ! z-coordinate - full step |
---|
[3] | 133 | DO jj = 2, jpjm1 |
---|
| 134 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
[474] | 135 | zlu(ji,jj,jk) = - ( rotb (ji ,jj,jk) - rotb (ji,jj-1,jk) ) / e2u(ji,jj) & |
---|
[3] | 136 | & + ( hdivb(ji+1,jj,jk) - hdivb(ji,jj ,jk) ) / e1u(ji,jj) |
---|
| 137 | |
---|
[474] | 138 | zlv(ji,jj,jk) = + ( rotb (ji,jj ,jk) - rotb (ji-1,jj,jk) ) / e1v(ji,jj) & |
---|
[3] | 139 | & + ( hdivb(ji,jj+1,jk) - hdivb(ji ,jj,jk) ) / e2v(ji,jj) |
---|
| 140 | END DO |
---|
| 141 | END DO |
---|
| 142 | ENDIF |
---|
[2715] | 143 | END DO |
---|
| 144 | CALL lbc_lnk( zlu, 'U', -1. ) ; CALL lbc_lnk( zlv, 'V', -1. ) ! Boundary conditions |
---|
[3] | 145 | |
---|
| 146 | |
---|
[474] | 147 | DO jk = 1, jpkm1 |
---|
| 148 | |
---|
[3] | 149 | ! Third derivative |
---|
| 150 | ! ---------------- |
---|
| 151 | |
---|
| 152 | ! Multiply by the eddy viscosity coef. (at u- and v-points) |
---|
[3634] | 153 | zlu(:,:,jk) = zlu(:,:,jk) * ( fsahmu(:,:,jk) * (1-nkahm_smag) + nkahm_smag) |
---|
| 154 | |
---|
| 155 | zlv(:,:,jk) = zlv(:,:,jk) * ( fsahmv(:,:,jk) * (1-nkahm_smag) + nkahm_smag) |
---|
[3] | 156 | |
---|
| 157 | ! Contravariant "laplacian" |
---|
[474] | 158 | zcu(:,:) = e1u(:,:) * zlu(:,:,jk) |
---|
| 159 | zcv(:,:) = e2v(:,:) * zlv(:,:,jk) |
---|
[3] | 160 | |
---|
| 161 | ! Laplacian curl ( * e3f if s-coordinates or z-coordinate with partial steps) |
---|
| 162 | DO jj = 1, jpjm1 |
---|
| 163 | DO ji = 1, fs_jpim1 ! vector opt. |
---|
[474] | 164 | zuf(ji,jj,jk) = fmask(ji,jj,jk) * ( zcv(ji+1,jj ) - zcv(ji,jj) & |
---|
[3] | 165 | & - zcu(ji ,jj+1) + zcu(ji,jj) ) & |
---|
| 166 | & * fse3f(ji,jj,jk) / ( e1f(ji,jj)*e2f(ji,jj) ) |
---|
| 167 | END DO |
---|
| 168 | END DO |
---|
| 169 | |
---|
| 170 | ! Laplacian Horizontal fluxes |
---|
| 171 | DO jj = 1, jpjm1 |
---|
| 172 | DO ji = 1, fs_jpim1 ! vector opt. |
---|
[474] | 173 | zlu(ji,jj,jk) = e2u(ji,jj) * fse3u(ji,jj,jk) * zlu(ji,jj,jk) |
---|
| 174 | zlv(ji,jj,jk) = e1v(ji,jj) * fse3v(ji,jj,jk) * zlv(ji,jj,jk) |
---|
[3] | 175 | END DO |
---|
| 176 | END DO |
---|
| 177 | |
---|
| 178 | ! Laplacian divergence |
---|
| 179 | DO jj = 2, jpj |
---|
| 180 | DO ji = fs_2, jpi ! vector opt. |
---|
| 181 | zbt = e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) |
---|
[474] | 182 | zut(ji,jj,jk) = ( zlu(ji,jj,jk) - zlu(ji-1,jj ,jk) & |
---|
| 183 | & + zlv(ji,jj,jk) - zlv(ji ,jj-1,jk) ) / zbt |
---|
[3] | 184 | END DO |
---|
| 185 | END DO |
---|
[474] | 186 | END DO |
---|
[3] | 187 | |
---|
| 188 | |
---|
[235] | 189 | ! boundary conditions on the laplacian curl and div (zuf,zut) |
---|
[474] | 190 | !!bug gm no need to do this 2 following lbc... |
---|
[235] | 191 | CALL lbc_lnk( zuf, 'F', 1. ) |
---|
| 192 | CALL lbc_lnk( zut, 'T', 1. ) |
---|
[3] | 193 | |
---|
[474] | 194 | DO jk = 1, jpkm1 |
---|
| 195 | |
---|
[3] | 196 | ! Bilaplacian |
---|
| 197 | ! ----------- |
---|
| 198 | |
---|
| 199 | DO jj = 2, jpjm1 |
---|
| 200 | DO ji = fs_2, fs_jpim1 ! vector opt. |
---|
| 201 | ze2u = e2u(ji,jj) * fse3u(ji,jj,jk) |
---|
| 202 | ze2v = e1v(ji,jj) * fse3v(ji,jj,jk) |
---|
| 203 | ! horizontal biharmonic diffusive trends |
---|
[474] | 204 | zua = - ( zuf(ji ,jj,jk) - zuf(ji,jj-1,jk) ) / ze2u & |
---|
| 205 | & + ( zut(ji+1,jj,jk) - zut(ji,jj ,jk) ) / e1u(ji,jj) |
---|
[3] | 206 | |
---|
[474] | 207 | zva = + ( zuf(ji,jj ,jk) - zuf(ji-1,jj,jk) ) / ze2v & |
---|
| 208 | & + ( zut(ji,jj+1,jk) - zut(ji ,jj,jk) ) / e2v(ji,jj) |
---|
[3] | 209 | ! add it to the general momentum trends |
---|
[3634] | 210 | ua(ji,jj,jk) = ua(ji,jj,jk) + zua * ( fsahmu(ji,jj,jk)*nkahm_smag +(1 -nkahm_smag )) |
---|
| 211 | va(ji,jj,jk) = va(ji,jj,jk) + zva * ( fsahmv(ji,jj,jk)*nkahm_smag +(1 -nkahm_smag )) |
---|
[3] | 212 | END DO |
---|
| 213 | END DO |
---|
| 214 | |
---|
| 215 | ! ! =============== |
---|
| 216 | END DO ! End of slab |
---|
| 217 | ! ! =============== |
---|
[3294] | 218 | CALL wrk_dealloc( jpi, jpj, zcu, zcv ) |
---|
| 219 | CALL wrk_dealloc( jpi, jpj, jpk, zuf, zut, zlu, zlv ) |
---|
[2715] | 220 | ! |
---|
[3294] | 221 | IF( nn_timing == 1 ) CALL timing_stop('dyn_ldf_bilap') |
---|
| 222 | ! |
---|
[11738] | 223 | IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle) |
---|
[3] | 224 | END SUBROUTINE dyn_ldf_bilap |
---|
| 225 | |
---|
| 226 | !!====================================================================== |
---|
| 227 | END MODULE dynldf_bilap |
---|