[12624] | 1 | MODULE dynatfqco |
---|
[1502] | 2 | !!========================================================================= |
---|
[12624] | 3 | !! *** MODULE dynatfqco *** |
---|
[11050] | 4 | !! Ocean dynamics: time filtering |
---|
[1502] | 5 | !!========================================================================= |
---|
[1438] | 6 | !! History : OPA ! 1987-02 (P. Andrich, D. L Hostis) Original code |
---|
| 7 | !! ! 1990-10 (C. Levy, G. Madec) |
---|
| 8 | !! 7.0 ! 1993-03 (M. Guyon) symetrical conditions |
---|
| 9 | !! 8.0 ! 1997-02 (G. Madec & M. Imbard) opa, release 8.0 |
---|
| 10 | !! 8.2 ! 1997-04 (A. Weaver) Euler forward step |
---|
| 11 | !! - ! 1997-06 (G. Madec) lateral boudary cond., lbc routine |
---|
| 12 | !! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and module |
---|
| 13 | !! - ! 2002-10 (C. Talandier, A-M. Treguier) Open boundary cond. |
---|
| 14 | !! 2.0 ! 2005-11 (V. Garnier) Surface pressure gradient organization |
---|
[12581] | 15 | !! 2.3 ! 2007-07 (D. Storkey) Calls to BDY routines. |
---|
[1502] | 16 | !! 3.2 ! 2009-06 (G. Madec, R.Benshila) re-introduce the vvl option |
---|
[12724] | 17 | !! 3.3 ! 2010-09 D. Storkey, E.O'Dea) Bug fix for BDY module |
---|
[2723] | 18 | !! 3.3 ! 2011-03 (P. Oddo) Bug fix for time-splitting+(BDY-OBC) and not VVL |
---|
[4292] | 19 | !! 3.5 ! 2013-07 (J. Chanut) Compliant with time splitting changes |
---|
[6140] | 20 | !! 3.6 ! 2014-04 (G. Madec) add the diagnostic of the time filter trends |
---|
[5930] | 21 | !! 3.7 ! 2015-11 (J. Chanut) Free surface simplification |
---|
[12581] | 22 | !! 4.1 ! 2019-08 (A. Coward, D. Storkey) Rename dynnxt.F90 -> dynatfLF.F90. Now just does time filtering. |
---|
[1502] | 23 | !!------------------------------------------------------------------------- |
---|
[12581] | 24 | |
---|
[11050] | 25 | !!---------------------------------------------------------------------------------------------- |
---|
[12624] | 26 | !! dyn_atf_qco : apply Asselin time filtering to "now" velocities and vertical scale factors |
---|
[11050] | 27 | !!---------------------------------------------------------------------------------------------- |
---|
[6140] | 28 | USE oce ! ocean dynamics and tracers |
---|
| 29 | USE dom_oce ! ocean space and time domain |
---|
| 30 | USE sbc_oce ! Surface boundary condition: ocean fields |
---|
[9023] | 31 | USE sbcrnf ! river runoffs |
---|
[6140] | 32 | USE phycst ! physical constants |
---|
| 33 | USE dynadv ! dynamics: vector invariant versus flux form |
---|
| 34 | USE dynspg_ts ! surface pressure gradient: split-explicit scheme |
---|
| 35 | USE domvvl ! variable volume |
---|
[7646] | 36 | USE bdy_oce , ONLY: ln_bdy |
---|
[6140] | 37 | USE bdydta ! ocean open boundary conditions |
---|
| 38 | USE bdydyn ! ocean open boundary conditions |
---|
| 39 | USE bdyvol ! ocean open boundary condition (bdy_vol routines) |
---|
| 40 | USE trd_oce ! trends: ocean variables |
---|
| 41 | USE trddyn ! trend manager: dynamics |
---|
| 42 | USE trdken ! trend manager: kinetic energy |
---|
[12150] | 43 | USE isf_oce , ONLY: ln_isf ! ice shelf |
---|
[12581] | 44 | USE isfdynatf , ONLY: isf_dynatf ! ice shelf volume filter correction subroutine |
---|
[4990] | 45 | ! |
---|
[6140] | 46 | USE in_out_manager ! I/O manager |
---|
| 47 | USE iom ! I/O manager library |
---|
| 48 | USE lbclnk ! lateral boundary condition (or mpp link) |
---|
| 49 | USE lib_mpp ! MPP library |
---|
| 50 | USE prtctl ! Print control |
---|
| 51 | USE timing ! Timing |
---|
[2528] | 52 | #if defined key_agrif |
---|
[9570] | 53 | USE agrif_oce_interp |
---|
[11050] | 54 | #endif |
---|
[3] | 55 | |
---|
| 56 | IMPLICIT NONE |
---|
| 57 | PRIVATE |
---|
| 58 | |
---|
[12624] | 59 | PUBLIC dyn_atf_qco ! routine called by step.F90 |
---|
[1438] | 60 | |
---|
[12340] | 61 | !! * Substitutions |
---|
| 62 | # include "do_loop_substitute.h90" |
---|
[12624] | 63 | # include "domzgr_substitute.h90" |
---|
[2715] | 64 | !!---------------------------------------------------------------------- |
---|
[9598] | 65 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[12581] | 66 | !! $Id$ |
---|
[10068] | 67 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[2715] | 68 | !!---------------------------------------------------------------------- |
---|
[3] | 69 | CONTAINS |
---|
| 70 | |
---|
[12656] | 71 | SUBROUTINE dyn_atf_qco ( kt, Kbb, Kmm, Kaa, puu, pvv ) |
---|
[3] | 72 | !!---------------------------------------------------------------------- |
---|
[12624] | 73 | !! *** ROUTINE dyn_atf_qco *** |
---|
[12581] | 74 | !! |
---|
| 75 | !! ** Purpose : Finalize after horizontal velocity. Apply the boundary |
---|
[11475] | 76 | !! condition on the after velocity and apply the Asselin time |
---|
| 77 | !! filter to the now fields. |
---|
[3] | 78 | !! |
---|
[5930] | 79 | !! ** Method : * Ensure after velocities transport matches time splitting |
---|
| 80 | !! estimate (ln_dynspg_ts=T) |
---|
[3] | 81 | !! |
---|
[12581] | 82 | !! * Apply lateral boundary conditions on after velocity |
---|
[1502] | 83 | !! at the local domain boundaries through lbc_lnk call, |
---|
[7646] | 84 | !! at the one-way open boundaries (ln_bdy=T), |
---|
[4990] | 85 | !! at the AGRIF zoom boundaries (lk_agrif=T) |
---|
[3] | 86 | !! |
---|
[11475] | 87 | !! * Apply the Asselin time filter to the now fields |
---|
[1502] | 88 | !! arrays to start the next time step: |
---|
[12581] | 89 | !! (puu(Kmm),pvv(Kmm)) = (puu(Kmm),pvv(Kmm)) |
---|
[11475] | 90 | !! + atfp [ (puu(Kbb),pvv(Kbb)) + (puu(Kaa),pvv(Kaa)) - 2 (puu(Kmm),pvv(Kmm)) ] |
---|
[6140] | 91 | !! Note that with flux form advection and non linear free surface, |
---|
| 92 | !! the time filter is applied on thickness weighted velocity. |
---|
[12581] | 93 | !! As a result, dyn_atf_lf MUST be called after tra_atf. |
---|
[1502] | 94 | !! |
---|
[12581] | 95 | !! ** Action : puu(Kmm),pvv(Kmm) filtered now horizontal velocity |
---|
[3] | 96 | !!---------------------------------------------------------------------- |
---|
[11050] | 97 | INTEGER , INTENT(in ) :: kt ! ocean time-step index |
---|
| 98 | INTEGER , INTENT(in ) :: Kbb, Kmm, Kaa ! before and after time level indices |
---|
| 99 | REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) :: puu, pvv ! velocities to be time filtered |
---|
[2715] | 100 | ! |
---|
[3] | 101 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
[11050] | 102 | REAL(wp) :: zue3a, zue3n, zue3b, zcoef ! local scalars |
---|
| 103 | REAL(wp) :: zve3a, zve3n, zve3b, z1_2dt ! - - |
---|
[12581] | 104 | REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: zue, zve |
---|
| 105 | REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zua, zva |
---|
[1502] | 106 | !!---------------------------------------------------------------------- |
---|
[3294] | 107 | ! |
---|
[12624] | 108 | IF( ln_timing ) CALL timing_start('dyn_atf_qco') |
---|
[9019] | 109 | IF( ln_dynspg_ts ) ALLOCATE( zue(jpi,jpj) , zve(jpi,jpj) ) |
---|
| 110 | IF( l_trddyn ) ALLOCATE( zua(jpi,jpj,jpk) , zva(jpi,jpj,jpk) ) |
---|
[3294] | 111 | ! |
---|
[3] | 112 | IF( kt == nit000 ) THEN |
---|
| 113 | IF(lwp) WRITE(numout,*) |
---|
[12624] | 114 | IF(lwp) WRITE(numout,*) 'dyn_atf_qco : Asselin time filtering' |
---|
[3] | 115 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
| 116 | ENDIF |
---|
[3294] | 117 | ! |
---|
[4990] | 118 | IF( l_trddyn ) THEN ! prepare the atf trend computation + some diagnostics |
---|
| 119 | ! |
---|
| 120 | ! ! Kinetic energy and Conversion |
---|
[11050] | 121 | IF( ln_KE_trd ) CALL trd_dyn( puu(:,:,:,Kaa), pvv(:,:,:,Kaa), jpdyn_ken, kt, Kmm ) |
---|
[4990] | 122 | ! |
---|
| 123 | IF( ln_dyn_trd ) THEN ! 3D output: total momentum trends |
---|
[12724] | 124 | zua(:,:,:) = ( puu(:,:,:,Kaa) - puu(:,:,:,Kbb) ) * r1_Dt |
---|
| 125 | zva(:,:,:) = ( pvv(:,:,:,Kaa) - pvv(:,:,:,Kbb) ) * r1_Dt |
---|
[4990] | 126 | CALL iom_put( "utrd_tot", zua ) ! total momentum trends, except the asselin time filter |
---|
| 127 | CALL iom_put( "vtrd_tot", zva ) |
---|
| 128 | ENDIF |
---|
| 129 | ! |
---|
[11050] | 130 | zua(:,:,:) = puu(:,:,:,Kmm) ! save the now velocity before the asselin filter |
---|
| 131 | zva(:,:,:) = pvv(:,:,:,Kmm) ! (caution: there will be a shift by 1 timestep in the |
---|
[7753] | 132 | ! ! computation of the asselin filter trends) |
---|
[4990] | 133 | ENDIF |
---|
| 134 | |
---|
[1438] | 135 | ! Time filter and swap of dynamics arrays |
---|
| 136 | ! ------------------------------------------ |
---|
[12581] | 137 | |
---|
[12724] | 138 | IF( .NOT. l_1st_euler ) THEN !* Leap-Frog : Asselin time filter |
---|
[2528] | 139 | ! ! =============! |
---|
[6140] | 140 | IF( ln_linssh ) THEN ! Fixed volume ! |
---|
[2528] | 141 | ! ! =============! |
---|
[12340] | 142 | DO_3D_11_11( 1, jpkm1 ) |
---|
[12724] | 143 | puu(ji,jj,jk,Kmm) = puu(ji,jj,jk,Kmm) + rn_atfp * ( puu(ji,jj,jk,Kbb) - 2._wp * puu(ji,jj,jk,Kmm) + puu(ji,jj,jk,Kaa) ) |
---|
| 144 | pvv(ji,jj,jk,Kmm) = pvv(ji,jj,jk,Kmm) + rn_atfp * ( pvv(ji,jj,jk,Kbb) - 2._wp * pvv(ji,jj,jk,Kmm) + pvv(ji,jj,jk,Kaa) ) |
---|
[12340] | 145 | END_3D |
---|
[2528] | 146 | ! ! ================! |
---|
| 147 | ELSE ! Variable volume ! |
---|
| 148 | ! ! ================! |
---|
| 149 | ! |
---|
[6140] | 150 | IF( ln_dynadv_vec ) THEN ! Asselin filter applied on velocity |
---|
| 151 | ! Before filtered scale factor at (u/v)-points |
---|
[12340] | 152 | DO_3D_11_11( 1, jpkm1 ) |
---|
[12724] | 153 | puu(ji,jj,jk,Kmm) = puu(ji,jj,jk,Kmm) + rn_atfp * ( puu(ji,jj,jk,Kbb) - 2._wp * puu(ji,jj,jk,Kmm) + puu(ji,jj,jk,Kaa) ) |
---|
| 154 | pvv(ji,jj,jk,Kmm) = pvv(ji,jj,jk,Kmm) + rn_atfp * ( pvv(ji,jj,jk,Kbb) - 2._wp * pvv(ji,jj,jk,Kmm) + pvv(ji,jj,jk,Kaa) ) |
---|
[12340] | 155 | END_3D |
---|
[2528] | 156 | ! |
---|
[6140] | 157 | ELSE ! Asselin filter applied on thickness weighted velocity |
---|
| 158 | ! |
---|
[12340] | 159 | DO_3D_11_11( 1, jpkm1 ) |
---|
[12624] | 160 | zue3a = ( 1._wp + r3u(ji,jj,Kaa) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kaa) |
---|
| 161 | zve3a = ( 1._wp + r3v(ji,jj,Kaa) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kaa) |
---|
| 162 | zue3n = ( 1._wp + r3u(ji,jj,Kmm) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kmm) |
---|
| 163 | zve3n = ( 1._wp + r3v(ji,jj,Kmm) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kmm) |
---|
| 164 | zue3b = ( 1._wp + r3u(ji,jj,Kbb) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kbb) |
---|
| 165 | zve3b = ( 1._wp + r3v(ji,jj,Kbb) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kbb) |
---|
[12581] | 166 | ! ! filtered scale factor at U-,V-points |
---|
[12732] | 167 | puu(ji,jj,jk,Kmm) = ( zue3n + rn_atfp * ( zue3b - 2._wp * zue3n + zue3a ) ) / ( 1._wp + r3u_f(ji,jj)*umask(ji,jj,jk) ) |
---|
| 168 | pvv(ji,jj,jk,Kmm) = ( zve3n + rn_atfp * ( zve3b - 2._wp * zve3n + zve3a ) ) / ( 1._wp + r3v_f(ji,jj)*vmask(ji,jj,jk) ) |
---|
[12340] | 169 | END_3D |
---|
[6140] | 170 | ! |
---|
[2528] | 171 | ENDIF |
---|
| 172 | ! |
---|
[3] | 173 | ENDIF |
---|
[2528] | 174 | ! |
---|
[6140] | 175 | IF( ln_dynspg_ts .AND. ln_bt_fw ) THEN |
---|
[11050] | 176 | ! Revert filtered "now" velocities to time split estimate |
---|
[12581] | 177 | ! Doing it here also means that asselin filter contribution is removed |
---|
[12624] | 178 | ! zue(:,:) = pe3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
| 179 | ! zve(:,:) = pe3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
| 180 | ! DO jk = 2, jpkm1 |
---|
| 181 | ! zue(:,:) = zue(:,:) + pe3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
| 182 | ! zve(:,:) = zve(:,:) + pe3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
| 183 | ! END DO |
---|
| 184 | zue(:,:) = e3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
| 185 | zve(:,:) = e3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
[4990] | 186 | DO jk = 2, jpkm1 |
---|
[12624] | 187 | zue(:,:) = zue(:,:) + e3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
| 188 | zve(:,:) = zve(:,:) + e3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
[4370] | 189 | END DO |
---|
| 190 | DO jk = 1, jpkm1 |
---|
[11050] | 191 | puu(:,:,jk,Kmm) = puu(:,:,jk,Kmm) - (zue(:,:) * r1_hu(:,:,Kmm) - uu_b(:,:,Kmm)) * umask(:,:,jk) |
---|
| 192 | pvv(:,:,jk,Kmm) = pvv(:,:,jk,Kmm) - (zve(:,:) * r1_hv(:,:,Kmm) - vv_b(:,:,Kmm)) * vmask(:,:,jk) |
---|
[4292] | 193 | END DO |
---|
| 194 | ENDIF |
---|
| 195 | ! |
---|
[12724] | 196 | ENDIF ! .NOT. l_1st_euler |
---|
[4354] | 197 | ! |
---|
| 198 | ! Set "now" and "before" barotropic velocities for next time step: |
---|
| 199 | ! JC: Would be more clever to swap variables than to make a full vertical |
---|
| 200 | ! integration |
---|
| 201 | ! |
---|
[12624] | 202 | uu_b(:,:,Kaa) = e3u(:,:,1,Kaa) * puu(:,:,1,Kaa) * umask(:,:,1) |
---|
| 203 | uu_b(:,:,Kmm) = e3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
| 204 | vv_b(:,:,Kaa) = e3v(:,:,1,Kaa) * pvv(:,:,1,Kaa) * vmask(:,:,1) |
---|
| 205 | vv_b(:,:,Kmm) = e3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
[6140] | 206 | DO jk = 2, jpkm1 |
---|
[12624] | 207 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) + e3u(:,:,jk,Kaa) * puu(:,:,jk,Kaa) * umask(:,:,jk) |
---|
| 208 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) + e3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
| 209 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) + e3v(:,:,jk,Kaa) * pvv(:,:,jk,Kaa) * vmask(:,:,jk) |
---|
| 210 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) + e3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
[4354] | 211 | END DO |
---|
[11050] | 212 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) * r1_hu(:,:,Kaa) |
---|
| 213 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) * r1_hv(:,:,Kaa) |
---|
| 214 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * r1_hu(:,:,Kmm) |
---|
| 215 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * r1_hv(:,:,Kmm) |
---|
[4354] | 216 | ! |
---|
[6140] | 217 | IF( .NOT.ln_dynspg_ts ) THEN ! output the barotropic currents |
---|
[11050] | 218 | CALL iom_put( "ubar", uu_b(:,:,Kmm) ) |
---|
| 219 | CALL iom_put( "vbar", vv_b(:,:,Kmm) ) |
---|
[6140] | 220 | ENDIF |
---|
[4990] | 221 | IF( l_trddyn ) THEN ! 3D output: asselin filter trends on momentum |
---|
[11050] | 222 | zua(:,:,:) = ( puu(:,:,:,Kmm) - zua(:,:,:) ) * z1_2dt |
---|
| 223 | zva(:,:,:) = ( pvv(:,:,:,Kmm) - zva(:,:,:) ) * z1_2dt |
---|
[10946] | 224 | CALL trd_dyn( zua, zva, jpdyn_atf, kt, Kmm ) |
---|
[4990] | 225 | ENDIF |
---|
| 226 | ! |
---|
[12236] | 227 | IF(sn_cfctl%l_prtctl) CALL prt_ctl( tab3d_1=puu(:,:,:,Kaa), clinfo1=' nxt - puu(:,:,:,Kaa): ', mask1=umask, & |
---|
| 228 | & tab3d_2=pvv(:,:,:,Kaa), clinfo2=' pvv(:,:,:,Kaa): ' , mask2=vmask ) |
---|
[12581] | 229 | ! |
---|
[9019] | 230 | IF( ln_dynspg_ts ) DEALLOCATE( zue, zve ) |
---|
| 231 | IF( l_trddyn ) DEALLOCATE( zua, zva ) |
---|
[12624] | 232 | IF( ln_timing ) CALL timing_stop('dyn_atf_qco') |
---|
[2715] | 233 | ! |
---|
[12624] | 234 | END SUBROUTINE dyn_atf_qco |
---|
[3] | 235 | |
---|
[1502] | 236 | !!========================================================================= |
---|
[12624] | 237 | END MODULE dynatfqco |
---|