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/2013/dev_r4028_CNRS_LIM3/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/2013/dev_r4028_CNRS_LIM3/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 4634

Last change on this file since 4634 was 4634, checked in by clem, 10 years ago

major changes in heat budget

  • Property svn:keywords set to Id
File size: 17.7 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   !!----------------------------------------------------------------------
27
28   !!----------------------------------------------------------------------
29   !!   stp             : OPA system time-stepping
30   !!----------------------------------------------------------------------
31   USE step_oce         ! time stepping definition modules
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   stp   ! called by opa.F90
37
38   !! * Substitutions
39#  include "domzgr_substitute.h90"
40#  include "zdfddm_substitute.h90"
41   !!----------------------------------------------------------------------
42   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
43   !! $Id$
44   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
45   !!----------------------------------------------------------------------
46CONTAINS
47
48#if defined key_agrif
49   SUBROUTINE stp( )
50      INTEGER             ::   kstp   ! ocean time-step index
51#else
52   SUBROUTINE stp( kstp )
53      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
54#endif
55      !!----------------------------------------------------------------------
56      !!                     ***  ROUTINE stp  ***
57      !!
58      !! ** Purpose : - Time stepping of OPA (momentum and active tracer eqs.)
59      !!              - Time stepping of LIM (dynamic and thermodynamic eqs.)
60      !!              - Tme stepping  of TRC (passive tracer eqs.)
61      !!
62      !! ** Method  : -1- Update forcings and data
63      !!              -2- Update ocean physics
64      !!              -3- Compute the t and s trends
65      !!              -4- Update t and s
66      !!              -5- Compute the momentum trends
67      !!              -6- Update the horizontal velocity
68      !!              -7- Compute the diagnostics variables (rd,N2, div,cur,w)
69      !!              -8- Outputs and diagnostics
70      !!----------------------------------------------------------------------
71      INTEGER ::   jk       ! dummy loop indice
72      INTEGER ::   indic    ! error indicator if < 0
73      !! ---------------------------------------------------------------------
74
75#if defined key_agrif
76      kstp = nit000 + Agrif_Nb_Step()
77!      IF ( Agrif_Root() .and. lwp) Write(*,*) '---'
78!      IF (lwp) Write(*,*) 'Grid Number',Agrif_Fixed(),' time step ',kstp
79# if defined key_iomput
80      IF( Agrif_Nbstepint() == 0 )   CALL iom_swap
81# endif
82#endif
83                             indic = 0                ! reset to no error condition
84      IF( kstp == nit000 )   CALL iom_init            ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
85      IF( kstp /= nit000 )   CALL day( kstp )         ! Calendar (day was already called at nit000 in day_init)
86                             CALL iom_setkt( kstp - nit000 + 1 )   ! say to iom that we are at time step kstp
87
88      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
89      ! Update data, open boundaries, surface boundary condition (including sea-ice)
90      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
91      IF( lk_tide.AND.(kstp /= nit000 ))   CALL tide_init ( kstp )
92      IF( lk_tide    )   CALL sbc_tide( kstp )
93      IF( lk_obc     )   CALL obc_dta( kstp )         ! update dynamic and tracer data at open boundaries
94      IF( lk_obc     )   CALL obc_rad( kstp )         ! compute phase velocities at open boundaries
95      IF( lk_bdy     )   CALL bdy_dta( kstp, time_offset=+1 ) ! update dynamic and tracer data at open boundaries
96
97                         CALL sbc    ( kstp )         ! Sea Boundary Condition (including sea-ice)
98                                                      ! clem: moved here for bdy ice purpose
99      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
100      !  Ocean dynamics : ssh, wn, hdiv, rot                                 !
101      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
102                         CALL ssh_wzv( kstp )         ! after ssh & vertical velocity
103
104      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
105      ! Ocean physics update                (ua, va, tsa used as workspace)
106      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
107                         CALL bn2( tsb, rn2b )        ! before Brunt-Vaisala frequency
108                         CALL bn2( tsn, rn2  )        ! now    Brunt-Vaisala frequency
109      !
110      !  VERTICAL PHYSICS
111      ! bg jchanut tschanges
112      ! One need bottom friction parameter in ssh_wzv routine with time splitting.
113      ! The idea could be to move the call below before ssh_wzv. However, "now" scale factors
114      ! at U-V points (which are set thanks to sshu_n, sshv_n) are actually available in sshwzv.
115      ! These are needed for log bottom friction...
116#if ! defined key_dynspg_ts
117                         CALL zdf_bfr( kstp )         ! bottom friction
118#endif
119      ! end jchanut tschanges
120
121      !                                               ! Vertical eddy viscosity and diffusivity coefficients
122      IF( lk_zdfric  )   CALL zdf_ric( kstp )            ! Richardson number dependent Kz
123      IF( lk_zdftke  )   CALL zdf_tke( kstp )            ! TKE closure scheme for Kz
124      IF( lk_zdfgls  )   CALL zdf_gls( kstp )            ! GLS closure scheme for Kz
125      IF( lk_zdfkpp  )   CALL zdf_kpp( kstp )            ! KPP closure scheme for Kz
126      IF( lk_zdfcst  )   THEN                            ! Constant Kz (reset avt, avm[uv] to the background value)
127         avt (:,:,:) = rn_avt0 * tmask(:,:,:)
128         avmu(:,:,:) = rn_avm0 * umask(:,:,:)
129         avmv(:,:,:) = rn_avm0 * vmask(:,:,:)
130      ENDIF
131      IF( ln_rnf_mouth ) THEN                         ! increase diffusivity at rivers mouths
132         DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:) * tmask(:,:,jk)   ;   END DO
133      ENDIF
134      IF( ln_zdfevd  )   CALL zdf_evd( kstp )         ! enhanced vertical eddy diffusivity
135
136      IF( lk_zdftmx  )   CALL zdf_tmx( kstp )         ! tidal vertical mixing
137
138      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
139         &               CALL zdf_ddm( kstp )         ! double diffusive mixing
140
141                         CALL zdf_mxl( kstp )         ! mixed layer depth
142
143                                                      ! write TKE or GLS information in the restart file
144      IF( lrst_oce .AND. lk_zdftke )   CALL tke_rst( kstp, 'WRITE' )
145      IF( lrst_oce .AND. lk_zdfgls )   CALL gls_rst( kstp, 'WRITE' )
146      !
147      !  LATERAL  PHYSICS
148      !
149      IF( lk_ldfslp ) THEN                            ! slope of lateral mixing
150                         CALL eos( tsb, rhd )                ! before in situ density
151         IF( ln_zps )    CALL zps_hde( kstp, jpts, tsb, gtsu, gtsv,  &    ! Partial steps: before horizontal gradient
152            &                                      rhd, gru , grv  )      ! of t, s, rd at the last ocean level
153         IF( ln_traldf_grif ) THEN                           ! before slope for Griffies operator
154                         CALL ldf_slp_grif( kstp )
155         ELSE
156                         CALL ldf_slp( kstp, rhd, rn2b )     ! before slope for Madec operator
157         ENDIF
158      ENDIF
159#if defined key_traldf_c2d
160      IF( lk_traldf_eiv )   CALL ldf_eiv( kstp )      ! eddy induced velocity coefficient
161#endif
162#if defined key_traldf_c3d && key_traldf_smag
163                          CALL ldf_tra_smag( kstp )      ! eddy induced velocity coefficient
164#  endif
165#if defined key_dynldf_c3d && key_dynldf_smag
166                          CALL ldf_dyn_smag( kstp )      ! eddy induced velocity coefficient
167#  endif
168
169
170      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
171      ! diagnostics and outputs             (ua, va, tsa used as workspace)
172      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
173      IF( lk_floats  )   CALL flo_stp( kstp )         ! drifting Floats
174      IF( lk_diahth  )   CALL dia_hth( kstp )         ! Thermocline depth (20 degres isotherm depth)
175      IF( lk_diafwb  )   CALL dia_fwb( kstp )         ! Fresh water budget diagnostics
176      IF( ln_diaptr  )   CALL dia_ptr( kstp )         ! Poleward TRansports diagnostics
177      IF( lk_diadct  )   CALL dia_dct( kstp )         ! Transports
178      IF( lk_diaar5  )   CALL dia_ar5( kstp )         ! ar5 diag
179      IF( lk_diaharm )   CALL dia_harm( kstp )        ! Tidal harmonic analysis
180                         CALL dia_wri( kstp )         ! ocean model: outputs
181
182#if defined key_top
183      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
184      ! Passive Tracer Model
185      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
186                         CALL trc_stp( kstp )         ! time-stepping
187#endif
188
189      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
190      ! Active tracers                              (ua, va used as workspace)
191      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
192                             tsa(:,:,:,:) = 0.e0            ! set tracer trends to zero
193
194      IF(  ln_asmiau .AND. &
195         & ln_trainc     )   CALL tra_asm_inc( kstp )       ! apply tracer assimilation increment
196                             CALL tra_sbc    ( kstp )       ! surface boundary condition
197      IF( ln_traqsr      )   CALL tra_qsr    ( kstp )       ! penetrative solar radiation qsr
198      IF( ln_trabbc      )   CALL tra_bbc    ( kstp )       ! bottom heat flux
199      IF( lk_trabbl      )   CALL tra_bbl    ( kstp )       ! advective (and/or diffusive) bottom boundary layer scheme
200      IF( ln_tradmp      )   CALL tra_dmp    ( kstp )       ! internal damping trends
201      IF( lk_bdy         )   CALL bdy_tra_dmp( kstp )       ! bdy damping trends
202                             CALL tra_adv    ( kstp )       ! horizontal & vertical advection
203      IF( lk_zdfkpp      )   CALL tra_kpp    ( kstp )       ! KPP non-local tracer fluxes
204                             CALL tra_ldf    ( kstp )       ! lateral mixing
205#if defined key_agrif
206      IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra          ! tracers sponge
207#endif
208                             CALL tra_zdf    ( kstp )       ! vertical mixing and after tracer fields
209
210      IF( ln_dynhpg_imp  ) THEN                             ! semi-implicit hpg (time stepping then eos)
211         IF( ln_zdfnpc   )   CALL tra_npc( kstp )                ! update after fields by non-penetrative convection
212                             CALL tra_nxt( kstp )                ! tracer fields at next time step
213                             CALL eos    ( tsa, rhd, rhop )      ! Time-filtered in situ density for hpg computation
214         IF( ln_zps      )   CALL zps_hde( kstp, jpts, tsa, gtsu, gtsv,  &    ! zps: time filtered hor. derivative
215            &                                          rhd, gru , grv  )      ! of t, s, rd at the last ocean level
216
217      ELSE   
218                                               ! centered hpg  (eos then time stepping)
219      ! bg jchanut tschanges
220#if ! defined key_dynspg_ts
221      ! eos already called
222                             CALL eos    ( tsn, rhd, rhop )      ! now in situ density for hpg computation
223         IF( ln_zps      )   CALL zps_hde( kstp, jpts, tsn, gtsu, gtsv,  &    ! zps: now hor. derivative
224            &                                          rhd, gru , grv  )      ! of t, s, rd at the last ocean level
225#endif
226      ! end jchanut tschanges
227         IF( ln_zdfnpc   )   CALL tra_npc( kstp )                ! update after fields by non-penetrative convection
228                             CALL tra_nxt( kstp )                ! tracer fields at next time step
229      ENDIF
230
231      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
232      ! Dynamics                                    (tsa used as workspace)
233      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
234      ! bg jchanut tschanges
235#if defined key_dynspg_ts     
236! revert to previously computed tendencies:
237! (not using ua, va as temporary arrays during tracers' update could avoid that)
238                               ua(:,:,:) = ua_bak(:,:,:)           
239                               va(:,:,:) = va_bak(:,:,:)
240                               CALL dyn_bfr( kstp )         ! bottom friction
241                               CALL dyn_zdf( kstp )         ! vertical diffusion
242#else
243      ! end jchanut tschanges
244                               ua(:,:,:) = 0.e0             ! set dynamics trends to zero
245                               va(:,:,:) = 0.e0
246
247      IF(  ln_asmiau .AND. &
248         & ln_dyninc       )   CALL dyn_asm_inc( kstp )     ! apply dynamics assimilation increment
249      IF( ln_bkgwri )          CALL asm_bkg_wri( kstp )     ! output background fields
250      IF( ln_neptsimp )        CALL dyn_nept_cor( kstp )    ! subtract Neptune velocities (simplified)
251      IF( lk_bdy           )   CALL bdy_dyn3d_dmp(kstp )    ! bdy damping trends
252                               CALL dyn_adv( kstp )         ! advection (vector or flux form)
253                               CALL dyn_vor( kstp )         ! vorticity term including Coriolis
254                               CALL dyn_ldf( kstp )         ! lateral mixing
255      IF( ln_neptsimp )        CALL dyn_nept_cor( kstp )    ! add Neptune velocities (simplified)
256#if defined key_agrif
257      IF(.NOT. Agrif_Root())   CALL Agrif_Sponge_dyn        ! momemtum sponge
258#endif
259                               CALL dyn_hpg( kstp )         ! horizontal gradient of Hydrostatic pressure
260                               CALL dyn_bfr( kstp )         ! bottom friction
261                               CALL dyn_zdf( kstp )         ! vertical diffusion
262                               CALL dyn_spg( kstp, indic )  ! surface pressure gradient
263      ! bg jchanut tschanges
264#endif
265      ! end jchanut tschanges
266                               CALL dyn_nxt( kstp )         ! lateral velocity at next time step
267
268                               CALL ssh_nxt( kstp )         ! sea surface height at next time step
269
270      IF( ln_diahsb        )   CALL dia_hsb( kstp )         ! - ML - global conservation diagnostics
271      IF( lk_diaobs  )         CALL dia_obs( kstp )         ! obs-minus-model (assimilation) diagnostics (call after dynamics update)
272
273      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
274      ! Control and restarts
275      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
276                               CALL stp_ctl( kstp, indic )
277      IF( indic < 0        )   THEN
278                               CALL ctl_stop( 'step: indic < 0' )
279                               CALL dia_wri_state( 'output.abort', kstp )
280      ENDIF
281      IF( kstp == nit000   )   CALL iom_close( numror )     ! close input  ocean restart file
282      IF( lrst_oce         )   CALL rst_write    ( kstp )   ! write output ocean restart file
283      IF( lk_obc           )   CALL obc_rst_write( kstp )   ! write open boundary restart file
284
285      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
286      ! Trends                              (ua, va, tsa used as workspace)
287      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
288      IF( nstop == 0 ) THEN
289         IF( lk_trddyn     )   CALL trd_dwr( kstp )         ! trends: dynamics
290         IF( lk_trdtra     )   CALL trd_twr( kstp )         ! trends: active tracers
291         IF( lk_trdmld     )   CALL trd_mld( kstp )         ! trends: Mixed-layer
292         IF( lk_trdvor     )   CALL trd_vor( kstp )         ! trends: vorticity budget
293      ENDIF
294
295      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
296      ! Coupled mode
297      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
298      IF( lk_cpl           )   CALL sbc_cpl_snd( kstp )     ! coupled mode : field exchanges
299      !
300#if defined key_iomput
301      IF( kstp == nitend .OR. indic < 0 )   CALL xios_context_finalize() ! needed for XIOS+AGRIF
302#endif
303      !
304      IF( nn_timing == 1 .AND.  kstp == nit000  )   CALL timing_reset
305      !
306   END SUBROUTINE stp
307
308   !!======================================================================
309END MODULE step
Note: See TracBrowser for help on using the repository browser.