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

Context Navigation

source: branches/2013/dev_r3867_MERCATOR1_DYN/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 3970

Last change on this file since 3970 was 3970, checked in by cbricaud, 11 years ago
Time splitting update, see ticket #1079
Property svn:keywords set to `Id`
File size: 17.6 KB

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

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

Download in other formats: