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