1 | MODULE dynatf_qco |
---|
2 | !!========================================================================= |
---|
3 | !! *** MODULE dynatf_qco *** |
---|
4 | !! Ocean dynamics: time filtering |
---|
5 | !!========================================================================= |
---|
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 |
---|
15 | !! 2.3 ! 2007-07 (D. Storkey) Calls to BDY routines. |
---|
16 | !! 3.2 ! 2009-06 (G. Madec, R.Benshila) re-introduce the vvl option |
---|
17 | !! 3.3 ! 2010-09 D. Storkey, E.O'Dea) Bug fix for BDY module |
---|
18 | !! 3.3 ! 2011-03 (P. Oddo) Bug fix for time-splitting+(BDY-OBC) and not VVL |
---|
19 | !! 3.5 ! 2013-07 (J. Chanut) Compliant with time splitting changes |
---|
20 | !! 3.6 ! 2014-04 (G. Madec) add the diagnostic of the time filter trends |
---|
21 | !! 3.7 ! 2015-11 (J. Chanut) Free surface simplification |
---|
22 | !! 4.1 ! 2019-08 (A. Coward, D. Storkey) Rename dynnxt.F90 -> dynatfLF.F90. Now just does time filtering. |
---|
23 | !!------------------------------------------------------------------------- |
---|
24 | |
---|
25 | !!---------------------------------------------------------------------------------------------- |
---|
26 | !! dyn_atf_qco : apply Asselin time filtering to "now" velocities and vertical scale factors |
---|
27 | !!---------------------------------------------------------------------------------------------- |
---|
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 |
---|
31 | USE sbcrnf ! river runoffs |
---|
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 |
---|
36 | USE bdy_oce , ONLY: ln_bdy |
---|
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 |
---|
43 | USE isf_oce , ONLY: ln_isf ! ice shelf |
---|
44 | USE isfdynatf , ONLY: isf_dynatf ! ice shelf volume filter correction subroutine |
---|
45 | ! |
---|
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 |
---|
52 | |
---|
53 | IMPLICIT NONE |
---|
54 | PRIVATE |
---|
55 | |
---|
56 | PUBLIC dyn_atf_qco ! routine called by step.F90 |
---|
57 | |
---|
58 | !! * Substitutions |
---|
59 | # include "do_loop_substitute.h90" |
---|
60 | # include "domzgr_substitute.h90" |
---|
61 | !!---------------------------------------------------------------------- |
---|
62 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
63 | !! $Id$ |
---|
64 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
65 | !!---------------------------------------------------------------------- |
---|
66 | CONTAINS |
---|
67 | |
---|
68 | SUBROUTINE dyn_atf_qco( kt, Kbb, Kmm, Kaa, puu, pvv ) |
---|
69 | !!---------------------------------------------------------------------- |
---|
70 | !! *** ROUTINE dyn_atf_qco *** |
---|
71 | !! |
---|
72 | !! ** Purpose : Finalize after horizontal velocity. Apply the boundary |
---|
73 | !! condition on the after velocity and apply the Asselin time |
---|
74 | !! filter to the now fields. |
---|
75 | !! |
---|
76 | !! ** Method : * Ensure after velocities transport matches time splitting |
---|
77 | !! estimate (ln_dynspg_ts=T) |
---|
78 | !! |
---|
79 | !! * Apply lateral boundary conditions on after velocity |
---|
80 | !! at the local domain boundaries through lbc_lnk call, |
---|
81 | !! at the one-way open boundaries (ln_bdy=T), |
---|
82 | !! at the AGRIF zoom boundaries (lk_agrif=T) |
---|
83 | !! |
---|
84 | !! * Apply the Asselin time filter to the now fields |
---|
85 | !! arrays to start the next time step: |
---|
86 | !! (puu(Kmm),pvv(Kmm)) = (puu(Kmm),pvv(Kmm)) |
---|
87 | !! + atfp [ (puu(Kbb),pvv(Kbb)) + (puu(Kaa),pvv(Kaa)) - 2 (puu(Kmm),pvv(Kmm)) ] |
---|
88 | !! Note that with flux form advection and non linear free surface, |
---|
89 | !! the time filter is applied on thickness weighted velocity. |
---|
90 | !! As a result, dyn_atf_lf MUST be called after tra_atf. |
---|
91 | !! |
---|
92 | !! ** Action : puu(Kmm),pvv(Kmm) filtered now horizontal velocity |
---|
93 | !!---------------------------------------------------------------------- |
---|
94 | INTEGER , INTENT(in ) :: kt ! ocean time-step index |
---|
95 | INTEGER , INTENT(in ) :: Kbb, Kmm, Kaa ! before and after time level indices |
---|
96 | REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) :: puu, pvv ! velocities to be time filtered |
---|
97 | ! |
---|
98 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
99 | REAL(wp) :: zue3a, zue3n, zue3b, zcoef ! local scalars |
---|
100 | REAL(wp) :: zve3a, zve3n, zve3b, z1_2dt ! - - |
---|
101 | REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: zue, zve |
---|
102 | REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: zua, zva |
---|
103 | !!---------------------------------------------------------------------- |
---|
104 | ! |
---|
105 | IF( ln_timing ) CALL timing_start('dyn_atf_qco') |
---|
106 | IF( ln_dynspg_ts ) ALLOCATE( zue(jpi,jpj) , zve(jpi,jpj) ) |
---|
107 | IF( l_trddyn ) ALLOCATE( zua(jpi,jpj,jpk) , zva(jpi,jpj,jpk) ) |
---|
108 | ! |
---|
109 | IF( kt == nit000 ) THEN |
---|
110 | IF(lwp) WRITE(numout,*) |
---|
111 | IF(lwp) WRITE(numout,*) 'dyn_atf_qco : Asselin time filtering' |
---|
112 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
113 | ENDIF |
---|
114 | ! |
---|
115 | IF( l_trddyn ) THEN ! prepare the atf trend computation + some diagnostics |
---|
116 | ! |
---|
117 | ! ! Kinetic energy and Conversion |
---|
118 | IF( ln_KE_trd ) CALL trd_dyn( puu(:,:,:,Kaa), pvv(:,:,:,Kaa), jpdyn_ken, kt, Kmm ) |
---|
119 | ! |
---|
120 | IF( ln_dyn_trd ) THEN ! 3D output: total momentum trends |
---|
121 | zua(:,:,:) = ( puu(:,:,:,Kaa) - puu(:,:,:,Kbb) ) * r1_Dt |
---|
122 | zva(:,:,:) = ( pvv(:,:,:,Kaa) - pvv(:,:,:,Kbb) ) * r1_Dt |
---|
123 | CALL iom_put( "utrd_tot", zua ) ! total momentum trends, except the asselin time filter |
---|
124 | CALL iom_put( "vtrd_tot", zva ) |
---|
125 | ENDIF |
---|
126 | ! |
---|
127 | zua(:,:,:) = puu(:,:,:,Kmm) ! save the now velocity before the asselin filter |
---|
128 | zva(:,:,:) = pvv(:,:,:,Kmm) ! (caution: there will be a shift by 1 timestep in the |
---|
129 | ! ! computation of the asselin filter trends) |
---|
130 | ENDIF |
---|
131 | |
---|
132 | ! Time filter and swap of dynamics arrays |
---|
133 | ! ------------------------------------------ |
---|
134 | |
---|
135 | IF( .NOT. l_1st_euler ) THEN !* Leap-Frog : Asselin time filter |
---|
136 | ! ! =============! |
---|
137 | IF( ln_linssh ) THEN ! Fixed volume ! |
---|
138 | ! ! =============! |
---|
139 | DO_3D( 1, 1, 1, 1, 1, jpkm1 ) |
---|
140 | 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) ) |
---|
141 | 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) ) |
---|
142 | END_3D |
---|
143 | ! ! ================! |
---|
144 | ELSE ! Variable volume ! |
---|
145 | ! ! ================! |
---|
146 | ! |
---|
147 | IF( ln_dynadv_vec ) THEN ! Asselin filter applied on velocity |
---|
148 | ! Before filtered scale factor at (u/v)-points |
---|
149 | DO_3D( 1, 1, 1, 1, 1, jpkm1 ) |
---|
150 | 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) ) |
---|
151 | 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) ) |
---|
152 | END_3D |
---|
153 | ! |
---|
154 | ELSE ! Asselin filter applied on thickness weighted velocity |
---|
155 | ! |
---|
156 | DO_3D( 1, 1, 1, 1, 1, jpkm1 ) |
---|
157 | zue3a = ( 1._wp + r3u(ji,jj,Kaa) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kaa) |
---|
158 | zve3a = ( 1._wp + r3v(ji,jj,Kaa) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kaa) |
---|
159 | zue3n = ( 1._wp + r3u(ji,jj,Kmm) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kmm) |
---|
160 | zve3n = ( 1._wp + r3v(ji,jj,Kmm) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kmm) |
---|
161 | zue3b = ( 1._wp + r3u(ji,jj,Kbb) * umask(ji,jj,jk) ) * puu(ji,jj,jk,Kbb) |
---|
162 | zve3b = ( 1._wp + r3v(ji,jj,Kbb) * vmask(ji,jj,jk) ) * pvv(ji,jj,jk,Kbb) |
---|
163 | ! ! filtered scale factor at U-,V-points |
---|
164 | puu(ji,jj,jk,Kmm) = ( zue3n + rn_atfp * ( zue3b - 2._wp * zue3n + zue3a ) ) / ( 1._wp + r3u_f(ji,jj)*umask(ji,jj,jk) ) |
---|
165 | pvv(ji,jj,jk,Kmm) = ( zve3n + rn_atfp * ( zve3b - 2._wp * zve3n + zve3a ) ) / ( 1._wp + r3v_f(ji,jj)*vmask(ji,jj,jk) ) |
---|
166 | END_3D |
---|
167 | ! |
---|
168 | ENDIF |
---|
169 | ! |
---|
170 | ENDIF |
---|
171 | ! |
---|
172 | IF( ln_dynspg_ts .AND. ln_bt_fw ) THEN |
---|
173 | ! Revert filtered "now" velocities to time split estimate |
---|
174 | ! Doing it here also means that asselin filter contribution is removed |
---|
175 | ! zue(:,:) = pe3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
176 | ! zve(:,:) = pe3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
177 | ! DO jk = 2, jpkm1 |
---|
178 | ! zue(:,:) = zue(:,:) + pe3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
179 | ! zve(:,:) = zve(:,:) + pe3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
180 | ! END DO |
---|
181 | zue(:,:) = e3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
182 | zve(:,:) = e3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
183 | DO jk = 2, jpkm1 |
---|
184 | zue(:,:) = zue(:,:) + e3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
185 | zve(:,:) = zve(:,:) + e3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
186 | END DO |
---|
187 | DO jk = 1, jpkm1 |
---|
188 | puu(:,:,jk,Kmm) = puu(:,:,jk,Kmm) - (zue(:,:) * r1_hu(:,:,Kmm) - uu_b(:,:,Kmm)) * umask(:,:,jk) |
---|
189 | pvv(:,:,jk,Kmm) = pvv(:,:,jk,Kmm) - (zve(:,:) * r1_hv(:,:,Kmm) - vv_b(:,:,Kmm)) * vmask(:,:,jk) |
---|
190 | END DO |
---|
191 | ENDIF |
---|
192 | ! |
---|
193 | ENDIF ! .NOT. l_1st_euler |
---|
194 | ! |
---|
195 | ! Set "now" and "before" barotropic velocities for next time step: |
---|
196 | ! JC: Would be more clever to swap variables than to make a full vertical |
---|
197 | ! integration |
---|
198 | ! CAUTION : calculation need to be done in the same way than see GM |
---|
199 | #if defined key_linssh |
---|
200 | uu_b(:,:,Kaa) = e3u(:,:,1,Kaa) * puu(:,:,1,Kaa) * umask(:,:,1) |
---|
201 | uu_b(:,:,Kmm) = e3u(:,:,1,Kmm) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
202 | vv_b(:,:,Kaa) = e3v(:,:,1,Kaa) * pvv(:,:,1,Kaa) * vmask(:,:,1) |
---|
203 | vv_b(:,:,Kmm) = e3v(:,:,1,Kmm) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
204 | DO jk = 2, jpkm1 |
---|
205 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) + e3u(:,:,jk,Kaa) * puu(:,:,jk,Kaa) * umask(:,:,jk) |
---|
206 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) + e3u(:,:,jk,Kmm) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
207 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) + e3v(:,:,jk,Kaa) * pvv(:,:,jk,Kaa) * vmask(:,:,jk) |
---|
208 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) + e3v(:,:,jk,Kmm) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
209 | END DO |
---|
210 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) * r1_hu(:,:,Kaa) |
---|
211 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) * r1_hv(:,:,Kaa) |
---|
212 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * r1_hu(:,:,Kmm) |
---|
213 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * r1_hv(:,:,Kmm) |
---|
214 | #else |
---|
215 | uu_b(:,:,Kaa) = e3u(:,:,1,Kaa) * puu(:,:,1,Kaa) * umask(:,:,1) |
---|
216 | uu_b(:,:,Kmm) = (e3u_0(:,:,1) * ( 1._wp + r3u_f(:,:) * umask(:,:,1) )) * puu(:,:,1,Kmm) * umask(:,:,1) |
---|
217 | vv_b(:,:,Kaa) = e3v(:,:,1,Kaa) * pvv(:,:,1,Kaa) * vmask(:,:,1) |
---|
218 | vv_b(:,:,Kmm) = (e3v_0(:,:,1) * ( 1._wp + r3v_f(:,:) * vmask(:,:,1))) * pvv(:,:,1,Kmm) * vmask(:,:,1) |
---|
219 | DO jk = 2, jpkm1 |
---|
220 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) + e3u(:,:,jk,Kaa) * puu(:,:,jk,Kaa) * umask(:,:,jk) |
---|
221 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) + (e3u_0(:,:,jk) * ( 1._wp + r3u_f(:,:) * umask(:,:,jk) )) * puu(:,:,jk,Kmm) * umask(:,:,jk) |
---|
222 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) + e3v(:,:,jk,Kaa) * pvv(:,:,jk,Kaa) * vmask(:,:,jk) |
---|
223 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) + (e3v_0(:,:,jk) * ( 1._wp + r3v_f(:,:) * vmask(:,:,jk) )) * pvv(:,:,jk,Kmm) * vmask(:,:,jk) |
---|
224 | END DO |
---|
225 | uu_b(:,:,Kaa) = uu_b(:,:,Kaa) * r1_hu(:,:,Kaa) |
---|
226 | vv_b(:,:,Kaa) = vv_b(:,:,Kaa) * r1_hv(:,:,Kaa) |
---|
227 | uu_b(:,:,Kmm) = uu_b(:,:,Kmm) * (r1_hu_0(:,:)/( 1._wp + r3u_f(:,:) )) |
---|
228 | vv_b(:,:,Kmm) = vv_b(:,:,Kmm) * (r1_hv_0(:,:)/( 1._wp + r3v_f(:,:) )) |
---|
229 | #endif |
---|
230 | ! |
---|
231 | IF( .NOT.ln_dynspg_ts ) THEN ! output the barotropic currents |
---|
232 | CALL iom_put( "ubar", uu_b(:,:,Kmm) ) |
---|
233 | CALL iom_put( "vbar", vv_b(:,:,Kmm) ) |
---|
234 | ENDIF |
---|
235 | IF( l_trddyn ) THEN ! 3D output: asselin filter trends on momentum |
---|
236 | zua(:,:,:) = ( puu(:,:,:,Kmm) - zua(:,:,:) ) * z1_2dt |
---|
237 | zva(:,:,:) = ( pvv(:,:,:,Kmm) - zva(:,:,:) ) * z1_2dt |
---|
238 | CALL trd_dyn( zua, zva, jpdyn_atf, kt, Kmm ) |
---|
239 | ENDIF |
---|
240 | ! |
---|
241 | IF(sn_cfctl%l_prtctl) CALL prt_ctl( tab3d_1=puu(:,:,:,Kaa), clinfo1=' nxt - puu(:,:,:,Kaa): ', mask1=umask, & |
---|
242 | & tab3d_2=pvv(:,:,:,Kaa), clinfo2=' pvv(:,:,:,Kaa): ' , mask2=vmask ) |
---|
243 | ! |
---|
244 | IF( ln_dynspg_ts ) DEALLOCATE( zue, zve ) |
---|
245 | IF( l_trddyn ) DEALLOCATE( zua, zva ) |
---|
246 | IF( ln_timing ) CALL timing_stop('dyn_atf_qco') |
---|
247 | ! |
---|
248 | END SUBROUTINE dyn_atf_qco |
---|
249 | |
---|
250 | !!========================================================================= |
---|
251 | END MODULE dynatf_qco |
---|