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

Context Navigation

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

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

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

Download in other formats: