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

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 2348

Last change on this file since 2348 was 2348, checked in by gm, 13 years ago

v3.3beta: #750 suppression of diahdy

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