New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
step.F90 in NEMO/trunk/src/OCE – NEMO

source: NEMO/trunk/src/OCE/step.F90 @ 13970

Last change on this file since 13970 was 13970, checked in by andmirek, 3 years ago

Ticket #2462 into the trunk

  • Property svn:keywords set to Id
File size: 23.4 KB
RevLine 
[3]1MODULE step
2   !!======================================================================
3   !!                       ***  MODULE step  ***
[6140]4   !! Time-stepping   : manager of the ocean, tracer and ice time stepping
[3]5   !!======================================================================
[1438]6   !! History :  OPA  !  1991-03  (G. Madec)  Original code
[1492]7   !!             -   !  1991-11  (G. Madec)
8   !!             -   !  1992-06  (M. Imbard)  add a first output record
9   !!             -   !  1996-04  (G. Madec)  introduction of dynspg
10   !!             -   !  1996-04  (M.A. Foujols)  introduction of passive tracer
[1438]11   !!            8.0  !  1997-06  (G. Madec)  new architecture of call
12   !!            8.2  !  1997-06  (G. Madec, M. Imbard, G. Roullet)  free surface
13   !!             -   !  1999-02  (G. Madec, N. Grima)  hpg implicit
14   !!             -   !  2000-07  (J-M Molines, M. Imbard)  Open Bondary Conditions
15   !!   NEMO     1.0  !  2002-06  (G. Madec)  free form, suppress macro-tasking
16   !!             -   !  2004-08  (C. Talandier) New trends organization
[1492]17   !!             -   !  2005-01  (C. Ethe) Add the KPP closure scheme
18   !!             -   !  2005-11  (G. Madec)  Reorganisation of tra and dyn calls
19   !!             -   !  2006-01  (L. Debreu, C. Mazauric)  Agrif implementation
20   !!             -   !  2006-07  (S. Masson)  restart using iom
[1438]21   !!            3.2  !  2009-02  (G. Madec, R. Benshila)  reintroduicing z*-coordinate
[1533]22   !!             -   !  2009-06  (S. Masson, G. Madec)  TKE restart compatible with key_cpl
[2528]23   !!            3.3  !  2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
24   !!             -   !  2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase + merge TRC-TRA
[3294]25   !!            3.4  !  2011-04  (G. Madec, C. Ethe) Merge of dtatem and dtasal
[5836]26   !!            3.6  !  2012-07  (J. Simeon, G. Madec. C. Ethe)  Online coarsening of outputs
27   !!            3.6  !  2014-04  (F. Roquet, G. Madec) New equations of state
[7646]28   !!            3.6  !  2014-10  (E. Clementi, P. Oddo) Add Qiao vertical mixing in case of waves
[5836]29   !!            3.7  !  2014-10  (G. Madec)  LDF simplication
30   !!             -   !  2014-12  (G. Madec) remove KPP scheme
[9019]31   !!             -   !  2015-11  (J. Chanut) free surface simplification (remove filtered free surface)
32   !!            4.0  !  2017-05  (G. Madec)  introduction of the vertical physics manager (zdfphy)
[12377]33   !!            4.1  !  2019-08  (A. Coward, D. Storkey) rewrite in preparation for new timestepping scheme
[3]34   !!----------------------------------------------------------------------
[13237]35#if defined key_qco
[888]36   !!----------------------------------------------------------------------
[13237]37   !!   'key_qco'      EMPTY MODULE      Quasi-Eulerian vertical coordonate
38   !!----------------------------------------------------------------------
39#else
40   !!----------------------------------------------------------------------
[2528]41   !!   stp             : OPA system time-stepping
[3]42   !!----------------------------------------------------------------------
[3764]43   USE step_oce         ! time stepping definition modules
[6140]44   !
45   USE iom              ! xIOs server
[389]46
[3]47   IMPLICIT NONE
48   PRIVATE
49
[5836]50   PUBLIC   stp   ! called by nemogcm.F90
[3]51
52   !!----------------------------------------------------------------------
[12377]53   !! time level indices
54   !!----------------------------------------------------------------------
55   INTEGER, PUBLIC :: Nbb, Nnn, Naa, Nrhs          !! used by nemo_init
56
57   !!----------------------------------------------------------------------
[9598]58   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[888]59   !! $Id$
[10068]60   !! Software governed by the CeCILL license (see ./LICENSE)
[3]61   !!----------------------------------------------------------------------
62CONTAINS
63
[508]64#if defined key_agrif
[5656]65   RECURSIVE SUBROUTINE stp( )
[1438]66      INTEGER             ::   kstp   ! ocean time-step index
[508]67#else
[467]68   SUBROUTINE stp( kstp )
[1438]69      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
[467]70#endif
71      !!----------------------------------------------------------------------
[3]72      !!                     ***  ROUTINE stp  ***
[3764]73      !!
[9019]74      !! ** Purpose : - Time stepping of OPA  (momentum and active tracer eqs.)
[9570]75      !!              - Time stepping of SI3 (dynamic and thermodynamic eqs.)
[9019]76      !!              - Time stepping of TRC  (passive tracer eqs.)
[3764]77      !!
78      !! ** Method  : -1- Update forcings and data
79      !!              -2- Update ocean physics
80      !!              -3- Compute the t and s trends
81      !!              -4- Update t and s
[3]82      !!              -5- Compute the momentum trends
83      !!              -6- Update the horizontal velocity
[5836]84      !!              -7- Compute the diagnostics variables (rd,N2, hdiv,w)
[3]85      !!              -8- Outputs and diagnostics
86      !!----------------------------------------------------------------------
[9019]87      INTEGER ::   ji, jj, jk   ! dummy loop indice
88!!gm kcall can be removed, I guess
89      INTEGER ::   kcall        ! optional integer argument (dom_vvl_sf_nxt)
[3]90      !! ---------------------------------------------------------------------
[392]91#if defined key_agrif
[12933]92      IF( nstop > 0 ) RETURN   ! avoid to go further if an error was detected during previous time step (child grid)
[389]93      kstp = nit000 + Agrif_Nb_Step()
[12377]94      Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs   ! agrif_oce module copies of time level indices
[5836]95      IF( lk_agrif_debug ) THEN
96         IF( Agrif_Root() .and. lwp)   WRITE(*,*) '---'
97         IF(lwp)   WRITE(*,*) 'Grid Number', Agrif_Fixed(),' time step ', kstp, 'int tstep', Agrif_NbStepint()
[5656]98      ENDIF
[5836]99      IF( kstp == nit000 + 1 )   lk_agrif_fstep = .FALSE.
[1793]100# if defined key_iomput
[5407]101      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap( cxios_context )
[3764]102# endif
103#endif
[9124]104      !
105      IF( ln_timing )   CALL timing_start('stp')
106      !
[5836]107      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[12489]108      ! model timestep
109      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
110      !
111      IF( l_1st_euler ) THEN 
112         ! start or restart with Euler 1st time-step
113         rDt =  rn_Dt   
114         r1_Dt = 1._wp / rDt
115      ENDIF
116      !
117      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[5836]118      ! update I/O and calendar
119      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
120      IF( kstp == nit000 ) THEN                       ! initialize IOM context (must be done after nemo_init for AGRIF+XIOS+OASIS)
[12933]121                             CALL iom_init( cxios_context, ld_closedef=.FALSE. )   ! for model grid (including possible AGRIF zoom)
[12377]122         IF( lk_diamlr   )   CALL dia_mlr_iom_init    ! with additional setup for multiple-linear-regression analysis
123                             CALL iom_init_closedef
[5836]124         IF( ln_crs      )   CALL iom_init( TRIM(cxios_context)//"_crs" )  ! for coarse grid
[4152]125      ENDIF
[13970]126      IF((kstp == nitrst) .AND. lwxios) THEN
127         CALL iom_swap(      cw_ocerst_cxt          )
128         CALL iom_init_closedef(cw_ocerst_cxt)
129         CALL iom_setkt( kstp - nit000 + 1,      cw_ocerst_cxt          )
130#if defined key_top
131         CALL iom_swap(      cw_toprst_cxt          )
132         CALL iom_init_closedef(cw_toprst_cxt)
133         CALL iom_setkt( kstp - nit000 + 1,      cw_toprst_cxt          )
134#endif
135      ENDIF
136#if defined key_si3
137      IF(((kstp + nn_fsbc - 1) == nitrst) .AND. lwxios) THEN
138         CALL iom_swap(      cw_icerst_cxt          )
139         CALL iom_init_closedef(cw_icerst_cxt)
140         CALL iom_setkt( kstp - nit000 + 1,      cw_icerst_cxt          )
141      ENDIF
142#endif
[1725]143      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
[5836]144                             CALL iom_setkt( kstp - nit000 + 1,      cxios_context          )   ! tell IOM we are at time step kstp
145      IF( ln_crs         )   CALL iom_setkt( kstp - nit000 + 1, TRIM(cxios_context)//"_crs" )   ! tell IOM we are at time step kstp
[3]146
147      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[12377]148      ! Update external forcing (tides, open boundaries, ice shelf interaction and surface boundary condition (including sea-ice)
[3]149      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12377]150      IF( ln_tide    )   CALL tide_update( kstp )                     ! update tide potential
151      IF( ln_apr_dyn )   CALL sbc_apr ( kstp )                        ! atmospheric pressure (NB: call before bdy_dta which needs ssh_ib)
152      IF( ln_bdy     )   CALL bdy_dta ( kstp, Nnn )                   ! update dynamic & tracer data at open boundaries
153      IF( ln_isf     )   CALL isf_stp ( kstp, Nnn )
154                         CALL sbc     ( kstp, Nbb, Nnn )              ! Sea Boundary Condition (including sea-ice)
[5836]155
[3]156      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[5329]157      ! Update stochastic parameters and random T/S fluctuations
158      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[6464]159      IF( ln_sto_eos ) CALL sto_par( kstp )          ! Stochastic parameters
[12377]160      IF( ln_sto_eos ) CALL sto_pts( ts(:,:,:,:,Nnn)  )          ! Random T/S fluctuations
[5329]161
162      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[9490]163      ! Ocean physics update
[3]164      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[4990]165      !  THERMODYNAMICS
[12377]166                         CALL eos_rab( ts(:,:,:,:,Nbb), rab_b, Nnn )       ! before local thermal/haline expension ratio at T-points
167                         CALL eos_rab( ts(:,:,:,:,Nnn), rab_n, Nnn )       ! now    local thermal/haline expension ratio at T-points
168                         CALL bn2    ( ts(:,:,:,:,Nbb), rab_b, rn2b, Nnn ) ! before Brunt-Vaisala frequency
169                         CALL bn2    ( ts(:,:,:,:,Nnn), rab_n, rn2, Nnn  ) ! now    Brunt-Vaisala frequency
[5836]170
[3764]171      !  VERTICAL PHYSICS
[12377]172                         CALL zdf_phy( kstp, Nbb, Nnn, Nrhs )   ! vertical physics update (top/bot drag, avt, avs, avm + MLD)
[5836]173
[3764]174      !  LATERAL  PHYSICS
[1492]175      !
[5836]176      IF( l_ldfslp ) THEN                             ! slope of lateral mixing
[12377]177                         CALL eos( ts(:,:,:,:,Nbb), rhd, gdept_0(:,:,:) )               ! before in situ density
[5836]178
[12377]179         IF( ln_zps .AND. .NOT. ln_isfcav)                                    &
180            &            CALL zps_hde    ( kstp, Nnn, jpts, ts(:,:,:,:,Nbb), gtsu, gtsv,  &  ! Partial steps: before horizontal gradient
181            &                                          rhd, gru , grv    )       ! of t, s, rd at the last ocean level
[5836]182
[12377]183         IF( ln_zps .AND.       ln_isfcav)                                                &
184            &            CALL zps_hde_isf( kstp, Nnn, jpts, ts(:,:,:,:,Nbb), gtsu, gtsv, gtui, gtvi,  &  ! Partial steps for top cell (ISF)
185            &                                          rhd, gru , grv , grui, grvi   )       ! of t, s, rd at the first ocean level
[5836]186         IF( ln_traldf_triad ) THEN
[12377]187                         CALL ldf_slp_triad( kstp, Nbb, Nnn )             ! before slope for triad operator
[5836]188         ELSE     
[12377]189                         CALL ldf_slp     ( kstp, rhd, rn2b, Nbb, Nnn )   ! before slope for standard operator
[2528]190         ENDIF
[1481]191      ENDIF
[12377]192      !                                                                        ! eddy diffusivity coeff.
193      IF( l_ldftra_time .OR. l_ldfeiv_time )   CALL ldf_tra( kstp, Nbb, Nnn )  !       and/or eiv coeff.
194      IF( l_ldfdyn_time                    )   CALL ldf_dyn( kstp, Nbb )       ! eddy viscosity coeff.
195
[4369]196      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[5930]197      !  Ocean dynamics : hdiv, ssh, e3, u, v, w
[4369]198      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[5930]199
[12377]200                            CALL ssh_nxt       ( kstp, Nbb, Nnn, ssh, Naa )    ! after ssh (includes call to div_hor)
201      IF( .NOT.ln_linssh )  CALL dom_vvl_sf_nxt( kstp, Nbb, Nnn,      Naa )    ! after vertical scale factors
[13237]202                            CALL wzv           ( kstp, Nbb, Nnn, Naa, ww  )    ! now cross-level velocity
[12377]203      IF( ln_zad_Aimp )     CALL wAimp         ( kstp,      Nnn           )  ! Adaptive-implicit vertical advection partitioning
204                            CALL eos    ( ts(:,:,:,:,Nnn), rhd, rhop, gdept(:,:,:,Nnn) )  ! now in situ density for hpg computation
[6140]205                           
[7753]206                           
[12377]207                         uu(:,:,:,Nrhs) = 0._wp            ! set dynamics trends to zero
208                         vv(:,:,:,Nrhs) = 0._wp
[4369]209
[5930]210      IF(  lk_asminc .AND. ln_asmiau .AND. ln_dyninc )   &
[12377]211               &         CALL dyn_asm_inc   ( kstp, Nbb, Nnn, uu, vv, Nrhs )  ! apply dynamics assimilation increment
212      IF( ln_bdy     )   CALL bdy_dyn3d_dmp ( kstp, Nbb,      uu, vv, Nrhs )  ! bdy damping trends
[4369]213#if defined key_agrif
[5930]214      IF(.NOT. Agrif_Root())  & 
215               &         CALL Agrif_Sponge_dyn        ! momentum sponge
[4369]216#endif
[12377]217                         CALL dyn_adv( kstp, Nbb, Nnn      , uu, vv, Nrhs )  ! advection (VF or FF)   ==> RHS
218                         CALL dyn_vor( kstp,      Nnn      , uu, vv, Nrhs )  ! vorticity              ==> RHS
219                         CALL dyn_ldf( kstp, Nbb, Nnn      , uu, vv, Nrhs )  ! lateral mixing
220      IF( ln_zdfosm  )   CALL dyn_osm( kstp,      Nnn      , uu, vv, Nrhs )  ! OSMOSIS non-local velocity fluxes ==> RHS
221                         CALL dyn_hpg( kstp,      Nnn      , uu, vv, Nrhs )  ! horizontal gradient of Hydrostatic pressure
222                         CALL dyn_spg( kstp, Nbb, Nnn, Nrhs, uu, vv, ssh, uu_b, vv_b, Naa )  ! surface pressure gradient
[4369]223
[12377]224                                                      ! With split-explicit free surface, since now transports have been updated and ssh(:,:,Nrhs) as well
[5930]225      IF( ln_dynspg_ts ) THEN                         ! vertical scale factors and vertical velocity need to be updated
[12377]226                            CALL div_hor       ( kstp, Nbb, Nnn )                ! Horizontal divergence  (2nd call in time-split case)
227         IF(.NOT.ln_linssh) CALL dom_vvl_sf_nxt( kstp, Nbb, Nnn, Naa, kcall=2 )  ! after vertical scale factors (update depth average component)
[11287]228      ENDIF
[12377]229                            CALL dyn_zdf    ( kstp, Nbb, Nnn, Nrhs, uu, vv, Naa  )  ! vertical diffusion
230      IF( ln_dynspg_ts ) THEN                                                       ! vertical scale factors and vertical velocity need to be updated
[13237]231                            CALL wzv        ( kstp, Nbb, Nnn, Naa, ww )             ! now cross-level velocity
[12377]232         IF( ln_zad_Aimp )  CALL wAimp      ( kstp,      Nnn )                      ! Adaptive-implicit vertical advection partitioning
[4369]233      ENDIF
[12276]234     
[5930]235
[1482]236      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[6140]237      ! cool skin
238      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
[12377]239      IF ( ln_diurnal )  CALL diurnal_layers( kstp )
[6140]240     
241      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[9490]242      ! diagnostics and outputs
[1482]243      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12377]244      IF( ln_floats  )   CALL flo_stp   ( kstp, Nbb, Nnn )      ! drifting Floats
245      IF( ln_diacfl  )   CALL dia_cfl   ( kstp,      Nnn )      ! Courant number diagnostics
246                         CALL dia_hth   ( kstp,      Nnn )      ! Thermocline depth (20 degres isotherm depth)
247      IF( ln_diadct  )   CALL dia_dct   ( kstp,      Nnn )      ! Transports
248                         CALL dia_ar5   ( kstp,      Nnn )      ! ar5 diag
249                         CALL dia_ptr   ( kstp,      Nnn )      ! Poleward adv/ldf TRansports diagnostics
250                         CALL dia_wri   ( kstp,      Nnn )      ! ocean model: outputs
251      IF( ln_crs     )   CALL crs_fld   ( kstp,      Nnn )      ! ocean model: online field coarsening & output
252      IF( lk_diadetide ) CALL dia_detide( kstp )                ! Weights computation for daily detiding of model diagnostics
253      IF( lk_diamlr  )   CALL dia_mlr                           ! Update time used in multiple-linear-regression analysis
[6140]254     
[923]255#if defined key_top
[3]256      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
257      ! Passive Tracer Model
258      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12377]259                         CALL trc_stp       ( kstp, Nbb, Nnn, Nrhs, Naa )  ! time-stepping
[3]260#endif
261
262      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[5930]263      ! Active tracers                             
[3]264      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12377]265                         ts(:,:,:,:,Nrhs) = 0._wp         ! set tracer trends to zero
[3]266
[5656]267      IF(  lk_asminc .AND. ln_asmiau .AND. &
[12377]268         & ln_trainc )   CALL tra_asm_inc( kstp, Nbb, Nnn, ts, Nrhs )  ! apply tracer assimilation increment
269                         CALL tra_sbc    ( kstp,      Nnn, ts, Nrhs )  ! surface boundary condition
270      IF( ln_traqsr  )   CALL tra_qsr    ( kstp,      Nnn, ts, Nrhs )  ! penetrative solar radiation qsr
271      IF( ln_isf     )   CALL tra_isf    ( kstp,      Nnn, ts, Nrhs )  ! ice shelf heat flux
272      IF( ln_trabbc  )   CALL tra_bbc    ( kstp,      Nnn, ts, Nrhs )  ! bottom heat flux
273      IF( ln_trabbl  )   CALL tra_bbl    ( kstp, Nbb, Nnn, ts, Nrhs )  ! advective (and/or diffusive) bottom boundary layer scheme
274      IF( ln_tradmp  )   CALL tra_dmp    ( kstp, Nbb, Nnn, ts, Nrhs )  ! internal damping trends
275      IF( ln_bdy     )   CALL bdy_tra_dmp( kstp, Nbb,      ts, Nrhs )  ! bdy damping trends
[392]276#if defined key_agrif
[5930]277      IF(.NOT. Agrif_Root())  & 
278               &         CALL Agrif_Sponge_tra        ! tracers sponge
[389]279#endif
[12377]280                         CALL tra_adv    ( kstp, Nbb, Nnn, ts, Nrhs )  ! hor. + vert. advection ==> RHS
281      IF( ln_zdfosm  )   CALL tra_osm    ( kstp,      Nnn, ts, Nrhs )  ! OSMOSIS non-local tracer fluxes ==> RHS
[9019]282      IF( lrst_oce .AND. ln_zdfosm ) &
[12377]283           &             CALL osm_rst    ( kstp,      Nnn, 'WRITE'  )  ! write OSMOSIS outputs + ww (so must do here) to restarts
284                         CALL tra_ldf    ( kstp, Nbb, Nnn, ts, Nrhs )  ! lateral mixing
[1239]285
[12377]286                         CALL tra_zdf    ( kstp, Nbb, Nnn, Nrhs, ts, Naa  )  ! vertical mixing and after tracer fields
287      IF( ln_zdfnpc  )   CALL tra_npc    ( kstp,      Nnn, Nrhs, ts, Naa  )  ! update after fields by non-penetrative convection
[1481]288
[3]289      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[12377]290      ! Set boundary conditions, time filter and swap time levels
[3]291      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[5930]292!!jc1: For agrif, it would be much better to finalize tracers/momentum here (e.g. bdy conditions) and move the swap
293!!    (and time filtering) after Agrif update. Then restart would be done after and would contain updated fields.
294!!    If so:
295!!    (i) no need to call agrif update at initialization time
296!!    (ii) no need to update "before" fields
297!!
298!!    Apart from creating new tra_swp/dyn_swp routines, this however:
299!!    (i) makes boundary conditions at initialization time computed from updated fields which is not the case between
300!!    two restarts => restartability issue. One can circumvent this, maybe, by assuming "interface separation",
301!!    e.g. a shift of the feedback interface inside child domain.
302!!    (ii) requires that all restart outputs of updated variables by agrif (e.g. passive tracers/tke/barotropic arrays) are done at the same
303!!    place.
304!!
[12377]305!!jc2: dynnxt must be the latest call. e3t(:,:,:,Nbb) are indeed updated in that routine
306                         CALL tra_atf       ( kstp, Nbb, Nnn, Naa, ts )                      ! time filtering of "now" tracer arrays
307                         CALL dyn_atf       ( kstp, Nbb, Nnn, Naa, uu, vv, e3t, e3u, e3v  )  ! time filtering of "now" velocities and scale factors
308                         CALL ssh_atf       ( kstp, Nbb, Nnn, Naa, ssh )                     ! time filtering of "now" sea surface height
[5656]309      !
[12377]310      ! Swap time levels
311      Nrhs = Nbb
312      Nbb = Nnn
313      Nnn = Naa
314      Naa = Nrhs
315      !
316      IF(.NOT.ln_linssh) CALL dom_vvl_sf_update( kstp, Nbb, Nnn, Naa )  ! recompute vertical scale factors
317      !
318      IF( ln_diahsb  )   CALL dia_hsb       ( kstp, Nbb, Nnn )  ! - ML - global conservation diagnostics
[5836]319
320!!gm : This does not only concern the dynamics ==>>> add a new title
321!!gm2: why ouput restart before AGRIF update?
[5930]322!!
323!!jc: That would be better, but see comment above
324!!
[12377]325      IF( lrst_oce   )   CALL rst_write    ( kstp, Nbb, Nnn )   ! write output ocean restart file
[9210]326      IF( ln_sto_eos )   CALL sto_rst_write( kstp )   ! write restart file for stochastic parameters
[593]327
[5656]328#if defined key_agrif
329      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[12650]330      ! AGRIF recursive integration
[5656]331      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
[12377]332                         Kbb_a = Nbb; Kmm_a = Nnn; Krhs_a = Nrhs      ! agrif_oce module copies of time level indices
333                         CALL Agrif_Integrate_ChildGrids( stp )       ! allows to finish all the Child Grids before updating
[12933]334
[9485]335#endif
[3]336      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[5656]337      ! Control
[3]338      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12933]339                         CALL stp_ctl      ( kstp, Nnn )
340
[12650]341#if defined key_agrif
342      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
343      ! AGRIF update
344      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
345      IF( Agrif_NbStepint() == 0 .AND. nstop == 0 ) THEN
346                         CALL Agrif_update_all( )                  ! Update all components
347      ENDIF
[12933]348
[12650]349#endif
[12933]350      IF( ln_diaobs .AND. nstop == 0 )  CALL dia_obs( kstp, Nnn )  ! obs-minus-model (assimilation) diags (after dynamics update)
[12650]351
352      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
353      ! File manipulation at the end of the first time step
354      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<                         
[9210]355      IF( kstp == nit000 ) THEN                          ! 1st time step only
356                                        CALL iom_close( numror )   ! close input  ocean restart file
[13970]357         IF( lrxios )                   CALL iom_context_finalize(      cr_ocerst_cxt         )
[9210]358         IF(lwm)                        CALL FLUSH    ( numond )   ! flush output namelist oce
359         IF(lwm .AND. numoni /= -1 )    CALL FLUSH    ( numoni )   ! flush output namelist ice (if exist)
[1482]360      ENDIF
[3]361
[508]362      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[75]363      ! Coupled mode
364      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[12933]365      IF( lk_oasis .AND. nstop == 0 )   CALL sbc_cpl_snd( kstp, Nbb, Nnn )     ! coupled mode : field exchanges
[508]366      !
[4153]367#if defined key_iomput
[12650]368      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
369      ! Finalize contextes if end of simulation or error detected
370      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<                         
[12933]371      IF( kstp == nitend .OR. nstop > 0 ) THEN
[5407]372                      CALL iom_context_finalize(      cxios_context          ) ! needed for XIOS+AGRIF
373         IF( ln_crs ) CALL iom_context_finalize( trim(cxios_context)//"_crs" ) !
[4152]374      ENDIF
[4153]375#endif
[3769]376      !
[12489]377      IF( l_1st_euler ) THEN         ! recover Leap-frog timestep
378         rDt = 2._wp * rn_Dt   
379         r1_Dt = 1._wp / rDt
380         l_1st_euler = .FALSE.     
381      ENDIF
382      !
[9210]383      IF( ln_timing )   CALL timing_stop('stp')
[1481]384      !
[3]385   END SUBROUTINE stp
[12377]386   !
[13237]387#endif
[9019]388   !!======================================================================
[3]389END MODULE step
Note: See TracBrowser for help on using the repository browser.