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 branches/UKMO/AMM15_v3_6_STABLE_package_collate_utils366_fabmv1/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/UKMO/AMM15_v3_6_STABLE_package_collate_utils366_fabmv1/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 13462

Last change on this file since 13462 was 13462, checked in by dford, 21 months ago

Tidy up.

File size: 26.8 KB
Line 
1MODULE step
2   !!======================================================================
3   !!                       ***  MODULE step  ***
4   !! Time-stepping    : manager of the ocean, tracer and ice time stepping
5   !!======================================================================
6   !! History :  OPA  !  1991-03  (G. Madec)  Original code
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
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
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
21   !!            3.2  !  2009-02  (G. Madec, R. Benshila)  reintroduicing z*-coordinate
22   !!             -   !  2009-06  (S. Masson, G. Madec)  TKE restart compatible with key_cpl
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
25   !!            3.4  !  2011-04  (G. Madec, C. Ethe) Merge of dtatem and dtasal
26   !!                 !  2012-07  (J. Simeon, G. Madec, C. Ethe) Online coarsening of outputs
27   !!            3.6  !  2014-10  (E. Clementi, P. Oddo) Add Qiao vertical mixing in case of waves
28   !!            3.7  !  2014-04  (F. Roquet, G. Madec) New equations of state
29   !!----------------------------------------------------------------------
30
31   !!----------------------------------------------------------------------
32   !!   stp             : OPA system time-stepping
33   !!----------------------------------------------------------------------
34   USE step_oce         ! time stepping definition modules
35   USE iom
36
37   IMPLICIT NONE
38   PRIVATE
39
40   PUBLIC   stp   ! called by opa.F90
41
42   !! * Substitutions
43#  include "domzgr_substitute.h90"
44!!gm   #  include "zdfddm_substitute.h90"
45   !!----------------------------------------------------------------------
46   !! NEMO/OPA 3.7 , NEMO Consortium (2014)
47   !! $Id$
48   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50CONTAINS
51
52#if defined key_agrif
53   RECURSIVE SUBROUTINE stp( )
54      INTEGER             ::   kstp   ! ocean time-step index
55#else
56   SUBROUTINE stp( kstp )
57      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
58#endif
59      !!----------------------------------------------------------------------
60      !!                     ***  ROUTINE stp  ***
61      !!
62      !! ** Purpose : - Time stepping of OPA (momentum and active tracer eqs.)
63      !!              - Time stepping of LIM (dynamic and thermodynamic eqs.)
64      !!              - Tme stepping  of TRC (passive tracer eqs.)
65      !!
66      !! ** Method  : -1- Update forcings and data
67      !!              -2- Update ocean physics
68      !!              -3- Compute the t and s trends
69      !!              -4- Update t and s
70      !!              -5- Compute the momentum trends
71      !!              -6- Update the horizontal velocity
72      !!              -7- Compute the diagnostics variables (rd,N2, div,cur,w)
73      !!              -8- Outputs and diagnostics
74      !!----------------------------------------------------------------------
75      INTEGER ::   ji,jj,jk ! dummy loop indice
76      INTEGER ::   indic    ! error indicator if < 0
77      INTEGER ::   kcall    ! optional integer argument (dom_vvl_sf_nxt)
78      !! ---------------------------------------------------------------------
79
80#if defined key_agrif
81      kstp = nit000 + Agrif_Nb_Step()
82      IF ( lk_agrif_debug ) THEN
83         IF ( Agrif_Root() .and. lwp) Write(*,*) '---'
84         IF (lwp) Write(*,*) 'Grid Number',Agrif_Fixed(),' time step ',kstp, 'int tstep',Agrif_NbStepint()
85      ENDIF
86
87      IF ( kstp == (nit000 + 1) ) lk_agrif_fstep = .FALSE.
88
89# if defined key_iomput
90      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap( cxios_context )
91# endif
92#endif
93                             indic = 0           ! reset to no error condition
94      IF( kstp == nit000 ) THEN
95         ! must be done after nemo_init for AGRIF+XIOS+OASIS
96                      CALL iom_init(      cxios_context          )  ! iom_put initialization
97         IF( ln_crs ) CALL iom_init( TRIM(cxios_context)//"_crs" )  ! initialize context for coarse grid
98         
99#if defined key_fabm
100         ! FABM can only finish initialising once IOM has
101         IF ( lk_fabm ) CALL nemo_fabm_start
102#endif
103         
104         ! First call to dia_* and asm_inc_init must wait for FABM to be initialised
105         ! (if running with FABM, but no harm moving the calls to here from nemo_init either way)
106         CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
107         
108         IF( lk_asminc ) THEN 
109#if defined key_shelf
110            CALL  zdf_mxl_tref()     ! Initialization of hmld_tref
111#endif
112            CALL asm_inc_init     ! Initialize assimilation increments
113            IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 )    ! Output background fields
114            IF( ln_asmdin ) THEN                        ! Direct initialization
115               IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 )    ! Tracers
116               IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 )    ! Dynamics
117               IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 )    ! SSH
118               IF( lk_bgcinc ) CALL bgc_asm_inc( nit000 - 1 )    ! BGC
119            ENDIF
120         ENDIF
121         
122         CALL dia_tmb_init        ! TMB outputs
123         CALL dia_25h_init        ! 25h mean  outputs
124         CALL dia_diaopfoam_init  ! FOAM operational output
125      ENDIF
126
127      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
128                             CALL iom_setkt( kstp - nit000 + 1,      cxios_context          )   ! tell iom we are at time step kstp
129      IF( ln_crs     )       CALL iom_setkt( kstp - nit000 + 1, TRIM(cxios_context)//"_crs" )   ! tell iom we are at time step kstp
130
131      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
132      ! Update data, open boundaries, surface boundary condition (including sea-ice)
133      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
134      IF( lk_tide    )   CALL sbc_tide( kstp )
135                         CALL sbc     ( kstp )        ! Sea Boundary Condition (including sea-ice)
136                                                      ! clem: moved here for bdy ice purpose
137      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
138      ! Update stochastic parameters and random T/S fluctuations
139      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
140       IF( ln_sto_eos ) CALL sto_par( kstp )          ! Stochastic parameters
141       IF( ln_sto_eos ) CALL sto_pts( tsn  )          ! Random T/S fluctuations
142
143      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
144      ! Ocean physics update                (ua, va, tsa used as workspace)
145      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
146      !  THERMODYNAMICS
147                         CALL eos_rab( tsb, rab_b )       ! before local thermal/haline expension ratio at T-points
148                         CALL eos_rab( tsn, rab_n )       ! now    local thermal/haline expension ratio at T-points
149                         CALL bn2    ( tsb, rab_b, rn2b ) ! before Brunt-Vaisala frequency
150                         CALL bn2    ( tsn, rab_n, rn2  ) ! now    Brunt-Vaisala frequency
151      !
152      !  VERTICAL PHYSICS
153                         CALL zdf_bfr( kstp )         ! bottom friction (if quadratic)
154      !                                               ! Vertical eddy viscosity and diffusivity coefficients
155      IF( lk_zdfric  )   CALL zdf_ric( kstp )            ! Richardson number dependent Kz
156      IF( lk_zdftke  )   CALL zdf_tke( kstp )            ! TKE closure scheme for Kz
157      IF( lk_zdfgls  )   CALL zdf_gls( kstp )            ! GLS closure scheme for Kz
158      IF( ln_zdfqiao )   CALL zdf_qiao( kstp )           ! Qiao vertical mixing   
159      !
160      IF( lk_zdfkpp  )   CALL zdf_kpp( kstp )            ! KPP closure scheme for Kz
161      IF( lk_zdfcst  ) THEN                              ! Constant Kz (reset avt, avm[uv] to the background value)
162         avt (:,:,:) = rn_avt0 * wmask (:,:,:)
163         avmu(:,:,:) = rn_avm0 * wumask(:,:,:)
164         avmv(:,:,:) = rn_avm0 * wvmask(:,:,:)
165      ENDIF
166      IF( ln_rnf_mouth ) THEN                         ! increase diffusivity at rivers mouths
167         DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:) * tmask(:,:,jk)   ;   END DO
168      ENDIF
169      IF( ln_zdfevd  )   CALL zdf_evd( kstp )         ! enhanced vertical eddy diffusivity
170
171      IF( lk_zdftmx  )   CALL zdf_tmx( kstp )         ! tidal vertical mixing
172
173      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
174         &               CALL zdf_ddm( kstp )         ! double diffusive mixing
175
176                         CALL zdf_mxl( kstp )         ! mixed layer depth
177
178                                                      ! write TKE or GLS information in the restart file
179      IF( lrst_oce .AND. lk_zdftke )   CALL tke_rst( kstp, 'WRITE' )
180      IF( lrst_oce .AND. lk_zdfgls )   CALL gls_rst( kstp, 'WRITE' )
181      !
182      !  LATERAL  PHYSICS
183      !
184      IF( lk_ldfslp ) THEN                            ! slope of lateral mixing
185                         CALL eos( tsb, rhd, gdept_0(:,:,:) )               ! before in situ density
186         IF( ln_zps .AND. .NOT. ln_isfcav)                               &
187            &            CALL zps_hde    ( kstp, jpts, tsb, gtsu, gtsv,  &  ! Partial steps: before horizontal gradient
188            &                                          rhd, gru , grv    )  ! of t, s, rd at the last ocean level
189         IF( ln_zps .AND.       ln_isfcav)                               &
190            &            CALL zps_hde_isf( kstp, jpts, tsb, gtsu, gtsv,  &    ! Partial steps for top cell (ISF)
191            &                                          rhd, gru , grv , aru , arv , gzu , gzv , ge3ru , ge3rv ,   &
192            &                                   gtui, gtvi, grui, grvi, arui, arvi, gzui, gzvi, ge3rui, ge3rvi    ) ! of t, s, rd at the first ocean level
193         IF( ln_traldf_grif ) THEN                           ! before slope for Griffies operator
194                         CALL ldf_slp_grif( kstp )
195         ELSE
196                         CALL ldf_slp( kstp, rhd, rn2b )     ! before slope for Madec operator
197         ENDIF
198      ENDIF
199#if defined key_traldf_c2d
200      IF( lk_traldf_eiv )   CALL ldf_eiv( kstp )      ! eddy induced velocity coefficient
201#endif
202#if defined key_traldf_c3d && defined key_traldf_smag
203                          CALL ldf_tra_smag( kstp )      ! eddy induced velocity coefficient
204#  endif
205#if defined key_dynldf_c3d && defined key_dynldf_smag
206                          CALL ldf_dyn_smag( kstp )      ! eddy induced velocity coefficient
207#  endif
208
209      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
210      !  Ocean dynamics : hdiv, rot, ssh, e3, wn
211      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
212                         CALL ssh_nxt       ( kstp )  ! after ssh (includes call to div_cur)
213      IF( lk_vvl     )   CALL dom_vvl_sf_nxt( kstp )  ! after vertical scale factors
214                         CALL wzv           ( kstp )  ! now cross-level velocity
215
216      IF( lk_dynspg_ts ) THEN 
217          ! In case the time splitting case, update almost all momentum trends here:
218          ! Note that the computation of vertical velocity above, hence "after" sea level
219          ! is necessary to compute momentum advection for the rhs of barotropic loop:
220                            CALL eos    ( tsn, rhd, rhop, fsdept_n(:,:,:) ) ! now in situ density for hpg computation
221            IF( ln_zps .AND. .NOT. ln_isfcav)                               &
222               &            CALL zps_hde    ( kstp, jpts, tsn, gtsu, gtsv,  &    ! Partial steps: before horizontal gradient
223               &                                          rhd, gru , grv    )  ! of t, s, rd at the last ocean level
224            IF( ln_zps .AND.       ln_isfcav)                               &
225               &            CALL zps_hde_isf( kstp, jpts, tsn, gtsu, gtsv,  &    ! Partial steps for top cell (ISF)
226               &                                          rhd, gru , grv , aru , arv , gzu , gzv , ge3ru , ge3rv ,   &
227               &                                   gtui, gtvi, grui, grvi, arui, arvi, gzui, gzvi, ge3rui, ge3rvi    ) ! of t, s, rd at the last ocean level
228
229                                  ua(:,:,:) = 0.e0             ! set dynamics trends to zero
230                                  va(:,:,:) = 0.e0
231          IF(  lk_asminc .AND. ln_asmiau .AND. &
232             & ln_dyninc       )  CALL dyn_asm_inc  ( kstp )   ! apply dynamics assimilation increment
233          IF( ln_neptsimp )       CALL dyn_nept_cor ( kstp )   ! subtract Neptune velocities (simplified)
234          IF( lk_bdy           )  CALL bdy_dyn3d_dmp( kstp )   ! bdy damping trends
235                                  CALL dyn_adv      ( kstp )   ! advection (vector or flux form)
236                                  CALL dyn_vor      ( kstp )   ! vorticity term including Coriolis
237                                  CALL dyn_ldf      ( kstp )   ! lateral mixing
238          IF( ln_neptsimp )       CALL dyn_nept_cor ( kstp )   ! add Neptune velocities (simplified)
239#if defined key_agrif
240          IF(.NOT. Agrif_Root())  CALL Agrif_Sponge_dyn        ! momentum sponge
241#endif
242                                  CALL dyn_hpg( kstp )         ! horizontal gradient of Hydrostatic pressure
243                                  CALL dyn_spg( kstp, indic )  ! surface pressure gradient
244
245                                  ua_sv(:,:,:) = ua(:,:,:)     ! Save trends (barotropic trend has been fully updated at this stage)
246                                  va_sv(:,:,:) = va(:,:,:)
247
248                                  CALL div_cur( kstp )         ! Horizontal divergence & Relative vorticity (2nd call in time-split case)
249          IF( lk_vvl     )        CALL dom_vvl_sf_nxt( kstp, kcall=2 )  ! after vertical scale factors (update depth average component)
250                                  CALL wzv           ( kstp )  ! now cross-level velocity
251      ENDIF
252
253      ! Cool skin
254      IF ( ln_diurnal ) THEN 
255         IF ( ln_blk_core ) THEN
256            CALL diurnal_sst_coolskin_step( & 
257                    qns(:,:)+(rn_abs*qsr(:,:)), taum, rhop(:,:,1), rdt) 
258         ELSE
259            CALL diurnal_sst_coolskin_step( & 
260                    qns, taum, rhop(:,:,1), rdt) 
261         ENDIF
262      ENDIF
263
264      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
265      ! diagnostics and outputs             (ua, va, tsa used as workspace)
266      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
267      IF( lk_floats  )      CALL flo_stp( kstp )         ! drifting Floats
268      IF( lk_diahth  )      CALL dia_hth( kstp )         ! Thermocline depth (20 degres isotherm depth)
269      IF( .NOT. ln_cpl )    CALL dia_fwb( kstp )         ! Fresh water budget diagnostics
270      IF( lk_diadct  )      CALL dia_dct( kstp )         ! Transports
271      IF( lk_diaar5  )      CALL dia_ar5( kstp )         ! ar5 diag
272      IF( lk_diaharm )      CALL dia_harm( kstp )        ! Tidal harmonic analysis
273                            CALL dia_wri( kstp )         ! ocean model: outputs
274      !
275      IF( ln_crs     )      CALL crs_fld( kstp )         ! ocean model: online field coarsening & output
276
277      !Diurnal warm layer model       
278      IF ( ln_diurnal ) THEN
279         IF ( ln_blk_core ) THEN
280            IF( kstp == nit000 )THEN 
281               CALL diurnal_sst_takaya_step( & 
282               &    qsr(:,:)-(rn_abs*qsr(:,:)), qns(:,:)+(rn_abs*qsr(:,:)), &
283               &    taum, rhop(:,:,1), &
284               &    rdt, ld_calcfrac = .TRUE.) 
285            ELSE 
286               CALL diurnal_sst_takaya_step( & 
287               &    qsr(:,:)-(rn_abs*qsr(:,:)), qns(:,:)+(rn_abs*qsr(:,:)), &
288               &    taum, rhop(:,:,1), rdt ) 
289            ENDIF
290         ELSE
291            IF( kstp == nit000 )THEN 
292               CALL diurnal_sst_takaya_step( & 
293               &    qsr, qns, taum, rhop(:,:,1), &
294               &    rdt, ld_calcfrac = .TRUE.) 
295            ELSE 
296               CALL diurnal_sst_takaya_step( & 
297               &    qsr, qns, taum, rhop(:,:,1), rdt ) 
298            ENDIF
299         ENDIF
300      ENDIF
301
302#if defined key_top
303      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
304      ! Passive Tracer Model
305      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
306      IF( lk_asminc .AND. ln_asmiau .AND. lk_bgcinc ) &
307         &               CALL bgc_asm_inc( kstp )     ! biogeochemistry assimilation
308                         CALL trc_stp( kstp )         ! time-stepping
309#endif
310
311
312      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
313      ! Active tracers                              (ua, va used as workspace)
314      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
315                             tsa(:,:,:,:) = 0.e0            ! set tracer trends to zero
316
317      IF(  lk_asminc .AND. ln_asmiau .AND. &
318         & ln_trainc     )   CALL tra_asm_inc( kstp )       ! apply tracer assimilation increment
319                             CALL tra_sbc    ( kstp )       ! surface boundary condition
320      IF( ln_traqsr      )   CALL tra_qsr    ( kstp )       ! penetrative solar radiation qsr
321      IF( ln_tradwl      )   CALL tra_dwl    ( kstp )       ! Polcoms Style Short Wave Radiation
322      IF( ln_trabbc      )   CALL tra_bbc    ( kstp )       ! bottom heat flux
323      IF( lk_trabbl      )   CALL tra_bbl    ( kstp )       ! advective (and/or diffusive) bottom boundary layer scheme
324      IF( ln_tradmp      )   CALL tra_dmp    ( kstp )       ! internal damping trends
325      IF( lk_bdy         )   CALL bdy_tra_dmp( kstp )       ! bdy damping trends
326                             CALL tra_adv    ( kstp )       ! horizontal & vertical advection
327      IF( lk_zdfkpp      )   CALL tra_kpp    ( kstp )       ! KPP non-local tracer fluxes
328                             CALL tra_ldf    ( kstp )       ! lateral mixing
329
330      IF( ln_diaptr      )   CALL dia_ptr                   ! Poleward adv/ldf TRansports diagnostics
331
332#if defined key_agrif
333      IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra          ! tracers sponge
334#endif
335                             CALL tra_zdf    ( kstp )       ! vertical mixing and after tracer fields
336
337      IF( ln_dynhpg_imp  ) THEN                             ! semi-implicit hpg (time stepping then eos)
338         IF( ln_zdfnpc   )   CALL tra_npc( kstp )                ! update after fields by non-penetrative convection
339                             CALL tra_nxt( kstp )                ! tracer fields at next time step
340                             CALL eos    ( tsa, rhd, rhop, fsdept_n(:,:,:) )  ! Time-filtered in situ density for hpg computation
341            IF( ln_zps .AND. .NOT. ln_isfcav)                                &
342               &             CALL zps_hde    ( kstp, jpts, tsa, gtsu, gtsv,  &    ! Partial steps: before horizontal gradient
343               &                                           rhd, gru , grv    )  ! of t, s, rd at the last ocean level
344            IF( ln_zps .AND.       ln_isfcav)                                &
345               &             CALL zps_hde_isf( kstp, jpts, tsa, gtsu, gtsv,  &    ! Partial steps for top cell (ISF)
346               &                                           rhd, gru , grv , aru , arv , gzu , gzv , ge3ru , ge3rv ,   &
347               &                                    gtui, gtvi, grui, grvi, arui, arvi, gzui, gzvi, ge3rui, ge3rvi    ) ! of t, s, rd at the last ocean level
348      ELSE                                                  ! centered hpg  (eos then time stepping)
349         IF ( .NOT. lk_dynspg_ts ) THEN                     ! eos already called in time-split case
350                             CALL eos    ( tsn, rhd, rhop, fsdept_n(:,:,:) )  ! now in situ density for hpg computation
351         IF( ln_zps .AND. .NOT. ln_isfcav)                                   &
352               &             CALL zps_hde    ( kstp, jpts, tsn, gtsu, gtsv,  &    ! Partial steps: before horizontal gradient
353               &                                           rhd, gru , grv    )  ! of t, s, rd at the last ocean level
354         IF( ln_zps .AND.       ln_isfcav)                                   & 
355               &             CALL zps_hde_isf( kstp, jpts, tsn, gtsu, gtsv,  &    ! Partial steps for top cell (ISF)
356               &                                           rhd, gru , grv , aru , arv , gzu , gzv , ge3ru , ge3rv ,   &
357               &                                    gtui, gtvi, grui, grvi, arui, arvi, gzui, gzvi, ge3rui, ge3rvi    ) ! of t, s, rd at the last ocean level
358         ENDIF
359         IF( ln_zdfnpc   )   CALL tra_npc( kstp )                ! update after fields by non-penetrative convection
360                             CALL tra_nxt( kstp )                ! tracer fields at next time step
361      ENDIF
362
363      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
364      ! Dynamics                                    (tsa used as workspace)
365      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
366
367      IF( ln_bkgwri )        CALL asm_bkg_wri( kstp )     ! output background fields
368
369      IF( lk_dynspg_ts   )  THEN
370                                                             ! revert to previously computed momentum tendencies
371                                                             ! (not using ua, va as temporary arrays during tracers' update could avoid that)
372                               ua(:,:,:) = ua_sv(:,:,:)
373                               va(:,:,:) = va_sv(:,:,:)
374                                                             ! Revert now divergence and rotational to previously computed ones
375                                                             !(needed because of the time swap in div_cur, at the beginning of each time step)
376                               hdivn(:,:,:) = hdivb(:,:,:)
377                               rotn(:,:,:)  = rotb(:,:,:) 
378
379                               CALL dyn_bfr( kstp )         ! bottom friction
380                               CALL dyn_zdf( kstp )         ! vertical diffusion
381      ELSE
382                               ua(:,:,:) = 0.e0             ! set dynamics trends to zero
383                               va(:,:,:) = 0.e0
384
385        IF(  lk_asminc .AND. ln_asmiau .AND. &
386           & ln_dyninc      )  CALL dyn_asm_inc( kstp )     ! apply dynamics assimilation increment
387        IF( ln_neptsimp )      CALL dyn_nept_cor( kstp )    ! subtract Neptune velocities (simplified)
388        IF( lk_bdy          )  CALL bdy_dyn3d_dmp(kstp )    ! bdy damping trends
389                               CALL dyn_adv( kstp )         ! advection (vector or flux form)
390                               CALL dyn_vor( kstp )         ! vorticity term including Coriolis
391                               CALL dyn_ldf( kstp )         ! lateral mixing
392        IF( ln_neptsimp )      CALL dyn_nept_cor( kstp )    ! add Neptune velocities (simplified)
393#if defined key_agrif
394        IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_dyn        ! momemtum sponge
395#endif
396                               CALL dyn_hpg( kstp )         ! horizontal gradient of Hydrostatic pressure
397                               CALL dyn_bfr( kstp )         ! bottom friction
398                               CALL dyn_zdf( kstp )         ! vertical diffusion
399                               CALL dyn_spg( kstp, indic )  ! surface pressure gradient
400      ENDIF
401                               CALL dyn_nxt( kstp )         ! lateral velocity at next time step
402
403                               CALL ssh_swp( kstp )         ! swap of sea surface height
404      IF( lk_vvl           )   CALL dom_vvl_sf_swp( kstp )  ! swap of vertical scale factors
405
406#if defined key_agrif
407      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
408      ! AGRIF
409      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
410                               CALL Agrif_Integrate_ChildGrids( stp ) 
411
412      IF ( Agrif_NbStepint().EQ.0 ) THEN
413                               CALL Agrif_Update_Tra()      ! Update active tracers
414                               CALL Agrif_Update_Dyn()      ! Update momentum
415      ENDIF
416#endif
417      IF( ln_diahsb        )   CALL dia_hsb( kstp )         ! - ML - global conservation diagnostics
418      IF( lk_diaobs  )         CALL dia_obs( kstp )         ! obs-minus-model (assimilation) diagnostics (call after dynamics update)
419
420      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
421      ! Control
422      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
423                               CALL stp_ctl( kstp, indic )
424      IF( indic < 0        )   THEN
425                               CALL ctl_stop( 'step: indic < 0' )
426                               CALL dia_wri_state( 'output.abort', kstp )
427                               CALL ctl_stop('STOP','NEMO failure in stp')
428      ENDIF
429      IF( ln_harm_ana_store   )   CALL harm_ana( kstp )        ! Harmonic analysis of tides
430      IF( kstp == nit000   )   THEN
431                 CALL iom_close( numror )     ! close input  ocean restart file
432         IF(lwm) CALL FLUSH    ( numond )     ! flush output namelist oce
433         IF( lwm.AND.numoni /= -1 ) CALL FLUSH    ( numoni )     ! flush output namelist ice
434      ENDIF
435      IF( lrst_oce         )   CALL rst_write    ( kstp )   ! write output ocean restart file
436
437      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
438      ! Coupled mode
439      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
440      !IF( lk_oasis         )   CALL sbc_cpl_snd( kstp )     ! coupled mode : field exchanges
441      !
442#if defined key_iomput
443      IF( kstp == nitend .OR. indic < 0 ) THEN
444                      CALL iom_context_finalize(      cxios_context          ) ! needed for XIOS+AGRIF
445         IF( ln_crs ) CALL iom_context_finalize( trim(cxios_context)//"_crs" ) !
446      ENDIF
447#endif
448      !
449      IF( nn_timing == 1 .AND.  kstp == nit000  )   CALL timing_reset
450      !     
451      !
452   END SUBROUTINE stp
453
454   !!======================================================================
455END MODULE step
Note: See TracBrowser for help on using the repository browser.