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 @ 4215

Last change on this file since 4215 was 4215, checked in by clem, 11 years ago
corrected step.F90
Property svn:keywords set to `Id`
File size: 17.3 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
[4152]	26	!! ! 2012-07 (J. Simeon, G. Madec. C. Ethe) Online coarsening of outputs
[3]	27	!!----------------------------------------------------------------------
[888]	28
	29	!!----------------------------------------------------------------------
[2528]	30	!! stp : OPA system time-stepping
[3]	31	!!----------------------------------------------------------------------
[3764]	32	USE step_oce ! time stepping definition modules
[389]	33
[3]	34	IMPLICIT NONE
	35	PRIVATE
	36
[2528]	37	PUBLIC stp ! called by opa.F90
[3]	38
	39	!! * Substitutions
	40	# include "domzgr_substitute.h90"
	41	# include "zdfddm_substitute.h90"
	42	!!----------------------------------------------------------------------
[2528]	43	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[888]	44	!! $Id$
[2528]	45	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	46	!!----------------------------------------------------------------------
	47	CONTAINS
	48
[508]	49	#if defined key_agrif
	50	SUBROUTINE stp( )
[1438]	51	INTEGER :: kstp ! ocean time-step index
[508]	52	#else
[467]	53	SUBROUTINE stp( kstp )
[1438]	54	INTEGER, INTENT(in) :: kstp ! ocean time-step index
[467]	55	#endif
	56	!!----------------------------------------------------------------------
[3]	57	!! * ROUTINE stp *
[3764]	58	!!
[3]	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.)
[3764]	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
[3]	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	!!----------------------------------------------------------------------
[888]	72	INTEGER :: jk ! dummy loop indice
[3]	73	INTEGER :: indic ! error indicator if < 0
	74	!! ---------------------------------------------------------------------
	75
[392]	76	#if defined key_agrif
[389]	77	kstp = nit000 + Agrif_Nb_Step()
[2715]	78	! IF ( Agrif_Root() .and. lwp) Write(,) '---'
	79	! IF (lwp) Write(,) 'Grid Number',Agrif_Fixed(),' time step ',kstp
[1793]	80	# if defined key_iomput
[4152]	81	IF( Agrif_Nbstepint() == 0 ) CALL iom_swap( "nemo" )
[3764]	82	# endif
	83	#endif
[4152]	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
[4147]	89
[1725]	90	IF( kstp /= nit000 ) CALL day( kstp ) ! Calendar (day was already called at nit000 in day_init)
[4152]	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
[3]	93
	94	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[888]	95	! Update data, open boundaries, surface boundary condition (including sea-ice)
[3]	96	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[888]	97	CALL sbc ( kstp ) ! Sea Boundary Condition (including sea-ice)
[4147]	98
[3651]	99	IF( lk_tide.AND.(kstp /= nit000 )) CALL tide_init ( kstp )
[3294]	100	IF( lk_tide ) CALL sbc_tide( kstp )
[35]	101	IF( lk_obc ) CALL obc_dta( kstp ) ! update dynamic and tracer data at open boundaries
[3]	102	IF( lk_obc ) CALL obc_rad( kstp ) ! compute phase velocities at open boundaries
[3294]	103	IF( lk_bdy ) CALL bdy_dta( kstp, time_offset=+1 ) ! update dynamic and tracer data at open boundaries
[911]	104
[1438]	105	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]	106	! Ocean dynamics : ssh, wn, hdiv, rot !
[1438]	107	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	108	CALL ssh_wzv( kstp ) ! after ssh & vertical velocity
[3]	109
	110	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[3294]	111	! Ocean physics update (ua, va, tsa used as workspace)
[3]	112	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[2528]	113	CALL bn2( tsb, rn2b ) ! before Brunt-Vaisala frequency
	114	CALL bn2( tsn, rn2 ) ! now Brunt-Vaisala frequency
[1492]	115	!
[3764]	116	! VERTICAL PHYSICS
[1662]	117	CALL zdf_bfr( kstp ) ! bottom friction
[3764]	118
[1492]	119	! ! Vertical eddy viscosity and diffusivity coefficients
[2528]	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)
[1537]	125	avt (:,:,:) = rn_avt0 * tmask(:,:,:)
	126	avmu(:,:,:) = rn_avm0 * umask(:,:,:)
	127	avmv(:,:,:) = rn_avm0 * vmask(:,:,:)
[677]	128	ENDIF
[1492]	129	IF( ln_rnf_mouth ) THEN ! increase diffusivity at rivers mouths
[1246]	130	DO jk = 2, nkrnf ; avt(:,:,jk) = avt(:,:,jk) + 2.e0 * rn_avt_rnf * rnfmsk(:,:) * tmask(:,:,jk) ; END DO
[3]	131	ENDIF
[1492]	132	IF( ln_zdfevd ) CALL zdf_evd( kstp ) ! enhanced vertical eddy diffusivity
[3]	133
[1492]	134	IF( lk_zdftmx ) CALL zdf_tmx( kstp ) ! tidal vertical mixing
[3]	135
[888]	136	IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) &
[1492]	137	& CALL zdf_ddm( kstp ) ! double diffusive mixing
[3764]	138
[1492]	139	CALL zdf_mxl( kstp ) ! mixed layer depth
[3]	140
[2528]	141	! write TKE or GLS information in the restart file
[1531]	142	IF( lrst_oce .AND. lk_zdftke ) CALL tke_rst( kstp, 'WRITE' )
[2528]	143	IF( lrst_oce .AND. lk_zdfgls ) CALL gls_rst( kstp, 'WRITE' )
[1492]	144	!
[3764]	145	! LATERAL PHYSICS
[1492]	146	!
	147	IF( lk_ldfslp ) THEN ! slope of lateral mixing
[2528]	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( ln_traldf_grif ) THEN ! before slope for Griffies operator
	152	CALL ldf_slp_grif( kstp )
	153	ELSE
	154	CALL ldf_slp( kstp, rhd, rn2b ) ! before slope for Madec operator
	155	ENDIF
[1481]	156	ENDIF
[3]	157	#if defined key_traldf_c2d
[1492]	158	IF( lk_traldf_eiv ) CALL ldf_eiv( kstp ) ! eddy induced velocity coefficient
[2528]	159	#endif
[3634]	160	#if defined key_traldf_c3d && key_traldf_smag
	161	CALL ldf_tra_smag( kstp ) ! eddy induced velocity coefficient
	162	# endif
	163	#if defined key_dynldf_c3d && key_dynldf_smag
	164	CALL ldf_dyn_smag( kstp ) ! eddy induced velocity coefficient
	165	# endif
[3]	166
[3634]	167
[1482]	168	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[3294]	169	! diagnostics and outputs (ua, va, tsa used as workspace)
[1482]	170	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	171	IF( lk_floats ) CALL flo_stp( kstp ) ! drifting Floats
	172	IF( lk_diahth ) CALL dia_hth( kstp ) ! Thermocline depth (20 degres isotherm depth)
	173	IF( lk_diafwb ) CALL dia_fwb( kstp ) ! Fresh water budget diagnostics
	174	IF( ln_diaptr ) CALL dia_ptr( kstp ) ! Poleward TRansports diagnostics
[3294]	175	IF( lk_diadct ) CALL dia_dct( kstp ) ! Transports
[1756]	176	IF( lk_diaar5 ) CALL dia_ar5( kstp ) ! ar5 diag
[3294]	177	IF( lk_diaharm ) CALL dia_harm( kstp ) ! Tidal harmonic analysis
[1635]	178	CALL dia_wri( kstp ) ! ocean model: outputs
[4152]	179	!
	180	IF( ln_crs ) CALL crs_fld( kstp ) ! ocean model: online field coarsening & output
[1482]	181
[4152]	182
[923]	183	#if defined key_top
[3]	184	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
	185	! Passive Tracer Model
	186	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	187	CALL trc_stp( kstp ) ! time-stepping
[3]	188	#endif
	189
	190	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[1492]	191	! Active tracers (ua, va used as workspace)
[3]	192	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[2528]	193	tsa(:,:,:,:) = 0.e0 ! set tracer trends to zero
[3]	194
[2528]	195	IF( ln_asmiau .AND. &
	196	& ln_trainc ) CALL tra_asm_inc( kstp ) ! apply tracer assimilation increment
[467]	197	CALL tra_sbc ( kstp ) ! surface boundary condition
	198	IF( ln_traqsr ) CALL tra_qsr ( kstp ) ! penetrative solar radiation qsr
[2528]	199	IF( ln_trabbc ) CALL tra_bbc ( kstp ) ! bottom heat flux
	200	IF( lk_trabbl ) CALL tra_bbl ( kstp ) ! advective (and/or diffusive) bottom boundary layer scheme
[3294]	201	IF( ln_tradmp ) CALL tra_dmp ( kstp ) ! internal damping trends
[3651]	202	IF( lk_bdy ) CALL bdy_tra_dmp( kstp ) ! bdy damping trends
[467]	203	CALL tra_adv ( kstp ) ! horizontal & vertical advection
[2528]	204	IF( lk_zdfkpp ) CALL tra_kpp ( kstp ) ! KPP non-local tracer fluxes
[467]	205	CALL tra_ldf ( kstp ) ! lateral mixing
[392]	206	#if defined key_agrif
[782]	207	IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra ! tracers sponge
[389]	208	#endif
[1111]	209	CALL tra_zdf ( kstp ) ! vertical mixing and after tracer fields
[1239]	210
[1492]	211	IF( ln_dynhpg_imp ) THEN ! semi-implicit hpg (time stepping then eos)
[2528]	212	IF( ln_zdfnpc ) CALL tra_npc( kstp ) ! update after fields by non-penetrative convection
	213	CALL tra_nxt( kstp ) ! tracer fields at next time step
	214	CALL eos ( tsa, rhd, rhop ) ! Time-filtered in situ density for hpg computation
	215	IF( ln_zps ) CALL zps_hde( kstp, jpts, tsa, gtsu, gtsv, & ! zps: time filtered hor. derivative
	216	& rhd, gru , grv ) ! of t, s, rd at the last ocean level
[3764]	217
[4215]	218	ELSE ! centered hpg (eos then time stepping)
[2528]	219	CALL eos ( tsn, rhd, rhop ) ! now in situ density for hpg computation
	220	IF( ln_zps ) CALL zps_hde( kstp, jpts, tsn, gtsu, gtsv, & ! zps: now hor. derivative
	221	& rhd, gru , grv ) ! of t, s, rd at the last ocean level
	222	IF( ln_zdfnpc ) CALL tra_npc( kstp ) ! update after fields by non-penetrative convection
	223	CALL tra_nxt( kstp ) ! tracer fields at next time step
[3764]	224	ENDIF
[1481]	225
[3]	226	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[3294]	227	! Dynamics (tsa used as workspace)
[3]	228	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	229	ua(:,:,:) = 0.e0 ! set dynamics trends to zero
[75]	230	va(:,:,:) = 0.e0
[3]	231
[2528]	232	IF( ln_asmiau .AND. &
	233	& ln_dyninc ) CALL dyn_asm_inc( kstp ) ! apply dynamics assimilation increment
[3764]	234	IF( ln_bkgwri ) CALL asm_bkg_wri( kstp ) ! output background fields
[3294]	235	IF( ln_neptsimp ) CALL dyn_nept_cor( kstp ) ! subtract Neptune velocities (simplified)
[3651]	236	IF( lk_bdy ) CALL bdy_dyn3d_dmp(kstp ) ! bdy damping trends
[1492]	237	CALL dyn_adv( kstp ) ! advection (vector or flux form)
	238	CALL dyn_vor( kstp ) ! vorticity term including Coriolis
	239	CALL dyn_ldf( kstp ) ! lateral mixing
[3294]	240	IF( ln_neptsimp ) CALL dyn_nept_cor( kstp ) ! add Neptune velocities (simplified)
[392]	241	#if defined key_agrif
[1492]	242	IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_dyn ! momemtum sponge
[389]	243	#endif
[1492]	244	CALL dyn_hpg( kstp ) ! horizontal gradient of Hydrostatic pressure
[3764]	245	CALL dyn_bfr( kstp ) ! bottom friction
[1492]	246	CALL dyn_zdf( kstp ) ! vertical diffusion
	247	CALL dyn_spg( kstp, indic ) ! surface pressure gradient
	248	CALL dyn_nxt( kstp ) ! lateral velocity at next time step
[3]	249
[1492]	250	CALL ssh_nxt( kstp ) ! sea surface height at next time step
[593]	251
[2528]	252	IF( ln_diahsb ) CALL dia_hsb( kstp ) ! - ML - global conservation diagnostics
	253	IF( lk_diaobs ) CALL dia_obs( kstp ) ! obs-minus-model (assimilation) diagnostics (call after dynamics update)
	254
[4161]	255	IF( lrst_oce .AND. ln_diahsb ) CALL dia_hsb_rst( kstp, 'WRITE' )
[3]	256	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[888]	257	! Control and restarts
[3]	258	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	259	CALL stp_ctl( kstp, indic )
	260	IF( indic < 0 ) THEN
	261	CALL ctl_stop( 'step: indic < 0' )
	262	CALL dia_wri_state( 'output.abort', kstp )
[1482]	263	ENDIF
[4147]	264	IF( kstp == nit000 ) THEN
	265	CALL iom_close( numror ) ! close input ocean restart file
	266	CALL FLUSH ( numond ) ! flush output namelist oce
	267	CALL FLUSH ( numoni ) ! flush output namelist ice
	268	ENDIF
[1492]	269	IF( lrst_oce ) CALL rst_write ( kstp ) ! write output ocean restart file
	270	IF( lk_obc ) CALL obc_rst_write( kstp ) ! write open boundary restart file
[3]	271
[508]	272	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[3294]	273	! Trends (ua, va, tsa used as workspace)
[508]	274	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[3764]	275	IF( nstop == 0 ) THEN
	276	IF( lk_trddyn ) CALL trd_dwr( kstp ) ! trends: dynamics
[1492]	277	IF( lk_trdtra ) CALL trd_twr( kstp ) ! trends: active tracers
[3764]	278	IF( lk_trdmld ) CALL trd_mld( kstp ) ! trends: Mixed-layer
[1492]	279	IF( lk_trdvor ) CALL trd_vor( kstp ) ! trends: vorticity budget
[75]	280	ENDIF
[3]	281
[75]	282	!>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
	283	! Coupled mode
	284	!<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
[1492]	285	IF( lk_cpl ) CALL sbc_cpl_snd( kstp ) ! coupled mode : field exchanges
[508]	286	!
[4153]	287	#if defined key_iomput
	288	IF( kstp == nitend .OR. indic < 0 ) THEN
[4152]	289	CALL iom_context_finalize( "nemo" ) ! needed for XIOS+AGRIF
	290	IF( ln_crs ) CALL iom_context_finalize( "nemo_crs" ) !
	291	ENDIF
[4153]	292	#endif
[3769]	293	!
[3294]	294	IF( nn_timing == 1 .AND. kstp == nit000 ) CALL timing_reset
[1481]	295	!
[3]	296	END SUBROUTINE stp
	297
	298	!!======================================================================
	299	END MODULE step

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

Download in other formats: