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 trunk/NEMO/OPA_SRC – NEMO

source: trunk/NEMO/OPA_SRC/step.F90 @ 1565

Last change on this file since 1565 was 1565, checked in by rblod, 15 years ago

Use appropiate e3 for divergence computation and for sea-ice, see ticket #507
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 19.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   !!----------------------------------------------------------------------
24
25   !!----------------------------------------------------------------------
26   !!   stp            : OPA system time-stepping
27   !!----------------------------------------------------------------------
28   USE oce             ! ocean dynamics and tracers variables
29   USE dom_oce         ! ocean space and time domain variables
30   USE zdf_oce         ! ocean vertical physics variables
31   USE ldftra_oce      ! ocean tracer   - trends
32   USE ldfdyn_oce      ! ocean dynamics - trends
33   USE in_out_manager  ! I/O manager
34   USE iom             !
35   USE lbclnk
36
37   USE daymod          ! calendar                         (day     routine)
38
39   USE dtatem          ! ocean temperature data           (dta_tem routine)
40   USE dtasal          ! ocean salinity    data           (dta_sal routine)
41   USE sbcmod          ! surface boundary condition       (sbc     routine)
42   USE sbcrnf          ! surface boundary condition: runoff variables
43   USE sbccpl          ! surface boundary condition: coupled formulation (call send at end of step)
44   USE cpl_oasis3, ONLY : lk_cpl
45
46   USE trcstp          ! passive tracer time-stepping      (trc_stp routine)
47
48   USE traqsr          ! solar radiation penetration      (tra_qsr routine)
49   USE trasbc          ! surface boundary condition       (tra_sbc routine)
50   USE trabbc          ! bottom boundary condition        (tra_bbc routine)
51   USE trabbl          ! bottom boundary layer            (tra_bbl routine)
52   USE tradmp          ! internal damping                 (tra_dmp routine)
53   USE traadv          ! advection scheme control     (tra_adv_ctl routine)
54   USE traldf          ! lateral mixing                   (tra_ldf routine)
55   USE cla             ! cross land advection             (tra_cla routine)
56   !   zdfkpp          ! KPP non-local tracer fluxes      (tra_kpp routine)
57   USE trazdf          ! vertical mixing                  (tra_zdf routine)
58   USE tranxt          ! time-stepping                    (tra_nxt routine)
59   USE tranpc          ! non-penetrative convection       (tra_npc routine)
60
61   USE eosbn2          ! equation of state                (eos_bn2 routine)
62
63   USE dynadv          ! advection                        (dyn_adv routine)
64   USE dynvor          ! vorticity term                   (dyn_vor routine)
65   USE dynhpg          ! hydrostatic pressure grad.       (dyn_hpg routine)
66   USE dynldf          ! lateral momentum diffusion       (dyn_ldf routine)
67   USE dynzdf          ! vertical diffusion               (dyn_zdf routine)
68   USE dynspg_oce      ! surface pressure gradient        (dyn_spg routine)
69   USE dynspg          ! surface pressure gradient        (dyn_spg routine)
70   USE dynnxt          ! time-stepping                    (dyn_nxt routine)
71
72   USE obc_par         ! open boundary condition variables
73   USE obcdta          ! open boundary condition data     (obc_dta routine)
74   USE obcrst          ! open boundary cond. restart      (obc_rst routine)
75   USE obcrad          ! open boundary cond. radiation    (obc_rad routine)
76
77   USE bdy_par         ! unstructured open boundary data variables
78   USE bdydta          ! unstructured open boundary data  (bdy_dta routine)
79
80   USE sshwzv          ! vertical velocity and ssh        (ssh_wzv routine)
81
82   USE ldfslp          ! iso-neutral slopes               (ldf_slp routine)
83   USE ldfeiv          ! eddy induced velocity coef.      (ldf_eiv routine)
84
85   USE zdftmx          ! tide-induced vertical mixing     (zdf_tmx routine)
86   USE zdfbfr          ! bottom friction                  (zdf_bfr routine)
87   USE zdftke_old      ! old TKE vertical mixing      (zdf_tke_old routine)
88   USE zdftke          ! TKE vertical mixing              (zdf_tke routine)
89   USE zdfkpp          ! KPP vertical mixing              (zdf_kpp routine)
90   USE zdfddm          ! double diffusion mixing          (zdf_ddm routine)
91   USE zdfevd          ! enhanced vertical diffusion      (zdf_evd routine)
92   USE zdfric          ! Richardson vertical mixing       (zdf_ric routine)
93   USE zdfmxl          ! Mixed-layer depth                (zdf_mxl routine)
94
95   USE zpshde          ! partial step: hor. derivative     (zps_hde routine)
96
97   USE diawri          ! Standard run outputs             (dia_wri routine)
98   USE trdicp          ! Ocean momentum/tracers trends    (trd_wri routine)
99   USE trdmld          ! mixed-layer trends               (trd_mld routine)
100   USE trdmld_rst      ! restart for mixed-layer trends
101   USE trdmod_oce      ! ocean momentum/tracers trends
102   USE trdvor          ! vorticity budget                 (trd_vor routine)
103   USE diagap          ! hor. mean model-data gap         (dia_gap routine)
104   USE diahdy          ! dynamic height                   (dia_hdy routine)
105   USE diaptr          ! poleward transports              (dia_ptr routine)
106   USE diahth          ! thermocline depth                (dia_hth routine)
107   USE diafwb          ! freshwater budget                (dia_fwb routine)
108   USE flo_oce         ! floats variables
109   USE floats          ! floats computation               (flo_stp routine)
110
111   USE stpctl          ! time stepping control            (stp_ctl routine)
112   USE restart         ! ocean restart                    (rst_wri routine)
113   USE prtctl          ! Print control                    (prt_ctl routine)
114
115#if defined key_agrif
116   USE agrif_opa_sponge ! Momemtum and tracers sponges
117#endif
118
119   IMPLICIT NONE
120   PRIVATE
121
122   PUBLIC   stp        ! called by opa.F90
123
124   !! * Substitutions
125#  include "domzgr_substitute.h90"
126#  include "zdfddm_substitute.h90"
127   !!----------------------------------------------------------------------
128   !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009)
129   !! $Id$
130   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
131   !!----------------------------------------------------------------------
132
133CONTAINS
134
135#if defined key_agrif
136   SUBROUTINE stp( )
137      INTEGER             ::   kstp   ! ocean time-step index
138#else
139   SUBROUTINE stp( kstp )
140      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
141#endif
142      !!----------------------------------------------------------------------
143      !!                     ***  ROUTINE stp  ***
144      !!                     
145      !! ** Purpose : - Time stepping of OPA (momentum and active tracer eqs.)
146      !!              - Time stepping of LIM (dynamic and thermodynamic eqs.)
147      !!              - Tme stepping  of TRC (passive tracer eqs.)
148      !!
149      !! ** Method  : -1- Update forcings and data 
150      !!              -2- Update ocean physics
151      !!              -3- Compute the t and s trends
152      !!              -4- Update t and s
153      !!              -5- Compute the momentum trends
154      !!              -6- Update the horizontal velocity
155      !!              -7- Compute the diagnostics variables (rd,N2, div,cur,w)
156      !!              -8- Outputs and diagnostics
157      !!----------------------------------------------------------------------
158      INTEGER ::   jk       ! dummy loop indice
159      INTEGER ::   indic    ! error indicator if < 0
160      !! ---------------------------------------------------------------------
161
162#if defined key_agrif
163      kstp = nit000 + Agrif_Nb_Step()
164!      IF ( Agrif_Root() .and. lwp) Write(*,*) '---'
165!      IF (lwp) Write(*,*) 'Grid Number',Agrif_Fixed(),' time step ',kstp
166#endif   
167      indic = 1                    ! reset to no error condition
168
169      CALL day( kstp )             ! Calendar
170
171      CALL iom_setkt( kstp )       ! say to iom that we are at time step kstp
172     
173      CALL rst_opn( kstp )         ! Open the restart file
174
175      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
176      ! Update data, open boundaries, surface boundary condition (including sea-ice)
177      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
178      IF( lk_dtatem  )   CALL dta_tem( kstp )         ! update 3D temperature data
179      IF( lk_dtasal  )   CALL dta_sal( kstp )         ! update 3D salinity data
180                         CALL sbc    ( kstp )         ! Sea Boundary Condition (including sea-ice)
181      IF( lk_obc     )   CALL obc_dta( kstp )         ! update dynamic and tracer data at open boundaries
182      IF( lk_obc     )   CALL obc_rad( kstp )         ! compute phase velocities at open boundaries
183      IF( lk_bdy     )   CALL bdy_dta( kstp )         ! update dynamic and tracer data at unstructured open boundary
184
185      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
186      !  Ocean dynamics : ssh, wn, hdiv, rot                                 !
187      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
188                         CALL ssh_wzv( kstp )         ! after ssh & vertical velocity
189
190      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
191      ! Ocean physics update                (ua, va, ta, sa used as workspace)
192      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
193                         CALL bn2( tb, sb, rn2b )     ! before Brunt-Vaisala frequency
194                         CALL bn2( tn, sn, rn2  )     ! now    Brunt-Vaisala frequency
195      !
196      !  VERTICAL PHYSICS   
197      !                                               ! Vertical eddy viscosity and diffusivity coefficients
198      IF( lk_zdfric     )   CALL zdf_ric    ( kstp )  ! Richardson number dependent Kz
199      IF( lk_zdftke_old )   CALL zdf_tke_old( kstp )  ! TKE closure scheme for Kz (old scheme)
200      IF( lk_zdftke     )   CALL zdf_tke    ( kstp )  ! TKE closure scheme for Kz
201      IF( lk_zdfkpp     )   CALL zdf_kpp    ( kstp )  ! KPP closure scheme for Kz
202      IF( lk_zdfcst     )   THEN                      ! Constant Kz (reset avt, avm[uv] to the background value)
203         avt (:,:,:) = rn_avt0 * tmask(:,:,:)
204         avmu(:,:,:) = rn_avm0 * umask(:,:,:)
205         avmv(:,:,:) = rn_avm0 * vmask(:,:,:)
206      ENDIF
207      IF( ln_rnf_mouth ) THEN                         ! increase diffusivity at rivers mouths
208         DO jk = 2, nkrnf   ;   avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:) * tmask(:,:,jk)   ;   END DO
209      ENDIF
210      IF( ln_zdfevd  )   CALL zdf_evd( kstp )         ! enhanced vertical eddy diffusivity
211
212      IF( lk_zdftmx  )   CALL zdf_tmx( kstp )         ! tidal vertical mixing
213
214      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
215         &               CALL zdf_ddm( kstp )         ! double diffusive mixing
216
217                         CALL zdf_bfr( kstp )         ! bottom friction
218
219                         CALL zdf_mxl( kstp )         ! mixed layer depth
220
221                                                      ! write tke information in the restart file
222      IF( lrst_oce .AND. lk_zdftke )   CALL tke_rst( kstp, 'WRITE' )
223      !
224      !  LATERAL  PHYSICS
225      !
226      IF( lk_ldfslp ) THEN                            ! slope of lateral mixing
227                         CALL eos( tb, sb, rhd )                ! before in situ density
228         IF( ln_zps )    CALL zps_hde( kstp, tb, sb, rhd,  &    ! Partial steps: before horizontal gradient
229            &                              gtu, gsu, gru,  &    ! of t, s, rd at the last ocean level
230            &                              gtv, gsv, grv )
231                         CALL ldf_slp( kstp, rhd, rn2b )        ! before slope of the lateral mixing
232      ENDIF
233#if defined key_traldf_c2d
234      IF( lk_traldf_eiv )   CALL ldf_eiv( kstp )      ! eddy induced velocity coefficient
235#  endif
236
237      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
238      ! diagnostics and outputs             (ua, va, ta, sa used as workspace)
239      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
240                         CALL dia_wri( kstp )         ! ocean model: outputs
241      IF( lk_floats  )   CALL flo_stp( kstp )         ! drifting Floats
242      IF( lk_diahth  )   CALL dia_hth( kstp )         ! Thermocline depth (20 degres isotherm depth)
243      IF( lk_diagap  )   CALL dia_gap( kstp )         ! basin averaged diagnostics
244      IF( lk_diahdy  )   CALL dia_hdy( kstp )         ! dynamical heigh diagnostics
245      IF( lk_diafwb  )   CALL dia_fwb( kstp )         ! Fresh water budget diagnostics
246      IF( ln_diaptr  )   CALL dia_ptr( kstp )         ! Poleward TRansports diagnostics
247
248#if defined key_top
249      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
250      ! Passive Tracer Model
251      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
252                         CALL trc_stp( kstp )         ! time-stepping
253#endif
254
255      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
256      ! Active tracers                              (ua, va used as workspace)
257      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
258                             ta(:,:,:) = 0.e0               ! set tracer trends to zero
259                             sa(:,:,:) = 0.e0
260
261                             CALL tra_sbc    ( kstp )       ! surface boundary condition
262      IF( ln_traqsr      )   CALL tra_qsr    ( kstp )       ! penetrative solar radiation qsr
263      IF( lk_trabbc      )   CALL tra_bbc    ( kstp )       ! bottom heat flux
264      IF( lk_trabbl_dif  )   CALL tra_bbl_dif( kstp )       ! diffusive bottom boundary layer scheme
265      IF( lk_trabbl_adv  )   CALL tra_bbl_adv( kstp )       ! advective (and/or diffusive) bottom boundary layer scheme
266      IF( lk_tradmp      )   CALL tra_dmp    ( kstp )       ! internal damping trends
267                             CALL tra_adv    ( kstp )       ! horizontal & vertical advection
268      IF( n_cla == 1     )   CALL tra_cla    ( kstp )       ! Cross Land Advection (Update Hor. advection)
269      IF( lk_zdfkpp )        CALL tra_kpp    ( kstp )       ! KPP non-local tracer fluxes
270                             CALL tra_ldf    ( kstp )       ! lateral mixing
271#if defined key_agrif
272      IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra          ! tracers sponge
273#endif
274                             CALL tra_zdf    ( kstp )       ! vertical mixing and after tracer fields
275
276      IF( ln_dynhpg_imp  ) THEN                             ! semi-implicit hpg (time stepping then eos)
277         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )            ! update after fields by non-penetrative convection
278                             CALL tra_nxt    ( kstp )            ! tracer fields at next time step
279                             CALL eos( ta, sa, rhd, rhop )       ! Time-filtered in situ density for hpg computation
280         IF( ln_zps      )   CALL zps_hde( kstp, ta, sa, rhd,   &   ! Partial steps: time filtered hor. derivative
281            &                                   gtu, gsu, gru,  &   ! of t, s, rd at the bottom ocean level
282            &                                   gtv, gsv, grv )
283         
284      ELSE                                                  ! centered hpg  (eos then time stepping)
285                             CALL eos( tn, sn, rhd, rhop )       ! now in situ density for hpg computation
286         IF( ln_zps      )   CALL zps_hde( kstp, tn, sn, rhd,   &   ! Partial steps: now horizontal derivative
287            &                                   gtu, gsu, gru,  &   ! of t, s, rd at the bottom ocean level
288            &                                   gtv, gsv, grv )
289         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )       ! update after fields by non-penetrative convection
290                             CALL tra_nxt    ( kstp )       ! tracer fields at next time step
291      ENDIF 
292
293      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
294      ! Dynamics                                    (ta, sa used as workspace)
295      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
296                               ua(:,:,:) = 0.e0             ! set dynamics trends to zero
297                               va(:,:,:) = 0.e0
298
299                               CALL dyn_adv( kstp )         ! advection (vector or flux form)
300                               CALL dyn_vor( kstp )         ! vorticity term including Coriolis
301                               CALL dyn_ldf( kstp )         ! lateral mixing
302#if defined key_agrif
303      IF(.NOT. Agrif_Root())   CALL Agrif_Sponge_dyn        ! momemtum sponge
304#endif
305                               CALL dyn_hpg( kstp )         ! horizontal gradient of Hydrostatic pressure
306                               CALL dyn_zdf( kstp )         ! vertical diffusion
307                               indic=0
308                               CALL dyn_spg( kstp, indic )  ! surface pressure gradient
309                               CALL dyn_nxt( kstp )         ! lateral velocity at next time step
310
311                               CALL ssh_nxt( kstp )         ! sea surface height at next time step
312
313      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
314      ! Control and restarts
315      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
316                               CALL stp_ctl( kstp, indic )
317      IF( indic < 0        )   THEN
318                               CALL ctl_stop( 'step: indic < 0' )
319                               CALL dia_wri_state( 'output.abort', kstp )
320      ENDIF
321      IF( kstp == nit000   )   CALL iom_close( numror )     ! close input  ocean restart file
322      IF( lrst_oce         )   CALL rst_write    ( kstp )   ! write output ocean restart file
323      IF( lk_obc           )   CALL obc_rst_write( kstp )   ! write open boundary restart file
324
325      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
326      ! Trends                              (ua, va, ta, sa used as workspace)
327      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
328      IF( nstop == 0 ) THEN                         
329         IF( lk_trddyn     )   CALL trd_dwr( kstp )         ! trends: dynamics
330         IF( lk_trdtra     )   CALL trd_twr( kstp )         ! trends: active tracers
331         IF( lk_trdmld     )   CALL trd_mld( kstp )         ! trends: Mixed-layer
332         IF( lk_trdvor     )   CALL trd_vor( kstp )         ! trends: vorticity budget
333      ENDIF
334
335      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
336      ! Coupled mode
337      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
338      IF( lk_cpl           )   CALL sbc_cpl_snd( kstp )     ! coupled mode : field exchanges
339      !
340      !
341   END SUBROUTINE stp
342
343   !!======================================================================
344END MODULE step
Note: See TracBrowser for help on using the repository browser.