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

Context Navigation

source: branches/2011/dev_r2787_NOCS_NEPTUNE/NEMOGCM/NEMO/OPA_SRC/step.F90 @ 2795

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

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

Download in other formats: