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

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

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

Download in other formats: