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

Context Navigation

source: branches/2013/dev_LOCEAN_2013/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 4166

Last change on this file since 4166 was 4161, checked in by cetlod, 11 years ago
dev_LOCEAN_2013 : merge in the 3rd dev branch dev_r4028_CNRS_LIM3, see ticket #1169
Property svn:keywords set to `Id`
File size: 18.4 KB

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: