source: NEMO/branches/2021/dev_r14273_HPC-02_Daley_Tiling/src/OCE/stpmlf.F90 @ 14576

Last change on this file since 14576 was 14576, checked in by hadcv, 4 months ago

#2600: Merge in dev_r14393_HPC-03_Mele_Comm_Cleanup r14538

File size: 31.5 KB
Line 
1MODULE stpmlf
2   !!======================================================================
3   !!                       ***  MODULE stpMLF  ***
4   !! Time-stepping   : manager of the ocean, tracer and ice time stepping
5   !!                   using Modified Leap Frog for OCE
6   !!======================================================================
7   !! History :  OPA  !  1991-03  (G. Madec)  Original code
8   !!             -   !  1991-11  (G. Madec)
9   !!             -   !  1992-06  (M. Imbard)  add a first output record
10   !!             -   !  1996-04  (G. Madec)  introduction of dynspg
11   !!             -   !  1996-04  (M.A. Foujols)  introduction of passive tracer
12   !!            8.0  !  1997-06  (G. Madec)  new architecture of call
13   !!            8.2  !  1997-06  (G. Madec, M. Imbard, G. Roullet)  free surface
14   !!             -   !  1999-02  (G. Madec, N. Grima)  hpg implicit
15   !!             -   !  2000-07  (J-M Molines, M. Imbard)  Open Bondary Conditions
16   !!   NEMO     1.0  !  2002-06  (G. Madec)  free form, suppress macro-tasking
17   !!             -   !  2004-08  (C. Talandier) New trends organization
18   !!             -   !  2005-01  (C. Ethe) Add the KPP closure scheme
19   !!             -   !  2005-11  (G. Madec)  Reorganisation of tra and dyn calls
20   !!             -   !  2006-01  (L. Debreu, C. Mazauric)  Agrif implementation
21   !!             -   !  2006-07  (S. Masson)  restart using iom
22   !!            3.2  !  2009-02  (G. Madec, R. Benshila)  reintroduicing z*-coordinate
23   !!             -   !  2009-06  (S. Masson, G. Madec)  TKE restart compatible with key_cpl
24   !!            3.3  !  2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
25   !!             -   !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase + merge TRC-TRA
26   !!            3.4  !  2011-04  (G. Madec, C. Ethe) Merge of dtatem and dtasal
27   !!            3.6  !  2012-07  (J. Simeon, G. Madec. C. Ethe)  Online coarsening of outputs
28   !!            3.6  !  2014-04  (F. Roquet, G. Madec) New equations of state
29   !!            3.6  !  2014-10  (E. Clementi, P. Oddo) Add Qiao vertical mixing in case of waves
30   !!            3.7  !  2014-10  (G. Madec)  LDF simplication
31   !!             -   !  2014-12  (G. Madec) remove KPP scheme
32   !!             -   !  2015-11  (J. Chanut) free surface simplification (remove filtered free surface)
33   !!            4.0  !  2017-05  (G. Madec)  introduction of the vertical physics manager (zdfphy)
34   !!            4.1  !  2019-08  (A. Coward, D. Storkey) rewrite in preparation for new timestepping scheme
35   !!            4.x  !  2020-08  (S. Techene, G. Madec)  quasi eulerian coordinate time stepping
36   !!----------------------------------------------------------------------
37#if defined key_qco   ||   defined key_linssh
38   !!----------------------------------------------------------------------
39   !!   'key_qco'                        Quasi-Eulerian vertical coordinate
40   !!                          OR
41   !!   'key_linssh                       Fixed in time vertical coordinate
42   !!----------------------------------------------------------------------
43   !!
44   !!----------------------------------------------------------------------
45   !!   stp_MLF       : NEMO modified Leap Frog time-stepping with qco or linssh
46   !!----------------------------------------------------------------------
47   USE step_oce       ! time stepping definition modules
48   !
49   USE domqco         ! quasi-eulerian coordinate
50   USE traatf_qco     ! time filtering                 (tra_atf_qco routine)
51   USE dynatf_qco     ! time filtering                 (dyn_atf_qco routine)
52
53   IMPLICIT NONE
54   PRIVATE
55
56   PUBLIC   stp_MLF   ! called by nemogcm.F90
57
58   !                                          !**  time level indices  **!
59   INTEGER, PUBLIC ::   Nbb, Nnn, Naa, Nrhs   !: used by nemo_init
60
61   !! * Substitutions
62#  include "do_loop_substitute.h90"
63#  include "domzgr_substitute.h90"
64#  include "do_loop_substitute.h90"
65   !!----------------------------------------------------------------------
66   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
67   !! $Id: step.F90 12377 2020-02-12 14:39:06Z acc $
68   !! Software governed by the CeCILL license (see ./LICENSE)
69   !!----------------------------------------------------------------------
70CONTAINS
71
72#if defined key_agrif
73   RECURSIVE SUBROUTINE stp_MLF( )
74      INTEGER             ::   kstp   ! ocean time-step index
75#else
76   SUBROUTINE stp_MLF( kstp )
77      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
78#endif
79      !!----------------------------------------------------------------------
80      !!                     ***  ROUTINE stp_MLF  ***
81      !!
82      !! ** Purpose : - Time stepping of OCE  (momentum and active tracer eqs.)
83      !!              - Time stepping of SI3 (dynamic and thermodynamic eqs.)
84      !!              - Time stepping of TRC  (passive tracer eqs.)
85      !!
86      !! ** Method  : -1- Update forcings and data
87      !!              -2- Update ocean physics
88      !!              -3- Compute the t and s trends
89      !!              -4- Update t and s
90      !!              -5- Compute the momentum trends
91      !!              -6- Update the horizontal velocity
92      !!              -7- Compute the diagnostics variables (rd,N2, hdiv,w)
93      !!              -8- Outputs and diagnostics
94      !!----------------------------------------------------------------------
95      INTEGER ::   ji, jj, jk, jtile   ! dummy loop indice
96      REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) ::   zgdept
97      !! ---------------------------------------------------------------------
98#if defined key_agrif
99      IF( nstop > 0 ) RETURN   ! avoid to go further if an error was detected during previous time step (child grid)
100      kstp = nit000 + Agrif_Nb_Step()
101      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
102      IF( lk_agrif_debug ) THEN
103         IF( Agrif_Root() .and. lwp)   WRITE(*,*) '---'
104         IF(lwp)   WRITE(*,*) 'Grid Number', Agrif_Fixed(),' time step ', kstp, 'int tstep', Agrif_NbStepint()
105      ENDIF
106      IF( kstp == nit000 + 1 )   lk_agrif_fstep = .FALSE.
107# if defined key_xios
108      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap( cxios_context )
109# endif
110#endif
111      !
112      IF( ln_timing )   CALL timing_start('stp_MLF')
113      !
114      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
115      ! model timestep
116      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
117      !
118      IF( l_1st_euler ) THEN     ! start or restart with Euler 1st time-step
119         rDt   = rn_Dt   
120         r1_Dt = 1._wp / rDt
121      ENDIF
122      !
123      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
124      ! update I/O and calendar
125      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
126      !
127      IF( kstp == nit000 ) THEN                       ! initialize IOM context (must be done after nemo_init for AGRIF+XIOS+OASIS)
128                             CALL iom_init( cxios_context, ld_closedef=.FALSE. )   ! for model grid (including possible AGRIF zoom)
129         IF( lk_diamlr   )   CALL dia_mlr_iom_init    ! with additional setup for multiple-linear-regression analysis
130                             CALL iom_init_closedef
131         IF( ln_crs      )   CALL iom_init( TRIM(cxios_context)//"_crs" )  ! for coarse grid
132      ENDIF
133      IF( kstp == nitrst .AND. lwxios ) THEN
134                             CALL iom_swap(                     cw_ocerst_cxt )
135                             CALL iom_init_closedef(            cw_ocerst_cxt )
136                             CALL iom_setkt( kstp - nit000 + 1, cw_ocerst_cxt )
137#if defined key_top
138                             CALL iom_swap(                     cw_toprst_cxt )
139                             CALL iom_init_closedef(            cw_toprst_cxt )
140                             CALL iom_setkt( kstp - nit000 + 1, cw_toprst_cxt )
141#endif
142      ENDIF
143#if defined key_si3
144      IF( kstp + nn_fsbc - 1 == nitrst .AND. lwxios ) THEN
145                             CALL iom_swap(                     cw_icerst_cxt )
146                             CALL iom_init_closedef(            cw_icerst_cxt )
147                             CALL iom_setkt( kstp - nit000 + 1, cw_icerst_cxt )
148      ENDIF
149#endif
150      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
151                             CALL iom_setkt( kstp - nit000 + 1,      cxios_context          )   ! tell IOM we are at time step kstp
152      IF( ln_crs         )   CALL iom_setkt( kstp - nit000 + 1, TRIM(cxios_context)//"_crs" )   ! tell IOM we are at time step kstp
153
154      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
155      ! Update external forcing (tides, open boundaries, ice shelf interaction and surface boundary condition (including sea-ice)
156      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
157      IF( ln_tide    )   CALL tide_update( kstp )                     ! update tide potential
158      IF( ln_apr_dyn )   CALL sbc_apr ( kstp )                        ! atmospheric pressure (NB: call before bdy_dta which needs ssh_ib)
159      IF( ln_bdy     )   CALL bdy_dta ( kstp, Nnn )                   ! update dynamic & tracer data at open boundaries
160      IF( ln_isf     )   CALL isf_stp ( kstp, Nnn )
161                         CALL sbc     ( kstp, Nbb, Nnn )              ! Sea Boundary Condition (including sea-ice)
162
163      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
164      ! Update stochastic parameters and random T/S fluctuations
165      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
166      IF( ln_sto_eos )   CALL sto_par( kstp )                         ! Stochastic parameters
167      IF( ln_sto_eos )   CALL sto_pts( ts(:,:,:,:,Nnn)  )             ! Random T/S fluctuations
168
169      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
170      ! Ocean physics update
171      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
172      !  THERMODYNAMICS
173                         CALL eos_rab( ts(:,:,:,:,Nbb), rab_b, Nnn )       ! before local thermal/haline expension ratio at T-points
174                         CALL eos_rab( ts(:,:,:,:,Nnn), rab_n, Nnn )       ! now    local thermal/haline expension ratio at T-points
175                         CALL bn2    ( ts(:,:,:,:,Nbb), rab_b, rn2b, Nnn ) ! before Brunt-Vaisala frequency
176                         CALL bn2    ( ts(:,:,:,:,Nnn), rab_n, rn2, Nnn  ) ! now    Brunt-Vaisala frequency
177
178      !  VERTICAL PHYSICS
179                         CALL zdf_phy( kstp, Nbb, Nnn, Nrhs )   ! vertical physics update (top/bot drag, avt, avs, avm + MLD)
180
181      !  LATERAL  PHYSICS
182      !
183      IF( l_ldfslp ) THEN                             ! slope of lateral mixing
184                         CALL eos( ts(:,:,:,:,Nbb), rhd, gdept_0(:,:,:) )               ! before in situ density
185
186         IF( ln_zps .AND. .NOT. ln_isfcav)                                    &
187            &            CALL zps_hde    ( kstp, Nnn, jpts, ts(:,:,:,:,Nbb), gtsu, gtsv,  &  ! Partial steps: before horizontal gradient
188            &                                          rhd, gru , grv    )       ! of t, s, rd at the last ocean level
189
190         IF( ln_zps .AND.       ln_isfcav)                                                &
191            &            CALL zps_hde_isf( kstp, Nnn, jpts, ts(:,:,:,:,Nbb), gtsu, gtsv, gtui, gtvi,  &  ! Partial steps for top cell (ISF)
192            &                                          rhd, gru , grv , grui, grvi   )       ! of t, s, rd at the first ocean level
193         IF( ln_traldf_triad ) THEN
194                         CALL ldf_slp_triad( kstp, Nbb, Nnn )             ! before slope for triad operator
195         ELSE
196                         CALL ldf_slp     ( kstp, rhd, rn2b, Nbb, Nnn )   ! before slope for standard operator
197         ENDIF
198      ENDIF
199      !                                                                        ! eddy diffusivity coeff.
200      IF( l_ldftra_time .OR. l_ldfeiv_time )   CALL ldf_tra( kstp, Nbb, Nnn )  !       and/or eiv coeff.
201      IF( l_ldfdyn_time                    )   CALL ldf_dyn( kstp, Nbb )       ! eddy viscosity coeff.
202
203      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
204      !  Ocean dynamics : hdiv, ssh, e3, u, v, w
205      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
206     
207                         CALL ssh_nxt    ( kstp, Nbb, Nnn, ssh,  Naa )   ! after ssh (includes call to div_hor)
208      IF( .NOT.lk_linssh ) THEN
209                         CALL dom_qco_r3c( ssh(:,:,Naa), r3t(:,:,Naa), r3u(:,:,Naa), r3v(:,:,Naa)           )   ! "after" ssh/h_0 ratio at t,u,v pts
210         IF( ln_dynspg_exp )   &
211            &            CALL dom_qco_r3c( ssh(:,:,Nnn), r3t(:,:,Nnn), r3u(:,:,Nnn), r3v(:,:,Nnn), r3f(:,:) )   ! spg_exp : needed only for "now" ssh/h_0 ratio at f point
212      ENDIF
213                         CALL wzv        ( kstp, Nbb, Nnn, Naa, ww  )    ! Nnn cross-level velocity
214      IF( ln_zad_Aimp )  CALL wAimp      ( kstp,      Nnn           )    ! Adaptive-implicit vertical advection partitioning
215                         ALLOCATE( zgdept(jpi,jpj,jpk) )
216                         DO jk = 1, jpk
217                            zgdept(:,:,jk) = gdept(:,:,jk,Nnn)
218                         END DO
219                         CALL eos        ( ts(:,:,:,:,Nnn), rhd, rhop, zgdept ) ! now in situ density for hpg computation
220                         DEALLOCATE( zgdept )
221
222                         uu(:,:,:,Nrhs) = 0._wp            ! set dynamics trends to zero
223                         vv(:,:,:,Nrhs) = 0._wp
224
225      IF(  lk_asminc .AND. ln_asmiau .AND. ln_dyninc )   &
226               &         CALL dyn_asm_inc   ( kstp, Nbb, Nnn, uu, vv, Nrhs )  ! apply dynamics assimilation increment
227      IF( ln_bdy     )   CALL bdy_dyn3d_dmp ( kstp, Nbb,      uu, vv, Nrhs )  ! bdy damping trends
228#if defined key_agrif
229      IF(.NOT. Agrif_Root())  &
230               &         CALL Agrif_Sponge_dyn        ! momentum sponge
231#endif
232                         CALL dyn_adv( kstp, Nbb, Nnn      , uu, vv, Nrhs )  ! advection (VF or FF)   ==> RHS
233                         CALL dyn_vor( kstp,      Nnn      , uu, vv, Nrhs )  ! vorticity              ==> RHS
234                         CALL dyn_ldf( kstp, Nbb, Nnn      , uu, vv, Nrhs )  ! lateral mixing
235      IF( ln_zdfosm  )   CALL dyn_osm( kstp,      Nnn      , uu, vv, Nrhs )  ! OSMOSIS non-local velocity fluxes ==> RHS
236                         CALL dyn_hpg( kstp,      Nnn      , uu, vv, Nrhs )  ! horizontal gradient of Hydrostatic pressure
237                         CALL dyn_spg( kstp, Nbb, Nnn, Nrhs, uu, vv, ssh, uu_b, vv_b, Naa )  ! surface pressure gradient
238                         
239      IF( ln_dynspg_ts ) THEN      ! With split-explicit free surface, since now transports have been updated and ssh(:,:,Nrhs)
240                                   ! as well as vertical scale factors and vertical velocity need to be updated
241                            CALL div_hor    ( kstp, Nbb, Nnn )                ! Horizontal divergence  (2nd call in time-split case)
242         IF(.NOT.lk_linssh) CALL dom_qco_r3c( ssh(:,:,Naa), r3t(:,:,Naa), r3u(:,:,Naa), r3v(:,:,Naa), r3f(:,:) )   ! update ssh/h_0 ratio at t,u,v,f pts
243      ENDIF
244                            CALL dyn_zdf    ( kstp, Nbb, Nnn, Nrhs, uu, vv, Naa  )  ! vertical diffusion
245      IF( ln_dynspg_ts ) THEN                                                       ! vertical scale factors and vertical velocity need to be updated
246                            CALL wzv        ( kstp, Nbb, Nnn, Naa, ww )             ! Nnn cross-level velocity
247         IF( ln_zad_Aimp )  CALL wAimp      ( kstp,      Nnn )                      ! Adaptive-implicit vertical advection partitioning
248      ENDIF
249
250
251      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
252      ! cool skin
253      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
254      IF ( ln_diurnal )  CALL diurnal_layers( kstp )
255
256      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
257      ! diagnostics and outputs
258      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
259      IF( ln_floats  )   CALL flo_stp   ( kstp, Nbb, Nnn )      ! drifting Floats
260      IF( ln_diacfl  )   CALL dia_cfl   ( kstp,      Nnn )      ! Courant number diagnostics
261                         CALL dia_hth   ( kstp,      Nnn )      ! Thermocline depth (20 degres isotherm depth)
262      IF( ln_diadct  )   CALL dia_dct   ( kstp,      Nnn )      ! Transports
263                         CALL dia_ar5   ( kstp,      Nnn )      ! ar5 diag
264                         CALL dia_ptr   ( kstp,      Nnn )      ! Poleward adv/ldf TRansports diagnostics
265                         CALL dia_wri   ( kstp,      Nnn )      ! ocean model: outputs
266      IF( ln_crs     )   CALL crs_fld   ( kstp,      Nnn )      ! ocean model: online field coarsening & output
267      IF( lk_diadetide ) CALL dia_detide( kstp )                ! Weights computation for daily detiding of model diagnostics
268      IF( lk_diamlr  )   CALL dia_mlr                           ! Update time used in multiple-linear-regression analysis
269
270      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
271      ! Now ssh filtering
272      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
273                         CALL ssh_atf    ( kstp, Nbb, Nnn, Naa, ssh )            ! time filtering of "now" sea surface height
274      IF(.NOT.lk_linssh) CALL dom_qco_r3c( ssh(:,:,Nnn), r3t_f, r3u_f, r3v_f )   ! "now" ssh/h_0 ratio from filtrered ssh
275#if defined key_top
276      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
277      ! Passive Tracer Model
278      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
279                         CALL trc_stp    ( kstp, Nbb, Nnn, Nrhs, Naa )           ! time-stepping
280#endif
281
282      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
283      ! Active tracers
284      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
285      ! Loop over tile domains
286      DO jtile = 1, nijtile
287         IF( ln_tile    )   CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = jtile )
288
289         DO_3D( 0, 0, 0, 0, 1, jpk )
290            ts(ji,jj,jk,:,Nrhs) = 0._wp                                   ! set tracer trends to zero
291         END_3D
292
293         IF(  lk_asminc .AND. ln_asmiau .AND. &
294            & ln_trainc )   CALL tra_asm_inc( kstp, Nbb, Nnn, ts, Nrhs )  ! apply tracer assimilation increment
295                            CALL tra_sbc    ( kstp,      Nnn, ts, Nrhs )  ! surface boundary condition
296         IF( ln_traqsr  )   CALL tra_qsr    ( kstp,      Nnn, ts, Nrhs )  ! penetrative solar radiation qsr
297         IF( ln_isf     )   CALL tra_isf    ( kstp,      Nnn, ts, Nrhs )  ! ice shelf heat flux
298         IF( ln_trabbc  )   CALL tra_bbc    ( kstp,      Nnn, ts, Nrhs )  ! bottom heat flux
299         IF( ln_trabbl  )   CALL tra_bbl    ( kstp, Nbb, Nnn, ts, Nrhs )  ! advective (and/or diffusive) bottom boundary layer scheme
300         IF( ln_tradmp  )   CALL tra_dmp    ( kstp, Nbb, Nnn, ts, Nrhs )  ! internal damping trends
301         IF( ln_bdy     )   CALL bdy_tra_dmp( kstp, Nbb,      ts, Nrhs )  ! bdy damping trends
302      END DO
303
304#if defined key_agrif
305      IF(.NOT. Agrif_Root() ) THEN
306         IF( ln_tile    )   CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = 0 )
307                            CALL Agrif_Sponge_tra        ! tracers sponge
308      ENDIF
309#endif
310
311     ! [comm_cleanup]
312     IF (nn_hls.EQ.2) THEN
313         SELECT CASE ( nadv )
314         CASE ( np_FCT )                                 ! FCT scheme : 2nd / 4th order
315               CALL lbc_lnk( 'stp_MLF', ts(:,:,:,:,Nbb), 'T', 1., ts(:,:,:,:,Nnn), 'T', 1.)
316               CALL lbc_lnk( 'stp_MLF', uu(:,:,:,Nnn), 'U', -1., vv(:,:,:,Nnn), 'V', -1., ww(:,:,:), 'W', 1.)
317         CASE ( np_MUS )                                 ! MUSCL
318                CALL lbc_lnk( 'stp_MLF', ts(:,:,:,:,Nbb), 'T', 1.)
319         CASE ( np_UBS )                                 ! UBS
320                CALL lbc_lnk( 'stp_MLF', ts(:,:,:,:,Nbb), 'T', 1.)
321         CASE ( np_QCK )                                 ! QUICKEST
322               CALL lbc_lnk( 'stp_MLF', uu(:,:,:,Nnn), 'U', -1., vv(:,:,:,Nnn), 'V', -1.)
323               CALL lbc_lnk( 'stp_MLF', ts(:,:,:,:,Nbb), 'T', 1.)
324         END SELECT
325      ENDIF
326
327      ! TEMP: [tiling] Separate loop over tile domains (due to tra_adv workarounds for tiling)
328      DO jtile = 1, nijtile
329         IF( ln_tile    )   CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = jtile )
330
331                            CALL tra_adv    ( kstp, Nbb, Nnn, ts, Nrhs )  ! hor. + vert. advection ==> RHS
332         IF( ln_zdfmfc  )   CALL tra_mfc    ( kstp, Nbb,      ts, Nrhs )  ! Mass Flux Convection
333         IF( ln_zdfosm  ) THEN
334                            CALL tra_osm    ( kstp,      Nnn, ts, Nrhs )  ! OSMOSIS non-local tracer fluxes ==> RHS
335            IF( lrst_oce )  CALL osm_rst    ( kstp,      Nnn, 'WRITE'  )  ! write OSMOSIS outputs + ww (so must do here) to restarts
336         ENDIF
337                            CALL tra_ldf    ( kstp, Nbb, Nnn, ts, Nrhs )  ! lateral mixing
338
339                            CALL tra_zdf    ( kstp, Nbb, Nnn, Nrhs, ts, Naa  )  ! vertical mixing and after tracer fields
340         IF( ln_zdfnpc  )   CALL tra_npc    ( kstp,      Nnn, Nrhs, ts, Naa  )  ! update after fields by non-penetrative convection
341      END DO
342
343      IF( ln_tile ) CALL dom_tile( ntsi, ntsj, ntei, ntej, ktile = 0 ) ! Revert to tile over full domain
344      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
345      ! Set boundary conditions, time filter and swap time levels
346      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
347!!jc1: For agrif, it would be much better to finalize tracers/momentum here (e.g. bdy conditions) and move the swap
348!!    (and time filtering) after Agrif update. Then restart would be done after and would contain updated fields.
349!!    If so:
350!!    (i) no need to call agrif update at initialization time
351!!    (ii) no need to update "before" fields
352!!
353!!    Apart from creating new tra_swp/dyn_swp routines, this however:
354!!    (i) makes boundary conditions at initialization time computed from updated fields which is not the case between
355!!    two restarts => restartability issue. One can circumvent this, maybe, by assuming "interface separation",
356!!    e.g. a shift of the feedback interface inside child domain.
357!!    (ii) requires that all restart outputs of updated variables by agrif (e.g. passive tracers/tke/barotropic arrays) are done at the same
358!!    place.
359!!
360      IF( ln_dynspg_ts ) CALL mlf_baro_corr (            Nnn, Naa, uu, vv     )   ! barotrope adjustment
361                         CALL finalize_lbc  ( kstp, Nbb     , Naa, uu, vv, ts )   ! boundary conditions
362                         CALL tra_atf_qco   ( kstp, Nbb, Nnn, Naa        , ts )   ! time filtering of "now" tracer arrays
363                         CALL dyn_atf_qco   ( kstp, Nbb, Nnn, Naa, uu, vv     )   ! time filtering of "now" velocities
364      IF(.NOT.lk_linssh) THEN
365                         r3t(:,:,Nnn) = r3t_f(:,:)                                ! update now ssh/h_0 with time filtered values
366                         r3u(:,:,Nnn) = r3u_f(:,:)
367                         r3v(:,:,Nnn) = r3v_f(:,:)
368      ENDIF
369      !
370      ! Swap time levels
371      Nrhs = Nbb
372      Nbb = Nnn
373      Nnn = Naa
374      Naa = Nrhs
375      !
376      !
377      IF( ln_diahsb  )   CALL dia_hsb       ( kstp, Nbb, Nnn )  ! - ML - global conservation diagnostics
378
379!!gm : This does not only concern the dynamics ==>>> add a new title
380!!gm2: why ouput restart before AGRIF update?
381!!
382!!jc: That would be better, but see comment above
383!!
384      IF( lrst_oce   )   CALL rst_write    ( kstp, Nbb, Nnn )   ! write output ocean restart file
385      IF( ln_sto_eos )   CALL sto_rst_write( kstp )   ! write restart file for stochastic parameters
386
387#if defined key_agrif
388      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
389      ! AGRIF recursive integration
390      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
391                         Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs      ! agrif_oce module copies of time level indices
392                         CALL Agrif_Integrate_ChildGrids( stp_MLF )       ! allows to finish all the Child Grids before updating
393
394#endif
395      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
396      ! Control
397      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
398                         CALL stp_ctl      ( kstp, Nnn )
399
400#if defined key_agrif
401      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
402      ! AGRIF update
403      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
404      IF( Agrif_NbStepint() == 0 .AND. nstop == 0 )   &
405         &               CALL Agrif_update_all( )                  ! Update all components
406
407#endif
408      IF( ln_diaobs .AND. nstop == 0 )   &
409         &               CALL dia_obs( kstp, Nnn )  ! obs-minus-model (assimilation) diags (after dynamics update)
410
411      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
412      ! File manipulation at the end of the first time step
413      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
414      IF( kstp == nit000 ) THEN                          ! 1st time step only
415                                        CALL iom_close( numror )   ! close input  ocean restart file
416         IF( lrxios )                   CALL iom_context_finalize( cr_ocerst_cxt )
417         IF(lwm)                        CALL FLUSH    ( numond )   ! flush output namelist oce
418         IF(lwm .AND. numoni /= -1 )    CALL FLUSH    ( numoni )   ! flush output namelist ice (if exist)
419      ENDIF
420
421      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
422      ! Coupled mode
423      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
424      IF( lk_oasis .AND. nstop == 0 )   CALL sbc_cpl_snd( kstp, Nbb, Nnn )     ! coupled mode : field exchanges
425      !
426#if defined key_xios
427      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
428      ! Finalize contextes if end of simulation or error detected
429      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
430      IF( kstp == nitend .OR. nstop > 0 ) THEN
431                      CALL iom_context_finalize(      cxios_context          ) ! needed for XIOS+AGRIF
432         IF( ln_crs ) CALL iom_context_finalize( trim(cxios_context)//"_crs" ) !
433      ENDIF
434#endif
435      !
436      IF( l_1st_euler ) THEN         ! recover Leap-frog timestep
437         rDt   = 2._wp * rn_Dt
438         r1_Dt = 1._wp / rDt
439         l_1st_euler = .FALSE.
440      ENDIF
441      !
442      IF( ln_timing )   CALL timing_stop('stp_MLF')
443      !
444   END SUBROUTINE stp_MLF
445
446
447   SUBROUTINE mlf_baro_corr( Kmm, Kaa, puu, pvv )
448      !!----------------------------------------------------------------------
449      !!                  ***  ROUTINE mlf_baro_corr  ***
450      !!
451      !! ** Purpose :   Finalize after horizontal velocity.
452      !!
453      !! ** Method  : * Ensure after velocities transport matches time splitting
454      !!             estimate (ln_dynspg_ts=T)
455      !!
456      !! ** Action :   puu(Kmm),pvv(Kmm)   updated now horizontal velocity (ln_bt_fw=F)
457      !!               puu(Kaa),pvv(Kaa)   after horizontal velocity
458      !!----------------------------------------------------------------------
459      USE dynspg_ts, ONLY : un_adv, vn_adv   ! updated Kmm barotropic transport
460      !!
461      INTEGER                             , INTENT(in   ) ::   Kmm, Kaa   ! before and after time level indices
462      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) ::   puu, pvv   ! velocities
463      !
464      INTEGER  ::   jk   ! dummy loop indices
465      REAL(wp), DIMENSION(jpi,jpj) ::   zue, zve
466      !!----------------------------------------------------------------------
467
468      ! Ensure below that barotropic velocities match time splitting estimate
469      ! Compute actual transport and replace it with ts estimate at "after" time step
470      zue(:,:) = e3u(:,:,1,Kaa) * puu(:,:,1,Kaa) * umask(:,:,1)
471      zve(:,:) = e3v(:,:,1,Kaa) * pvv(:,:,1,Kaa) * vmask(:,:,1)
472      DO jk = 2, jpkm1
473         zue(:,:) = zue(:,:) + e3u(:,:,jk,Kaa) * puu(:,:,jk,Kaa) * umask(:,:,jk)
474         zve(:,:) = zve(:,:) + e3v(:,:,jk,Kaa) * pvv(:,:,jk,Kaa) * vmask(:,:,jk)
475      END DO
476      DO jk = 1, jpkm1
477         puu(:,:,jk,Kaa) = ( puu(:,:,jk,Kaa) - zue(:,:) * r1_hu(:,:,Kaa) + uu_b(:,:,Kaa) ) * umask(:,:,jk)
478         pvv(:,:,jk,Kaa) = ( pvv(:,:,jk,Kaa) - zve(:,:) * r1_hv(:,:,Kaa) + vv_b(:,:,Kaa) ) * vmask(:,:,jk)
479      END DO
480      !
481      IF( .NOT.ln_bt_fw ) THEN
482         ! Remove advective velocity from "now velocities"
483         ! prior to asselin filtering
484         ! In the forward case, this is done below after asselin filtering
485         ! so that asselin contribution is removed at the same time
486         DO jk = 1, jpkm1
487            puu(:,:,jk,Kmm) = ( puu(:,:,jk,Kmm) - un_adv(:,:)*r1_hu(:,:,Kmm) + uu_b(:,:,Kmm) )*umask(:,:,jk)
488            pvv(:,:,jk,Kmm) = ( pvv(:,:,jk,Kmm) - vn_adv(:,:)*r1_hv(:,:,Kmm) + vv_b(:,:,Kmm) )*vmask(:,:,jk)
489         END DO
490      ENDIF
491      !
492   END SUBROUTINE mlf_baro_corr
493
494
495   SUBROUTINE finalize_lbc( kt, Kbb, Kaa, puu, pvv, pts )
496      !!----------------------------------------------------------------------
497      !!                  ***  ROUTINE finalize_lbc  ***
498      !!
499      !! ** Purpose :   Apply the boundary condition on the after velocity
500      !!
501      !! ** Method  : * Apply lateral boundary conditions on after velocity
502      !!             at the local domain boundaries through lbc_lnk call,
503      !!             at the one-way open boundaries (ln_bdy=T),
504      !!             at the AGRIF zoom   boundaries (lk_agrif=T)
505      !!
506      !! ** Action :   puu(Kaa),pvv(Kaa)   after horizontal velocity and tracers
507      !!----------------------------------------------------------------------
508#if defined key_agrif
509      USE agrif_oce_interp
510#endif
511      USE bdydyn         ! ocean open boundary conditions (define bdy_dyn)
512      !!
513      INTEGER                                  , INTENT(in   ) ::   kt         ! ocean time-step index
514      INTEGER                                  , INTENT(in   ) ::   Kbb, Kaa   ! before and after time level indices
515      REAL(wp), DIMENSION(jpi,jpj,jpk,jpt)     , INTENT(inout) ::   puu, pvv   ! velocities to be time filtered
516      REAL(wp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) ::   pts        ! active tracers
517      !!----------------------------------------------------------------------
518      !
519      ! Update after tracer and velocity on domain lateral boundaries
520      !
521# if defined key_agrif
522            CALL Agrif_tra                     !* AGRIF zoom boundaries
523            CALL Agrif_dyn( kt )
524# endif
525      !                                        ! local domain boundaries  (T-point, unchanged sign)
526      CALL lbc_lnk( 'finalize_lbc', puu(:,:,:,       Kaa), 'U', -1., pvv(:,:,:       ,Kaa), 'V', -1.   &
527                       &          , pts(:,:,:,jp_tem,Kaa), 'T',  1., pts(:,:,:,jp_sal,Kaa), 'T',  1. )
528      !
529      !                                        !* BDY open boundaries
530      IF( ln_bdy )   THEN
531                               CALL bdy_tra( kt, Kbb, pts,      Kaa )
532         IF( ln_dynspg_exp )   CALL bdy_dyn( kt, Kbb, puu, pvv, Kaa )
533         IF( ln_dynspg_ts  )   CALL bdy_dyn( kt, Kbb, puu, pvv, Kaa, dyn3d_only=.true. )
534      ENDIF
535      !
536   END SUBROUTINE finalize_lbc
537
538#else
539   !!----------------------------------------------------------------------
540   !!   default option             EMPTY MODULE           qco not activated
541   !!----------------------------------------------------------------------
542#endif
543   
544   !!======================================================================
545END MODULE stpmlf
Note: See TracBrowser for help on using the repository browser.