Newer
Older
MODULE trcatf
!!======================================================================
!! *** MODULE trcatf ***
!! Ocean passive tracers: time stepping on passives tracers
!!======================================================================
!! History : 7.0 ! 1991-11 (G. Madec) Original code
!! ! 1993-03 (M. Guyon) symetrical conditions
!! ! 1995-02 (M. Levy) passive tracers
!! ! 1996-02 (G. Madec & M. Imbard) opa release 8.0
!! 8.0 ! 1996-04 (A. Weaver) Euler forward step
!! 8.2 ! 1999-02 (G. Madec, N. Grima) semi-implicit pressure grad.
!! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and module
!! ! 2002-08 (G. Madec) F90: Free form and module
!! ! 2002-11 (C. Talandier, A-M Treguier) Open boundaries
!! ! 2004-03 (C. Ethe) passive tracers
!! ! 2007-02 (C. Deltel) Diagnose ML trends for passive tracers
!! 2.0 ! 2006-02 (L. Debreu, C. Mazauric) Agrif implementation
!! 3.0 ! 2008-06 (G. Madec) time stepping always done in trazdf
!! 3.1 ! 2009-02 (G. Madec, R. Benshila) re-introduce the vvl option
!! 3.3 ! 2010-06 (C. Ethe, G. Madec) Merge TRA-TRC
!! 4.1 ! 2019-08 (A. Coward, D. Storkey) rename trcnxt.F90 -> trcatf.F90. Now only does time filtering.
!!----------------------------------------------------------------------
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
!!----------------------------------------------------------------------
!! 'key_top' TOP models
!!----------------------------------------------------------------------
!! trc_atf : time stepping on passive tracers
!!----------------------------------------------------------------------
USE par_trc ! need jptra, number of passive tracers
USE oce_trc ! ocean dynamics and tracers variables
USE trc ! ocean passive tracers variables
USE trd_oce
USE trdtra
# if defined key_qco || defined key_linssh
USE traatf_qco ! tracer : Asselin filter (qco)
# else
USE traatf ! tracer : Asselin filter (vvl)
# endif
USE bdy_oce , ONLY: ln_bdy
USE trcbdy ! BDY open boundaries
# if defined key_agrif
USE agrif_top_interp
# endif
!
USE lbclnk ! ocean lateral boundary conditions (or mpp link)
USE prtctl ! Print control for debbuging
IMPLICIT NONE
PRIVATE
PUBLIC trc_atf ! routine called by step.F90
REAL(wp) :: rfact1, rfact2
!! * Substitutions
# include "do_loop_substitute.h90"
# include "domzgr_substitute.h90"
!!----------------------------------------------------------------------
!! NEMO/TOP 4.0 , NEMO Consortium (2018)
!! $Id: trcatf.F90 15373 2021-10-14 17:01:57Z techene $
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
!! Software governed by the CeCILL license (see ./LICENSE)
!!----------------------------------------------------------------------
CONTAINS
SUBROUTINE trc_atf( kt, Kbb, Kmm, Kaa, ptr )
!!----------------------------------------------------------------------
!! *** ROUTINE trcatf ***
!!
!! ** Purpose : Apply the boundary condition on the after passive tracers fields and
!! apply Asselin time filter to the now passive tracer fields if using leapfrog timestep
!!
!! ** Method : Apply lateral boundary conditions on (uu(Kaa),vv(Kaa)) through
!! call to lbc_lnk routine
!!
!! For Arakawa or TVD Scheme :
!! A Asselin time filter applied on now tracers tr(Kmm) to avoid
!! the divergence of two consecutive time-steps and tr arrays
!! to prepare the next time_step:
!! (tr(Kmm)) = (tr(Kmm)) + rn_atfp [ (tr(Kbb)) + (tr(Kaa)) - 2 (tr(Kmm)) ]
!!
!!
!! ** Action : - update tr(Kmm), tr(Kaa)
!!----------------------------------------------------------------------
INTEGER , INTENT( in ) :: kt ! ocean time-step index
INTEGER , INTENT( in ) :: Kbb, Kmm, Kaa ! time level indices
REAL(wp), DIMENSION(jpi,jpj,jpk,jptra,jpt), INTENT(inout) :: ptr ! passive tracers
!
INTEGER :: jk, jn ! dummy loop indices
REAL(wp) :: zfact ! temporary scalar
CHARACTER (len=22) :: charout
REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: ztrdt ! 4D workspace
!!----------------------------------------------------------------------
!
IF( ln_timing ) CALL timing_start('trc_atf')
!
IF( kt == nittrc000 .AND. lwp ) THEN
WRITE(numout,*)
WRITE(numout,*) 'trc_atf : Asselin time filtering on passive tracers'
ENDIF
!
#if defined key_agrif
CALL Agrif_trc( kt ) ! AGRIF zoom boundaries
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
#endif
! Update after tracer on domain lateral boundaries
CALL lbc_lnk( 'trcatf', ptr(:,:,:,:,Kaa), 'T', 1._wp )
IF( ln_bdy ) CALL trc_bdy( kt, Kbb, Kmm, Kaa )
IF( l_trdtrc ) THEN ! trends: store now fields before the Asselin filter application
ALLOCATE( ztrdt(jpi,jpj,jpk,jptra) )
ztrdt(:,:,:,:) = 0._wp
IF( ln_traldf_iso ) THEN ! diagnose the "pure" Kz diffusive trend
DO jn = 1, jptra
CALL trd_tra( kt, Kmm, Kaa, 'TRC', jn, jptra_zdfp, ztrdt(:,:,:,jn) )
ENDDO
ENDIF
! total trend for the non-time-filtered variables.
zfact = 1.0 / rn_Dt
! G Nurser 23 Mar 2017. Recalculate trend as Delta(e3ta*Ta)/e3tn; e3tn cancel from ts(Kmm) terms
IF( ln_linssh ) THEN ! linear sea surface height only
DO jn = 1, jptra
DO jk = 1, jpkm1
ztrdt(:,:,jk,jn) = ( ptr(:,:,jk,jn,Kaa)*e3t(:,:,jk,Kaa) / e3t(:,:,jk,Kmm) - ptr(:,:,jk,jn,Kmm)) * zfact
END DO
END DO
ELSE
DO jn = 1, jptra
DO jk = 1, jpkm1
ztrdt(:,:,jk,jn) = ( ptr(:,:,jk,jn,Kaa) - ptr(:,:,jk,jn,Kmm) ) * zfact
END DO
END DO
ENDIF
!
DO jn = 1, jptra
CALL trd_tra( kt, Kmm, Kaa, 'TRC', jn, jptra_tot, ztrdt(:,:,:,jn) )
ENDDO
!
IF( ln_linssh ) THEN ! linear sea surface height only
! Store now fields before applying the Asselin filter
! in order to calculate Asselin filter trend later.
ztrdt(:,:,:,:) = ptr(:,:,:,:,Kmm)
ENDIF
ENDIF
! ! Leap-Frog + Asselin filter time stepping
IF( l_1st_euler .OR. ln_top_euler ) THEN ! Euler time-stepping
!
IF (l_trdtrc .AND. .NOT. ln_linssh ) THEN ! Zero Asselin filter contribution must be explicitly written out since for vvl
! ! Asselin filter is output by tra_nxt_vvl that is not called on this time step
ztrdt(:,:,:,:) = 0._wp
DO jn = 1, jptra
CALL trd_tra( kt, Kmm, Kaa, 'TRC', jn, jptra_atf, ztrdt(:,:,:,jn) )
ENDDO
END IF
!
ELSE
IF( .NOT. l_offline ) THEN ! Leap-Frog + Asselin filter time stepping
# if defined key_qco || defined key_linssh
IF( ln_linssh ) THEN ; CALL tra_atf_fix_lf( kt, Kbb, Kmm, Kaa, nittrc000, 'TRC', ptr, jptra ) ! linear ssh
ELSE ; CALL tra_atf_qco_lf( kt, Kbb, Kmm, Kaa, nittrc000, rn_Dt, 'TRC', ptr, sbc_trc, sbc_trc_b, jptra ) ! non-linear ssh
# else
IF( ln_linssh ) THEN ; CALL tra_atf_fix( kt, Kbb, Kmm, Kaa, nittrc000, 'TRC', ptr, jptra ) ! linear ssh
ELSE ; CALL tra_atf_vvl( kt, Kbb, Kmm, Kaa, nittrc000, rn_Dt, 'TRC', ptr, sbc_trc, sbc_trc_b, jptra ) ! non-linear ssh
# endif
ENDIF
ELSE
CALL trc_atf_off( kt, Kbb, Kmm, Kaa, ptr ) ! offline
ENDIF
!
CALL lbc_lnk( 'trcatf', ptr(:,:,:,:,Kmm), 'T', 1._wp )
ENDIF
!
IF( l_trdtrc .AND. ln_linssh ) THEN ! trend of the Asselin filter (tb filtered - tb)/dt )
DO jn = 1, jptra
DO jk = 1, jpkm1
zfact = 1._wp / rDt_trc
ztrdt(:,:,jk,jn) = ( ptr(:,:,jk,jn,Kbb) - ztrdt(:,:,jk,jn) ) * zfact
END DO
CALL trd_tra( kt, Kmm, Kaa, 'TRC', jn, jptra_atf, ztrdt(:,:,:,jn) )
END DO
END IF
IF( l_trdtrc ) DEALLOCATE( ztrdt )
!
IF(sn_cfctl%l_prttrc) THEN ! print mean trends (used for debugging)
WRITE(charout, FMT="('nxt')")
CALL prt_ctl_info( charout, cdcomp = 'top' )
CALL prt_ctl(tab4d_1=ptr(:,:,:,:,Kmm), mask1=tmask, clinfo=ctrcnm)
ENDIF
!
IF( ln_timing ) CALL timing_stop('trc_atf')
!
END SUBROUTINE trc_atf
# if defined key_qco || defined key_linssh
SUBROUTINE trc_atf_off( kt, Kbb, Kmm, Kaa, ptr )
!!----------------------------------------------------------------------
!! *** ROUTINE tra_atf_off ***
!!
!! !!!!!!!!!!!!!!!!! REWRITE HEADER COMMENTS !!!!!!!!!!!!!!
!!
!! ** Purpose : Time varying volume: apply the Asselin time filter
!!
!! ** Method : - Apply a thickness weighted Asselin time filter on now fields.
!! - save in (ta,sa) a thickness weighted average over the three
!! time levels which will be used to compute rdn and thus the semi-
!! implicit hydrostatic pressure gradient (ln_dynhpg_imp = T)
!! - swap tracer fields to prepare the next time_step.
!! This can be summurized for tempearture as:
!! ztm = ( e3t_n*tn + rbcp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] ) ln_dynhpg_imp = T
!! /( e3t(:,:,jk,Kmm) + rbcp*[ e3t(:,:,jk,Kbb) - 2 e3t(:,:,jk,Kmm) + e3t(:,:,jk,Kaa) ] )
!! ztm = 0 otherwise
!! tb = ( e3t_n*tn + rn_atfp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] )
!! /( e3t(:,:,jk,Kmm) + rn_atfp*[ e3t(:,:,jk,Kbb) - 2 e3t(:,:,jk,Kmm) + e3t(:,:,jk,Kaa) ] )
!! tn = ta
!! ta = zt (NB: reset to 0 after eos_bn2 call)
!!
!! ** Action : - (tb,sb) and (tn,sn) ready for the next time step
!! - (ta,sa) time averaged (t,s) (ln_dynhpg_imp = T)
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: kt ! ocean time-step index
INTEGER , INTENT(in ) :: Kbb, Kmm, Kaa ! time level indices
REAL(wp), DIMENSION(jpi,jpj,jpk,jptra,jpt), INTENT(inout) :: ptr ! passive tracers
!!
INTEGER :: ji, jj, jk, jn ! dummy loop indices
REAL(wp) :: ztc_a , ztc_n , ztc_b , ztc_f , ztc_d ! local scalar
REAL(wp) :: ze3t_b, ze3t_n, ze3t_a, ze3t_f ! - -
!!----------------------------------------------------------------------
!
IF( kt == nittrc000 ) THEN
IF(lwp) WRITE(numout,*)
IF(lwp) WRITE(numout,*) 'trc_atf_off : Asselin time filtering'
IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
IF( .NOT. ln_linssh ) THEN
rfact1 = rn_atfp * rn_Dt
rfact2 = rfact1 / rho0
ENDIF
!
ENDIF
!
DO jn = 1, jptra
DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpkm1 )
ze3t_b = 1._wp + r3t(ji,jj,Kbb) * tmask(ji,jj,jk)
ze3t_n = 1._wp + r3t(ji,jj,Kmm) * tmask(ji,jj,jk)
ze3t_a = 1._wp + r3t(ji,jj,Kaa) * tmask(ji,jj,jk)
! ! tracer content at Before, now and after
ztc_b = ptr(ji,jj,jk,jn,Kbb) * ze3t_b
ztc_n = ptr(ji,jj,jk,jn,Kmm) * ze3t_n
ztc_a = ptr(ji,jj,jk,jn,Kaa) * ze3t_a
!
ztc_d = ztc_a - 2. * ztc_n + ztc_b
!
ze3t_f = 1._wp + r3t_f(ji,jj)*tmask(ji,jj,jk)
ztc_f = ztc_n + rn_atfp * ztc_d
!
IF( .NOT. ln_linssh .AND. jk == mikt(ji,jj) ) THEN ! first level
ztc_f = ztc_f - rfact1 * ( sbc_trc(ji,jj,jn) - sbc_trc_b(ji,jj,jn) )
ENDIF
ze3t_f = 1.e0 / ze3t_f
ptr(ji,jj,jk,jn,Kmm) = ztc_f * ze3t_f ! time filtered "now" field
!
END_3D
!
END DO
!
END SUBROUTINE trc_atf_off
# else
SUBROUTINE trc_atf_off( kt, Kbb, Kmm, Kaa, ptr )
!!----------------------------------------------------------------------
!! *** ROUTINE tra_atf_off ***
!!
!! !!!!!!!!!!!!!!!!! REWRITE HEADER COMMENTS !!!!!!!!!!!!!!
!!
!! ** Purpose : Time varying volume: apply the Asselin time filter
!!
!! ** Method : - Apply a thickness weighted Asselin time filter on now fields.
!! - save in (ta,sa) a thickness weighted average over the three
!! time levels which will be used to compute rdn and thus the semi-
!! implicit hydrostatic pressure gradient (ln_dynhpg_imp = T)
!! - swap tracer fields to prepare the next time_step.
!! This can be summurized for tempearture as:
!! ztm = ( e3t_n*tn + rbcp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] ) ln_dynhpg_imp = T
!! /( e3t(:,:,jk,Kmm) + rbcp*[ e3t(:,:,jk,Kbb) - 2 e3t(:,:,jk,Kmm) + e3t(:,:,jk,Kaa) ] )
!! ztm = 0 otherwise
!! tb = ( e3t_n*tn + rn_atfp*[ e3t_b*tb - 2 e3t_n*tn + e3t_a*ta ] )
!! /( e3t(:,:,jk,Kmm) + rn_atfp*[ e3t(:,:,jk,Kbb) - 2 e3t(:,:,jk,Kmm) + e3t(:,:,jk,Kaa) ] )
!! tn = ta
!! ta = zt (NB: reset to 0 after eos_bn2 call)
!!
!! ** Action : - (tb,sb) and (tn,sn) ready for the next time step
!! - (ta,sa) time averaged (t,s) (ln_dynhpg_imp = T)
!!----------------------------------------------------------------------
INTEGER , INTENT(in ) :: kt ! ocean time-step index
INTEGER , INTENT(in ) :: Kbb, Kmm, Kaa ! time level indices
REAL(wp), DIMENSION(jpi,jpj,jpk,jptra,jpt), INTENT(inout) :: ptr ! passive tracers
!!
INTEGER :: ji, jj, jk, jn ! dummy loop indices
REAL(wp) :: ztc_a , ztc_n , ztc_b , ztc_f , ztc_d ! local scalar
REAL(wp) :: ze3t_b, ze3t_n, ze3t_a, ze3t_f, ze3t_d ! - -
!!----------------------------------------------------------------------
!
IF( kt == nittrc000 ) THEN
IF(lwp) WRITE(numout,*)
IF(lwp) WRITE(numout,*) 'trc_atf_off : Asselin time filtering'
IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
IF( .NOT. ln_linssh ) THEN
rfact1 = rn_atfp * rn_Dt
rfact2 = rfact1 / rho0
ENDIF
!
ENDIF
!
DO jn = 1, jptra
DO_3D( nn_hls, nn_hls, nn_hls, nn_hls, 1, jpkm1 )
ze3t_b = e3t(ji,jj,jk,Kbb)
ze3t_n = e3t(ji,jj,jk,Kmm)
ze3t_a = e3t(ji,jj,jk,Kaa)
! ! tracer content at Before, now and after
ztc_b = ptr(ji,jj,jk,jn,Kbb) * ze3t_b
ztc_n = ptr(ji,jj,jk,jn,Kmm) * ze3t_n
ztc_a = ptr(ji,jj,jk,jn,Kaa) * ze3t_a
!
ze3t_d = ze3t_a - 2. * ze3t_n + ze3t_b
ztc_d = ztc_a - 2. * ztc_n + ztc_b
!
ze3t_f = ze3t_n + rn_atfp * ze3t_d
ztc_f = ztc_n + rn_atfp * ztc_d
!
IF( .NOT. ln_linssh .AND. jk == mikt(ji,jj) ) THEN ! first level
ze3t_f = ze3t_f - rfact2 * ( emp_b(ji,jj) - emp(ji,jj) )
ztc_f = ztc_f - rfact1 * ( sbc_trc(ji,jj,jn) - sbc_trc_b(ji,jj,jn) )
ENDIF
ze3t_f = 1.e0 / ze3t_f
ptr(ji,jj,jk,jn,Kmm) = ztc_f * ze3t_f ! time filtered "now" field
!
END_3D
!
END DO
!
END SUBROUTINE trc_atf_off
# endif
#else
!!----------------------------------------------------------------------
!! Default option Empty module
!!----------------------------------------------------------------------
USE par_oce
USE par_trc
CONTAINS
SUBROUTINE trc_atf( kt, Kbb, Kmm, Kaa, ptr )
INTEGER , INTENT(in) :: kt
INTEGER, INTENT(in ) :: Kbb, Kmm, Kaa ! time level indices
REAL(wp), DIMENSION(jpi,jpj,jpk,jptra,jpt), INTENT(inout) :: ptr ! passive tracers and RHS of tracer equation
WRITE(*,*) 'trc_atf: You should not have seen this print! error?', kt
END SUBROUTINE trc_atf
#endif
!!======================================================================
END MODULE trcatf