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.

sshwzv.F90 in branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

Context Navigation

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/DYN/sshwzv.F90 @ 2487

Last change on this file since 2487 was 2487, checked in by rblod, 13 years ago
Correct Agrif inconstency for ssh, nemo_v3_3_beta version, see ticket #669
Property svn:keywords set to `Id`
File size: 18.1 KB

Rev	Line
[1565]	1	MODULE sshwzv
[3]	2	!!==============================================================================
[1438]	3	!! * MODULE sshwzv *
	4	!! Ocean dynamics : sea surface height and vertical velocity
[3]	5	!!==============================================================================
[1438]	6	!! History : 3.1 ! 2009-02 (G. Madec, M. Leclair) Original code
[2148]	7	!! 3.3 ! 2010-04 (M. Leclair, G. Madec) modified LF-RA
[2236]	8	!! - ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
	9	!! - ! 2010-09 (D.Storkey and E.O'Dea) bug fixes for BDY module
[3]	10	!!----------------------------------------------------------------------
[1438]	11
[3]	12	!!----------------------------------------------------------------------
[1438]	13	!! ssh_wzv : after ssh & now vertical velocity
	14	!! ssh_nxt : filter ans swap the ssh arrays
	15	!!----------------------------------------------------------------------
[3]	16	USE oce ! ocean dynamics and tracers variables
	17	USE dom_oce ! ocean space and time domain variables
[888]	18	USE sbc_oce ! surface boundary condition: ocean
	19	USE domvvl ! Variable volume
[1565]	20	USE divcur ! hor. divergence and curl (div & cur routines)
[1438]	21	USE iom ! I/O library
	22	USE restart ! only for lrst_oce
[3]	23	USE in_out_manager ! I/O manager
[258]	24	USE prtctl ! Print control
[592]	25	USE phycst
	26	USE lbclnk ! ocean lateral boundary condition (or mpp link)
[1241]	27	USE obc_par ! open boundary cond. parameter
	28	USE obc_oce
[2236]	29	USE bdy_oce
[1756]	30	USE diaar5, ONLY : lk_diaar5
[1482]	31	USE iom
[2236]	32	USE sbcrnf, ONLY : h_rnf, nk_rnf ! River runoff
[2487]	33	#if defined key_agrif
	34	USE agrif_opa_update
	35	USE agrif_opa_interp
	36	#endif
[2236]	37	#if defined key_asminc
	38	USE asminc ! Assimilation increment
	39	#endif
[592]	40
[3]	41	IMPLICIT NONE
	42	PRIVATE
	43
[1438]	44	PUBLIC ssh_wzv ! called by step.F90
	45	PUBLIC ssh_nxt ! called by step.F90
[3]	46
	47	!! * Substitutions
	48	# include "domzgr_substitute.h90"
[1438]	49	# include "vectopt_loop_substitute.h90"
[3]	50	!!----------------------------------------------------------------------
[2287]	51	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[888]	52	!! $Id$
[2287]	53	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[592]	54	!!----------------------------------------------------------------------
[3]	55
	56	CONTAINS
	57
[1438]	58	SUBROUTINE ssh_wzv( kt )
[3]	59	!!----------------------------------------------------------------------
[1438]	60	!! * ROUTINE ssh_wzv *
	61	!!
	62	!! ** Purpose : compute the after ssh (ssha), the now vertical velocity
	63	!! and update the now vertical coordinate (lk_vvl=T).
[3]	64	!!
[2148]	65	!! ** Method : - Using the incompressibility hypothesis, the vertical
[1438]	66	!! velocity is computed by integrating the horizontal divergence
	67	!! from the bottom to the surface minus the scale factor evolution.
	68	!! The boundary conditions are w=0 at the bottom (no flux) and.
[3]	69	!!
[1438]	70	!! ** action : ssha : after sea surface height
	71	!! wn : now vertical velocity
[2148]	72	!! sshu_a, sshv_a, sshf_a : after sea surface height (lk_vvl=T)
	73	!! hu, hv, hur, hvr : ocean depth and its inverse at u-,v-points
	74	!!
	75	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
[3]	76	!!----------------------------------------------------------------------
[1756]	77	USE oce, ONLY : z3d => ta ! use ta as 3D workspace
	78	!!
[1438]	79	INTEGER, INTENT(in) :: kt ! time step
	80	!!
	81	INTEGER :: ji, jj, jk ! dummy loop indices
	82	REAL(wp) :: zcoefu, zcoefv, zcoeff ! temporary scalars
[2148]	83	REAL(wp) :: z2dt, z1_2dt, z1_rau0 ! temporary scalars
[1438]	84	REAL(wp), DIMENSION(jpi,jpj) :: zhdiv ! 2D workspace
[1756]	85	REAL(wp), DIMENSION(jpi,jpj) :: z2d ! 2D workspace
[3]	86	!!----------------------------------------------------------------------
	87
	88	IF( kt == nit000 ) THEN
[2148]	89	!
[3]	90	IF(lwp) WRITE(numout,*)
[1438]	91	IF(lwp) WRITE(numout,*) 'ssh_wzv : after sea surface height and now vertical velocity '
	92	IF(lwp) WRITE(numout,*) '~~~~~~~ '
	93	!
	94	wn(:,:,jpk) = 0.e0 ! bottom boundary condition: w=0 (set once for all)
	95	!
	96	IF( lk_vvl ) THEN ! before and now Sea SSH at u-, v-, f-points (vvl case only)
	97	DO jj = 1, jpjm1
	98	DO ji = 1, jpim1 ! caution: use of Vector Opt. not possible
	99	zcoefu = 0.5 * umask(ji,jj,1) / ( e1u(ji,jj) * e2u(ji,jj) )
	100	zcoefv = 0.5 * vmask(ji,jj,1) / ( e1v(ji,jj) * e2v(ji,jj) )
	101	zcoeff = 0.25 * umask(ji,jj,1) * umask(ji,jj+1,1)
	102	sshu_b(ji,jj) = zcoefu * ( e1t(ji ,jj) * e2t(ji ,jj) * sshb(ji ,jj) &
	103	& + e1t(ji+1,jj) * e2t(ji+1,jj) * sshb(ji+1,jj) )
	104	sshv_b(ji,jj) = zcoefv * ( e1t(ji,jj ) * e2t(ji,jj ) * sshb(ji,jj ) &
	105	& + e1t(ji,jj+1) * e2t(ji,jj+1) * sshb(ji,jj+1) )
	106	sshu_n(ji,jj) = zcoefu * ( e1t(ji ,jj) * e2t(ji ,jj) * sshn(ji ,jj) &
	107	& + e1t(ji+1,jj) * e2t(ji+1,jj) * sshn(ji+1,jj) )
	108	sshv_n(ji,jj) = zcoefv * ( e1t(ji,jj ) * e2t(ji,jj ) * sshn(ji,jj ) &
	109	& + e1t(ji,jj+1) * e2t(ji,jj+1) * sshn(ji,jj+1) )
	110	END DO
	111	END DO
	112	CALL lbc_lnk( sshu_b, 'U', 1. ) ; CALL lbc_lnk( sshu_n, 'U', 1. )
	113	CALL lbc_lnk( sshv_b, 'V', 1. ) ; CALL lbc_lnk( sshv_n, 'V', 1. )
[2148]	114	DO jj = 1, jpjm1
	115	DO ji = 1, jpim1 ! NO Vector Opt.
	116	sshf_n(ji,jj) = 0.5 * umask(ji,jj,1) * umask(ji,jj+1,1) &
	117	& / ( e1f(ji,jj ) * e2f(ji,jj ) ) &
	118	& * ( e1u(ji,jj ) * e2u(ji,jj ) * sshu_n(ji,jj ) &
	119	& + e1u(ji,jj+1) * e2u(ji,jj+1) * sshu_n(ji,jj+1) )
	120	END DO
	121	END DO
	122	CALL lbc_lnk( sshf_n, 'F', 1. )
[1438]	123	ENDIF
	124	!
[3]	125	ENDIF
	126
[2148]	127	! !------------------------------------------!
	128	IF( lk_vvl ) THEN ! Regridding: Update Now Vertical coord. ! (only in vvl case)
	129	! !------------------------------------------!
[1565]	130	DO jk = 1, jpkm1
[2148]	131	fsdept(:,:,jk) = fsdept_n(:,:,jk) ! now local depths stored in fsdep. arrays
[1565]	132	fsdepw(:,:,jk) = fsdepw_n(:,:,jk)
	133	fsde3w(:,:,jk) = fsde3w_n(:,:,jk)
	134	!
[2148]	135	fse3t (:,:,jk) = fse3t_n (:,:,jk) ! vertical scale factors stored in fse3. arrays
[1565]	136	fse3u (:,:,jk) = fse3u_n (:,:,jk)
	137	fse3v (:,:,jk) = fse3v_n (:,:,jk)
	138	fse3f (:,:,jk) = fse3f_n (:,:,jk)
	139	fse3w (:,:,jk) = fse3w_n (:,:,jk)
	140	fse3uw(:,:,jk) = fse3uw_n(:,:,jk)
	141	fse3vw(:,:,jk) = fse3vw_n(:,:,jk)
	142	END DO
[2148]	143	!
	144	hu(:,:) = hu_0(:,:) + sshu_n(:,:) ! now ocean depth (at u- and v-points)
[1565]	145	hv(:,:) = hv_0(:,:) + sshv_n(:,:)
[2148]	146	! ! now masked inverse of the ocean depth (at u- and v-points)
[1565]	147	hur(:,:) = umask(:,:,1) / ( hu(:,:) + 1.e0 - umask(:,:,1) )
	148	hvr(:,:) = vmask(:,:,1) / ( hv(:,:) + 1.e0 - vmask(:,:,1) )
[2236]	149	!
[1565]	150	ENDIF
[2148]	151	!
[2392]	152	CALL div_cur( kt ) ! Horizontal divergence & Relative vorticity
	153	!
[2148]	154	z2dt = 2. * rdt ! set time step size (Euler/Leapfrog)
[1607]	155	IF( neuler == 0 .AND. kt == nit000 ) z2dt =rdt
[3]	156
[1438]	157	! !------------------------------!
	158	! ! After Sea Surface Height !
	159	! !------------------------------!
	160	zhdiv(:,:) = 0.e0
	161	DO jk = 1, jpkm1 ! Horizontal divergence of barotropic transports
	162	zhdiv(:,:) = zhdiv(:,:) + fse3t(:,:,jk) * hdivn(:,:,jk)
	163	END DO
	164	! ! Sea surface elevation time stepping
[2148]	165	! In forward Euler time stepping case, the same formulation as in the leap-frog case can be used
[2266]	166	! because emp_b field is initialized with the vlaues of emp field. Hence, 0.5 * ( emp + emp_b ) = emp
[2148]	167	z1_rau0 = 0.5 / rau0
[2266]	168	ssha(:,:) = ( sshb(:,:) - z2dt * ( z1_rau0 * ( emp_b(:,:) + emp(:,:) ) + zhdiv(:,:) ) ) &
[2148]	169	& * tmask(:,:,1)
[1438]	170
[2487]	171	#if defined key_agrif
	172	CALL agrif_ssh(kt)
	173	#endif
[1438]	174	#if defined key_obc
[2148]	175	IF( Agrif_Root() ) THEN
[1438]	176	ssha(:,:) = ssha(:,:) * obctmsk(:,:)
[2148]	177	CALL lbc_lnk( ssha, 'T', 1. ) ! absolutly compulsory !! (jmm)
[1438]	178	ENDIF
	179	#endif
[2236]	180	#if defined key_bdy
	181	ssha(:,:) = ssha(:,:) * bdytmask(:,:)
	182	CALL lbc_lnk( ssha, 'T', 1. )
	183	#endif
	184
[1438]	185	! ! Sea Surface Height at u-,v- and f-points (vvl case only)
	186	IF( lk_vvl ) THEN ! (required only in key_vvl case)
	187	DO jj = 1, jpjm1
[1694]	188	DO ji = 1, jpim1 ! NO Vector Opt.
[1438]	189	sshu_a(ji,jj) = 0.5 * umask(ji,jj,1) / ( e1u(ji ,jj) * e2u(ji ,jj) ) &
	190	& * ( e1t(ji ,jj) * e2t(ji ,jj) * ssha(ji ,jj) &
	191	& + e1t(ji+1,jj) * e2t(ji+1,jj) * ssha(ji+1,jj) )
	192	sshv_a(ji,jj) = 0.5 * vmask(ji,jj,1) / ( e1v(ji,jj ) * e2v(ji,jj ) ) &
	193	& * ( e1t(ji,jj ) * e2t(ji,jj ) * ssha(ji,jj ) &
	194	& + e1t(ji,jj+1) * e2t(ji,jj+1) * ssha(ji,jj+1) )
[592]	195	END DO
	196	END DO
[2148]	197	! Boundaries conditions
	198	CALL lbc_lnk( sshu_a, 'U', 1. )
[1438]	199	CALL lbc_lnk( sshv_a, 'V', 1. )
	200	ENDIF
[2236]	201	! Include the IAU weighted SSH increment
	202	#if defined key_asminc
	203	IF( ( lk_asminc ).AND.( ln_sshinc ).AND.( ln_asmiau ) ) THEN
	204	CALL ssh_asm_inc( kt )
	205	ssha(:,:) = ssha(:,:) + z2dt * ssh_iau(:,:)
	206	ENDIF
	207	#endif
	208
[1438]	209	! !------------------------------!
	210	! ! Now Vertical Velocity !
	211	! !------------------------------!
[2148]	212	z1_2dt = 1.e0 / z2dt
	213	DO jk = jpkm1, 1, -1 ! integrate from the bottom the hor. divergence
	214	! - ML - need 3 lines here because replacement of fse3t by its expression yields too long lines otherwise
	215	wn(:,:,jk) = wn(:,:,jk+1) - fse3t_n(:,:,jk) * hdivn(:,:,jk) &
	216	& - ( fse3t_a(:,:,jk) - fse3t_b(:,:,jk) ) &
	217	& * tmask(:,:,jk) * z1_2dt
[2236]	218	#if defined key_bdy
	219	wn(:,:,jk) = wn(:,:,jk) * bdytmask(:,:)
	220	#endif
[1438]	221	END DO
[2148]	222
	223	! !------------------------------!
	224	! ! outputs !
	225	! !------------------------------!
[1756]	226	CALL iom_put( "woce", wn ) ! vertical velocity
	227	CALL iom_put( "ssh" , sshn ) ! sea surface height
	228	CALL iom_put( "ssh2", sshn(:,:) * sshn(:,:) ) ! square of sea surface height
[2148]	229	IF( lk_diaar5 ) THEN ! vertical mass transport & its square value
	230	! Caution: in the VVL case, it only correponds to the baroclinic mass transport.
[1756]	231	z2d(:,:) = rau0 * e1t(:,:) * e2t(:,:)
	232	DO jk = 1, jpk
	233	z3d(:,:,jk) = wn(:,:,jk) * z2d(:,:)
	234	END DO
[2148]	235	CALL iom_put( "w_masstr" , z3d )
	236	CALL iom_put( "w_masstr2", z3d(:,:,:) * z3d(:,:,:) )
[1756]	237	ENDIF
[1438]	238	!
[2148]	239	IF(ln_ctl) CALL prt_ctl( tab2d_1=ssha, clinfo1=' ssha - : ', mask1=tmask, ovlap=1 )
	240	!
[1438]	241	END SUBROUTINE ssh_wzv
[592]	242
	243
[1438]	244	SUBROUTINE ssh_nxt( kt )
	245	!!----------------------------------------------------------------------
	246	!! * ROUTINE ssh_nxt *
	247	!!
	248	!! ** Purpose : achieve the sea surface height time stepping by
	249	!! applying Asselin time filter and swapping the arrays
	250	!! ssha already computed in ssh_wzv
	251	!!
[2148]	252	!! ** Method : - apply Asselin time fiter to now ssh (excluding the forcing
	253	!! from the filter, see Leclair and Madec 2010) and swap :
	254	!! sshn = ssha + atfp * ( sshb -2 sshn + ssha )
	255	!! - atfp * rdt * ( emp_b - emp ) / rau0
	256	!! sshn = ssha
[1438]	257	!!
	258	!! ** action : - sshb, sshn : before & now sea surface height
	259	!! ready for the next time step
[2148]	260	!!
	261	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
[1438]	262	!!----------------------------------------------------------------------
[2148]	263	INTEGER, INTENT(in) :: kt ! ocean time-step index
[1438]	264	!!
[2148]	265	INTEGER :: ji, jj ! dummy loop indices
	266	REAL(wp) :: zec ! temporary scalar
[1438]	267	!!----------------------------------------------------------------------
[592]	268
[1438]	269	IF( kt == nit000 ) THEN
	270	IF(lwp) WRITE(numout,*)
	271	IF(lwp) WRITE(numout,*) 'ssh_nxt : next sea surface height (Asselin time filter + swap)'
	272	IF(lwp) WRITE(numout,*) '~~~~~~~ '
	273	ENDIF
[592]	274
[2148]	275	! !--------------------------!
	276	IF( lk_vvl ) THEN ! Variable volume levels !
	277	! !--------------------------!
	278	!
	279	! ssh at t-, u-, v, f-points
	280	!===========================
[1438]	281	IF( neuler == 0 .AND. kt == nit000 ) THEN ! Euler time-stepping at first time-step : no filter
	282	sshn (:,:) = ssha (:,:) ! now <-- after (before already = now)
	283	sshu_n(:,:) = sshu_a(:,:)
	284	sshv_n(:,:) = sshv_a(:,:)
[2148]	285	DO jj = 1, jpjm1
	286	DO ji = 1, jpim1 ! NO Vector Opt.
	287	sshf_n(ji,jj) = 0.5 * umask(ji,jj,1) * umask(ji,jj+1,1) &
	288	& / ( e1f(ji,jj ) * e2f(ji,jj ) ) &
	289	& * ( e1u(ji,jj ) * e2u(ji,jj ) * sshu_n(ji,jj ) &
	290	& + e1u(ji,jj+1) * e2u(ji,jj+1) * sshu_n(ji,jj+1) )
	291	END DO
	292	END DO
	293	! Boundaries conditions
	294	CALL lbc_lnk( sshf_n, 'F', 1. )
[1438]	295	ELSE ! Leap-Frog time-stepping: Asselin filter + swap
[2148]	296	zec = atfp * rdt / rau0
[1438]	297	DO jj = 1, jpj
	298	DO ji = 1, jpi ! before <-- now filtered
[2148]	299	sshb (ji,jj) = sshn (ji,jj) + atfp * ( sshb(ji,jj) - 2 * sshn(ji,jj) + ssha(ji,jj) ) &
	300	& - zec * ( emp_b(ji,jj) - emp(ji,jj) ) * tmask(ji,jj,1)
[1438]	301	sshn (ji,jj) = ssha (ji,jj) ! now <-- after
	302	sshu_n(ji,jj) = sshu_a(ji,jj)
	303	sshv_n(ji,jj) = sshv_a(ji,jj)
	304	END DO
	305	END DO
[2148]	306	DO jj = 1, jpjm1
	307	DO ji = 1, jpim1 ! NO Vector Opt.
	308	sshf_n(ji,jj) = 0.5 * umask(ji,jj,1) * umask(ji,jj+1,1) &
	309	& / ( e1f(ji,jj ) * e2f(ji,jj ) ) &
	310	& * ( e1u(ji,jj ) * e2u(ji,jj ) * sshu_n(ji,jj ) &
	311	& + e1u(ji,jj+1) * e2u(ji,jj+1) * sshu_n(ji,jj+1) )
	312	END DO
	313	END DO
	314	! Boundaries conditions
	315	CALL lbc_lnk( sshf_n, 'F', 1. )
	316	DO jj = 1, jpjm1
	317	DO ji = 1, jpim1 ! NO Vector Opt.
	318	sshu_b(ji,jj) = 0.5 * umask(ji,jj,1) / ( e1u(ji ,jj) * e2u(ji ,jj) ) &
	319	& * ( e1t(ji ,jj) * e2t(ji ,jj) * sshb(ji ,jj) &
	320	& + e1t(ji+1,jj) * e2t(ji+1,jj) * sshb(ji+1,jj) )
	321	sshv_b(ji,jj) = 0.5 * vmask(ji,jj,1) / ( e1v(ji,jj ) * e2v(ji,jj ) ) &
	322	& * ( e1t(ji,jj ) * e2t(ji,jj ) * sshb(ji,jj ) &
	323	& + e1t(ji,jj+1) * e2t(ji,jj+1) * sshb(ji,jj+1) )
	324	END DO
	325	END DO
	326	! Boundaries conditions
	327	CALL lbc_lnk( sshu_b, 'U', 1. )
	328	CALL lbc_lnk( sshv_b, 'V', 1. )
[1438]	329	ENDIF
[2148]	330	! !--------------------------!
	331	ELSE ! fixed levels !
	332	! !--------------------------!
[1438]	333	!
[2148]	334	! ssh at t-point only
	335	!====================
[1438]	336	IF( neuler == 0 .AND. kt == nit000 ) THEN ! Euler time-stepping at first time-step : no filter
	337	sshn(:,:) = ssha(:,:) ! now <-- after (before already = now)
	338	!
	339	ELSE ! Leap-Frog time-stepping: Asselin filter + swap
	340	DO jj = 1, jpj
	341	DO ji = 1, jpi ! before <-- now filtered
[2148]	342	sshb(ji,jj) = sshn(ji,jj) + atfp * ( sshb(ji,jj) - 2 * sshn(ji,jj) + ssha(ji,jj) )
[1438]	343	sshn(ji,jj) = ssha(ji,jj) ! now <-- after
	344	END DO
	345	END DO
	346	ENDIF
	347	!
	348	ENDIF
	349	!
[2487]	350	! Update velocity at AGRIF zoom boundaries
	351	#id defined key_agrif
	352	IF ( .NOT.Agrif_Root() ) CALL Agrif_Update_Dyn( kt )
	353	#endif
	354	!
[2148]	355	IF(ln_ctl) CALL prt_ctl( tab2d_1=sshb, clinfo1=' sshb - : ', mask1=tmask, ovlap=1 )
[1438]	356	!
	357	END SUBROUTINE ssh_nxt
[3]	358
	359	!!======================================================================
[1565]	360	END MODULE sshwzv

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

Download in other formats: