source: branches/2017/dev_r7881_HPC09_ZDF/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 7953

Last change on this file since 7953 was 7953, checked in by gm, 3 years ago

#1880 (HPC-09): add zdfphy (the ZDF manager) + remove all key_…

  • Property svn:keywords set to Id
File size: 19.4 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   !!            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
28   !!            3.6  !  2014-10  (E. Clementi, P. Oddo) Add Qiao vertical mixing in case of waves
29   !!            3.7  !  2014-10  (G. Madec)  LDF simplication
30   !!             -   !  2014-12  (G. Madec) remove KPP scheme
31   !!             -   !  2015-11  (J. Chanut) free surface simplification
32   !!----------------------------------------------------------------------
33
34   !!----------------------------------------------------------------------
35   !!   stp             : OPA system time-stepping
36   !!----------------------------------------------------------------------
37   USE step_oce         ! time stepping definition modules
38   !
39   USE iom              ! xIOs server
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   stp   ! called by nemogcm.F90
45
46   !!----------------------------------------------------------------------
47   !! NEMO/OPA 3.7 , NEMO Consortium (2015)
48   !! $Id$
49   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
50   !!----------------------------------------------------------------------
51CONTAINS
52
53#if defined key_agrif
54   RECURSIVE SUBROUTINE stp( )
55      INTEGER             ::   kstp   ! ocean time-step index
56#else
57   SUBROUTINE stp( kstp )
58      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
59#endif
60      !!----------------------------------------------------------------------
61      !!                     ***  ROUTINE stp  ***
62      !!
63      !! ** Purpose : - Time stepping of OPA (momentum and active tracer eqs.)
64      !!              - Time stepping of LIM (dynamic and thermodynamic eqs.)
65      !!              - Tme stepping  of TRC (passive tracer eqs.)
66      !!
67      !! ** Method  : -1- Update forcings and data
68      !!              -2- Update ocean physics
69      !!              -3- Compute the t and s trends
70      !!              -4- Update t and s
71      !!              -5- Compute the momentum trends
72      !!              -6- Update the horizontal velocity
73      !!              -7- Compute the diagnostics variables (rd,N2, hdiv,w)
74      !!              -8- Outputs and diagnostics
75      !!----------------------------------------------------------------------
76      INTEGER ::   ji, jj, jk   ! dummy loop indice
77      INTEGER ::   indic        ! error indicator if < 0
78      INTEGER ::   kcall        ! optional integer argument (dom_vvl_sf_nxt)
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      IF( kstp == nit000 + 1 )   lk_agrif_fstep = .FALSE.
87# if defined key_iomput
88      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap( cxios_context )
89# endif
90#endif
91      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
92      ! update I/O and calendar
93      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
94                             indic = 0                ! reset to no error condition
95                             
96      IF( kstp == nit000 ) THEN                       ! initialize IOM context (must be done after nemo_init for AGRIF+XIOS+OASIS)
97                             CALL iom_init(      cxios_context          )  ! for model grid (including passible AGRIF zoom)
98         IF( ln_crs      )   CALL iom_init( TRIM(cxios_context)//"_crs" )  ! for coarse grid
99      ENDIF
100      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
101                             CALL iom_setkt( kstp - nit000 + 1,      cxios_context          )   ! tell IOM we are at time step kstp
102      IF( ln_crs         )   CALL iom_setkt( kstp - nit000 + 1, TRIM(cxios_context)//"_crs" )   ! tell IOM we are at time step kstp
103
104      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
105      ! Update external forcing (tides, open boundaries, and surface boundary condition (including sea-ice)
106      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
107      IF( ln_tide    )   CALL sbc_tide( kstp )                   ! update tide potential
108      IF( ln_apr_dyn )   CALL sbc_apr ( kstp )                   ! atmospheric pressure (NB: call before bdy_dta which needs ssh_ib)
109      IF( ln_bdy     )   CALL bdy_dta ( kstp, time_offset=+1 )   ! update dynamic & tracer data at open boundaries
110                         CALL sbc     ( kstp )                   ! Sea Boundary Condition (including sea-ice)
111
112      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
113      ! Update stochastic parameters and random T/S fluctuations
114      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
115      IF( ln_sto_eos ) CALL sto_par( kstp )          ! Stochastic parameters
116      IF( ln_sto_eos ) CALL sto_pts( tsn  )          ! Random T/S fluctuations
117
118      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
119      ! Ocean physics update                (ua, va, tsa used as workspace)
120      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
121      !  THERMODYNAMICS
122                         CALL eos_rab( tsb, rab_b )       ! before local thermal/haline expension ratio at T-points
123                         CALL eos_rab( tsn, rab_n )       ! now    local thermal/haline expension ratio at T-points
124                         CALL bn2    ( tsb, rab_b, rn2b ) ! before Brunt-Vaisala frequency
125                         CALL bn2    ( tsn, rab_n, rn2  ) ! now    Brunt-Vaisala frequency
126
127      !  VERTICAL PHYSICS
128                         CALL zdf_phy( kstp )         ! vertical physics update (bfr, avt, avs, avm + MLD)
129
130      !  LATERAL  PHYSICS
131      !
132      IF( l_ldfslp ) THEN                             ! slope of lateral mixing
133                         CALL eos( tsb, rhd, gdept_0(:,:,:) )               ! before in situ density
134
135         IF( ln_zps .AND. .NOT. ln_isfcav)                               &
136            &            CALL zps_hde    ( kstp, jpts, tsb, gtsu, gtsv,  &  ! Partial steps: before horizontal gradient
137            &                                          rhd, gru , grv    )  ! of t, s, rd at the last ocean level
138
139         IF( ln_zps .AND.       ln_isfcav)                               &
140            &            CALL zps_hde_isf( kstp, jpts, tsb, gtsu, gtsv, gtui, gtvi,  &  ! Partial steps for top cell (ISF)
141            &                                          rhd, gru , grv , grui, grvi   )  ! of t, s, rd at the first ocean level
142         IF( ln_traldf_triad ) THEN
143                         CALL ldf_slp_triad( kstp )                       ! before slope for triad operator
144         ELSE     
145                         CALL ldf_slp     ( kstp, rhd, rn2b )             ! before slope for standard operator
146         ENDIF
147      ENDIF
148      !                                                                   ! eddy diffusivity coeff.
149      IF( l_ldftra_time .OR. l_ldfeiv_time )   CALL ldf_tra( kstp )       !       and/or eiv coeff.
150      IF( l_ldfdyn_time                    )   CALL ldf_dyn( kstp )       ! eddy viscosity coeff.
151
152      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
153      !  Ocean dynamics : hdiv, ssh, e3, u, v, w
154      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
155
156                            CALL ssh_nxt       ( kstp )  ! after ssh (includes call to div_hor)
157      IF(.NOT.ln_linssh )   CALL dom_vvl_sf_nxt( kstp )  ! after vertical scale factors
158                            CALL wzv           ( kstp )  ! now cross-level velocity
159                            CALL eos    ( tsn, rhd, rhop, gdept_n(:,:,:) )  ! now in situ density for hpg computation
160                           
161!!jc: fs simplification
162!!jc: lines below are useless if ln_linssh=F. Keep them here (which maintains a bug if ln_linssh=T and ln_zps=T, cf ticket #1636)
163!!                                         but ensures reproductible results
164!!                                         with previous versions using split-explicit free surface         
165            IF( ln_zps .AND. .NOT. ln_isfcav )                               &
166               &            CALL zps_hde    ( kstp, jpts, tsn, gtsu, gtsv,   &  ! Partial steps: before horizontal gradient
167               &                                          rhd, gru , grv     )  ! of t, s, rd at the last ocean level
168            IF( ln_zps .AND.       ln_isfcav )                                          &
169               &            CALL zps_hde_isf( kstp, jpts, tsn, gtsu, gtsv, gtui, gtvi,  &  ! Partial steps for top cell (ISF)
170               &                                          rhd, gru , grv , grui, grvi   )  ! of t, s, rd at the first ocean level
171!!jc: fs simplification
172                           
173                         ua(:,:,:) = 0._wp            ! set dynamics trends to zero
174                         va(:,:,:) = 0._wp
175
176      IF(  lk_asminc .AND. ln_asmiau .AND. ln_dyninc )   &
177               &         CALL dyn_asm_inc   ( kstp )  ! apply dynamics assimilation increment
178      IF( ln_bdy     )   CALL bdy_dyn3d_dmp ( kstp )  ! bdy damping trends
179#if defined key_agrif
180      IF(.NOT. Agrif_Root())  & 
181               &         CALL Agrif_Sponge_dyn        ! momentum sponge
182#endif
183                         CALL dyn_adv       ( kstp )  ! advection (vector or flux form)
184                         CALL dyn_vor       ( kstp )  ! vorticity term including Coriolis
185                         CALL dyn_ldf       ( kstp )  ! lateral mixing
186                         CALL dyn_hpg       ( kstp )  ! horizontal gradient of Hydrostatic pressure
187                         CALL dyn_spg       ( kstp )  ! surface pressure gradient
188
189                                                      ! With split-explicit free surface, since now transports have been updated and ssha as well
190      IF( ln_dynspg_ts ) THEN                         ! vertical scale factors and vertical velocity need to be updated
191                            CALL div_hor    ( kstp )              ! Horizontal divergence  (2nd call in time-split case)
192         IF(.NOT.ln_linssh) CALL dom_vvl_sf_nxt( kstp, kcall=2 )  ! after vertical scale factors (update depth average component)
193                            CALL wzv        ( kstp )              ! now cross-level velocity
194      ENDIF
195
196                         CALL dyn_bfr       ( kstp )  ! bottom friction
197                         CALL dyn_zdf       ( kstp )  ! vertical diffusion
198
199      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
200      ! cool skin
201      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
202      IF ( ln_diurnal )  CALL stp_diurnal( kstp )
203     
204      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
205      ! diagnostics and outputs             (ua, va, tsa used as workspace)
206      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
207      IF( lk_floats  )   CALL flo_stp( kstp )         ! drifting Floats
208      IF( nn_diacfl == 1 )   CALL dia_cfl( kstp )         ! Courant number diagnostics
209      IF( lk_diahth  )   CALL dia_hth( kstp )         ! Thermocline depth (20 degres isotherm depth)
210      IF( lk_diadct  )   CALL dia_dct( kstp )         ! Transports
211                         CALL dia_ar5( kstp )         ! ar5 diag
212      IF( lk_diaharm )   CALL dia_harm( kstp )        ! Tidal harmonic analysis
213                         CALL dia_wri( kstp )         ! ocean model: outputs
214      !
215      IF( ln_crs     )   CALL crs_fld       ( kstp )  ! ocean model: online field coarsening & output
216     
217#if defined key_top
218      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
219      ! Passive Tracer Model
220      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
221                         CALL trc_stp       ( kstp )  ! time-stepping
222#endif
223
224      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
225      ! Active tracers                             
226      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
227                         tsa(:,:,:,:) = 0._wp         ! set tracer trends to zero
228
229      IF(  lk_asminc .AND. ln_asmiau .AND. &
230         & ln_trainc )   CALL tra_asm_inc   ( kstp )  ! apply tracer assimilation increment
231                         CALL tra_sbc       ( kstp )  ! surface boundary condition
232      IF( ln_traqsr  )   CALL tra_qsr       ( kstp )  ! penetrative solar radiation qsr
233      IF( ln_trabbc  )   CALL tra_bbc       ( kstp )  ! bottom heat flux
234      IF( lk_trabbl  )   CALL tra_bbl       ( kstp )  ! advective (and/or diffusive) bottom boundary layer scheme
235      IF( ln_tradmp  )   CALL tra_dmp       ( kstp )  ! internal damping trends
236      IF( ln_bdy     )   CALL bdy_tra_dmp   ( kstp )  ! bdy damping trends
237#if defined key_agrif
238      IF(.NOT. Agrif_Root())  & 
239               &         CALL Agrif_Sponge_tra        ! tracers sponge
240#endif
241                         CALL tra_adv       ( kstp )  ! horizontal & vertical advection
242                         CALL tra_ldf       ( kstp )  ! lateral mixing
243
244!!gm : why CALL to dia_ptr has been moved here??? (use trends info?)
245      IF( ln_diaptr  )   CALL dia_ptr                 ! Poleward adv/ldf TRansports diagnostics
246!!gm
247                         CALL tra_zdf       ( kstp )  ! vertical mixing and after tracer fields
248      IF( ln_zdfnpc  )   CALL tra_npc       ( kstp )  ! update after fields by non-penetrative convection
249
250      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
251      ! Set boundary conditions and Swap
252      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
253!!jc1: For agrif, it would be much better to finalize tracers/momentum here (e.g. bdy conditions) and move the swap
254!!    (and time filtering) after Agrif update. Then restart would be done after and would contain updated fields.
255!!    If so:
256!!    (i) no need to call agrif update at initialization time
257!!    (ii) no need to update "before" fields
258!!
259!!    Apart from creating new tra_swp/dyn_swp routines, this however:
260!!    (i) makes boundary conditions at initialization time computed from updated fields which is not the case between
261!!    two restarts => restartability issue. One can circumvent this, maybe, by assuming "interface separation",
262!!    e.g. a shift of the feedback interface inside child domain.
263!!    (ii) requires that all restart outputs of updated variables by agrif (e.g. passive tracers/tke/barotropic arrays) are done at the same
264!!    place.
265!!
266!!jc2: dynnxt must be the latest call. e3t_b are indeed updated in that routine
267                         CALL tra_nxt       ( kstp )  ! finalize (bcs) tracer fields at next time step and swap
268                         CALL dyn_nxt       ( kstp )  ! finalize (bcs) velocities at next time step and swap
269                         CALL ssh_swp       ( kstp )  ! swap of sea surface height
270      IF(.NOT.ln_linssh) CALL dom_vvl_sf_swp( kstp )  ! swap of vertical scale factors
271      !
272      IF( ln_diahsb        )   CALL dia_hsb( kstp )         ! - ML - global conservation diagnostics
273
274!!gm : This does not only concern the dynamics ==>>> add a new title
275!!gm2: why ouput restart before AGRIF update?
276!!
277!!jc: That would be better, but see comment above
278!!
279      IF( lrst_oce         )   CALL rst_write    ( kstp )   ! write output ocean restart file
280      IF( ln_sto_eos       )   CALL sto_rst_write( kstp )   ! write restart file for stochastic parameters
281
282#if defined key_agrif
283      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
284      ! AGRIF
285      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<     
286                         CALL Agrif_Integrate_ChildGrids( stp ) 
287
288      IF( Agrif_NbStepint() == 0 ) THEN               ! AGRIF Update
289!!jc in fact update is useless at last time step, but do it for global diagnostics
290                         CALL Agrif_Update_Tra()      ! Update active tracers
291                         CALL Agrif_Update_Dyn()      ! Update momentum
292      ENDIF
293#endif
294      IF( ln_diaobs  )   CALL dia_obs( kstp )         ! obs-minus-model (assimilation) diagnostics (call after dynamics update)
295
296      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
297      ! Control
298      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
299                         CALL stp_ctl       ( kstp, indic )
300      IF( indic < 0  ) THEN
301                         CALL ctl_stop( 'step: indic < 0' )
302                         CALL dia_wri_state( 'output.abort', kstp )
303      ENDIF
304      IF( kstp == nit000 ) THEN
305                 CALL iom_close( numror )     ! close input  ocean restart file
306         IF(lwm) CALL FLUSH    ( numond )     ! flush output namelist oce
307         IF(lwm.AND.numoni /= -1 )   &
308            &    CALL FLUSH    ( numoni )     ! flush output namelist ice (if exist)
309      ENDIF
310
311      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
312      ! Coupled mode
313      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
314!!gm why lk_oasis and not lk_cpl ????
315      IF( lk_oasis   )   CALL sbc_cpl_snd( kstp )     ! coupled mode : field exchanges
316      !
317#if defined key_iomput
318      IF( kstp == nitend .OR. indic < 0 ) THEN
319                      CALL iom_context_finalize(      cxios_context          ) ! needed for XIOS+AGRIF
320         IF( ln_crs ) CALL iom_context_finalize( trim(cxios_context)//"_crs" ) !
321      ENDIF
322#endif
323      !
324      IF( nn_timing == 1 .AND.  kstp == nit000  )   CALL timing_reset
325      !
326   END SUBROUTINE stp
327   
328END MODULE step
Note: See TracBrowser for help on using the repository browser.