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/UKMO/dev_r5518_GO6_package_inc_asm/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_inc_asm/NEMOGCM/NEMO/OPA_SRC/DYN/sshwzv.F90 @ 8041

Last change on this file since 8041 was 8041, checked in by jwhile, 7 years ago
Further merge of dev_r5518_ssh_with_VVL
File size: 13.3 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
[2528]	7	!! 3.3 ! 2010-04 (M. Leclair, G. Madec) modified LF-RA
	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
[4292]	10	!! 3.3 ! 2011-10 (M. Leclair) split former ssh_wzv routine and remove all vvl related work
[3]	11	!!----------------------------------------------------------------------
[1438]	12
[3]	13	!!----------------------------------------------------------------------
[4292]	14	!! ssh_nxt : after ssh
	15	!! ssh_swp : filter ans swap the ssh arrays
	16	!! wzv : compute now vertical velocity
[1438]	17	!!----------------------------------------------------------------------
[3]	18	USE oce ! ocean dynamics and tracers variables
	19	USE dom_oce ! ocean space and time domain variables
[888]	20	USE sbc_oce ! surface boundary condition: ocean
	21	USE domvvl ! Variable volume
[1565]	22	USE divcur ! hor. divergence and curl (div & cur routines)
[4292]	23	USE restart ! only for lrst_oce
[3]	24	USE in_out_manager ! I/O manager
[258]	25	USE prtctl ! Print control
[592]	26	USE phycst
	27	USE lbclnk ! ocean lateral boundary condition (or mpp link)
[2715]	28	USE lib_mpp ! MPP library
[2528]	29	USE bdy_oce
[4292]	30	USE bdy_par
	31	USE bdydyn2d ! bdy_ssh routine
[2528]	32	#if defined key_agrif
[2486]	33	USE agrif_opa_interp
[2528]	34	#endif
	35	#if defined key_asminc
	36	USE asminc ! Assimilation increment
	37	#endif
[3294]	38	USE wrk_nemo ! Memory Allocation
	39	USE timing ! Timing
[592]	40
[3]	41	IMPLICIT NONE
	42	PRIVATE
	43
[1438]	44	PUBLIC ssh_nxt ! called by step.F90
[4292]	45	PUBLIC wzv ! called by step.F90
	46	PUBLIC ssh_swp ! called by step.F90
[3]	47
	48	!! * Substitutions
	49	# include "domzgr_substitute.h90"
[1438]	50	# include "vectopt_loop_substitute.h90"
[3]	51	!!----------------------------------------------------------------------
[2528]	52	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[888]	53	!! $Id$
[2715]	54	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[592]	55	!!----------------------------------------------------------------------
[3]	56	CONTAINS
	57
[4292]	58	SUBROUTINE ssh_nxt( kt )
[3]	59	!!----------------------------------------------------------------------
[4292]	60	!! * ROUTINE ssh_nxt *
[1438]	61	!!
[4292]	62	!! ** Purpose : compute the after ssh (ssha)
[3]	63	!!
[4292]	64	!! ** Method : - Using the incompressibility hypothesis, the ssh increment
	65	!! is computed by integrating the horizontal divergence and multiply by
	66	!! by the time step.
[3]	67	!!
[1438]	68	!! ** action : ssha : after sea surface height
[2528]	69	!!
	70	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
[3]	71	!!----------------------------------------------------------------------
[2715]	72	!
[4292]	73	REAL(wp), POINTER, DIMENSION(:,: ) :: zhdiv
	74	INTEGER, INTENT(in) :: kt ! time step
	75	!
[8041]	76	INTEGER :: ji, jj, jk ! dummy loop indices
[4292]	77	REAL(wp) :: z2dt, z1_rau0 ! local scalars
[3]	78	!!----------------------------------------------------------------------
[3294]	79	!
[4292]	80	IF( nn_timing == 1 ) CALL timing_start('ssh_nxt')
[3294]	81	!
[4292]	82	CALL wrk_alloc( jpi, jpj, zhdiv )
[3294]	83	!
[3]	84	IF( kt == nit000 ) THEN
[2528]	85	!
[3]	86	IF(lwp) WRITE(numout,*)
[4292]	87	IF(lwp) WRITE(numout,*) 'ssh_nxt : after sea surface height'
[1438]	88	IF(lwp) WRITE(numout,*) '~~~~~~~ '
	89	!
[3]	90	ENDIF
[2528]	91	!
	92	CALL div_cur( kt ) ! Horizontal divergence & Relative vorticity
	93	!
[2715]	94	z2dt = 2._wp * rdt ! set time step size (Euler/Leapfrog)
	95	IF( neuler == 0 .AND. kt == nit000 ) z2dt = rdt
[3]	96
[8041]	97
	98	#if defined key_asminc
	99	! ! Include the IAU weighted SSH increment
	100	IF( lk_asminc .AND. ln_sshinc .AND. ln_asmiau ) THEN
	101	CALL ssh_asm_inc( kt )
	102	#if defined key_vvl
	103	! Don't directly adjust ssh but change hdivn at all levels instead
	104	! In trasbc also add in the heat and salt content associated with these changes at each level
	105	DO jk = 1, jpkm1
	106	hdivn(:,:,jk) = hdivn(:,:,jk) - ( ssh_iau(:,:) / ( ht_0(:,:) + 1.0 - ssmask(:,:) ) ) * ( e3t_0(:,:,jk) / fse3t_n(:,:,jk) ) * tmask(:,:,jk)
	107	END DO
	108	CALL lbc_lnk( hdivn, 'T', 1. ) ! Not sure that's necessary
	109	ENDIF
	110	#endif
	111	#endif
	112
	113
[1438]	114	! !------------------------------!
	115	! ! After Sea Surface Height !
	116	! !------------------------------!
[2715]	117	zhdiv(:,:) = 0._wp
[1438]	118	DO jk = 1, jpkm1 ! Horizontal divergence of barotropic transports
[4292]	119	zhdiv(:,:) = zhdiv(:,:) + fse3t_n(:,:,jk) * hdivn(:,:,jk)
[1438]	120	END DO
	121	! ! Sea surface elevation time stepping
[4338]	122	! In time-split case we need a first guess of the ssh after (using the baroclinic timestep) in order to
	123	! compute the vertical velocity which can be used to compute the non-linear terms of the momentum equations.
	124	!
[4292]	125	z1_rau0 = 0.5_wp * r1_rau0
[4990]	126	ssha(:,:) = ( sshb(:,:) - z2dt * ( z1_rau0 * ( emp_b(:,:) + emp(:,:) ) + zhdiv(:,:) ) ) * ssmask(:,:)
[1438]	127
[4486]	128	#if ! defined key_dynspg_ts
	129	! These lines are not necessary with time splitting since
	130	! boundary condition on sea level is set during ts loop
[2486]	131	#if defined key_agrif
[2715]	132	CALL agrif_ssh( kt )
[2486]	133	#endif
[2528]	134	#if defined key_bdy
[4292]	135	IF (lk_bdy) THEN
	136	CALL lbc_lnk( ssha, 'T', 1. ) ! Not sure that's necessary
	137	CALL bdy_ssh( ssha ) ! Duplicate sea level across open boundaries
	138	ENDIF
[2528]	139	#endif
[4486]	140	#endif
	141
[4292]	142
	143	! !------------------------------!
	144	! ! outputs !
	145	! !------------------------------!
	146	!
	147	IF(ln_ctl) CALL prt_ctl( tab2d_1=ssha, clinfo1=' ssha - : ', mask1=tmask, ovlap=1 )
	148	!
	149	CALL wrk_dealloc( jpi, jpj, zhdiv )
	150	!
	151	IF( nn_timing == 1 ) CALL timing_stop('ssh_nxt')
	152	!
	153	END SUBROUTINE ssh_nxt
	154
	155
	156	SUBROUTINE wzv( kt )
	157	!!----------------------------------------------------------------------
	158	!! * ROUTINE wzv *
	159	!!
	160	!! ** Purpose : compute the now vertical velocity
	161	!!
	162	!! ** Method : - Using the incompressibility hypothesis, the vertical
	163	!! velocity is computed by integrating the horizontal divergence
	164	!! from the bottom to the surface minus the scale factor evolution.
	165	!! The boundary conditions are w=0 at the bottom (no flux) and.
	166	!!
	167	!! ** action : wn : now vertical velocity
	168	!!
	169	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
	170	!!----------------------------------------------------------------------
	171	!
	172	INTEGER, INTENT(in) :: kt ! time step
	173	REAL(wp), POINTER, DIMENSION(:,: ) :: z2d
	174	REAL(wp), POINTER, DIMENSION(:,:,:) :: z3d, zhdiv
	175	!
	176	INTEGER :: ji, jj, jk ! dummy loop indices
	177	REAL(wp) :: z1_2dt ! local scalars
	178	!!----------------------------------------------------------------------
	179
	180	IF( nn_timing == 1 ) CALL timing_start('wzv')
	181	!
	182	IF( kt == nit000 ) THEN
	183	!
	184	IF(lwp) WRITE(numout,*)
	185	IF(lwp) WRITE(numout,*) 'wzv : now vertical velocity '
	186	IF(lwp) WRITE(numout,*) '~~~~~ '
	187	!
	188	wn(:,:,jpk) = 0._wp ! bottom boundary condition: w=0 (set once for all)
	189	!
	190	ENDIF
	191	! !------------------------------!
	192	! ! Now Vertical Velocity !
	193	! !------------------------------!
	194	z1_2dt = 1. / ( 2. * rdt ) ! set time step size (Euler/Leapfrog)
	195	IF( neuler == 0 .AND. kt == nit000 ) z1_2dt = 1. / rdt
	196	!
	197	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! z_tilde and layer cases
	198	CALL wrk_alloc( jpi, jpj, jpk, zhdiv )
	199	!
	200	DO jk = 1, jpkm1
	201	! horizontal divergence of thickness diffusion transport ( velocity multiplied by e3t)
[4338]	202	! - ML - note: computation already done in dom_vvl_sf_nxt. Could be optimized (not critical and clearer this way)
[4292]	203	DO jj = 2, jpjm1
	204	DO ji = fs_2, fs_jpim1 ! vector opt.
	205	zhdiv(ji,jj,jk) = r1_e12t(ji,jj) * ( un_td(ji,jj,jk) - un_td(ji-1,jj,jk) + vn_td(ji,jj,jk) - vn_td(ji,jj-1,jk) )
	206	END DO
[592]	207	END DO
	208	END DO
[4292]	209	CALL lbc_lnk(zhdiv, 'T', 1.) ! - ML - Perhaps not necessary: not used for horizontal "connexions"
	210	! ! Is it problematic to have a wrong vertical velocity in boundary cells?
	211	! ! Same question holds for hdivn. Perhaps just for security
	212	DO jk = jpkm1, 1, -1 ! integrate from the bottom the hor. divergence
	213	! computation of w
	214	wn(:,:,jk) = wn(:,:,jk+1) - ( fse3t_n(:,:,jk) * hdivn(:,:,jk) + zhdiv(:,:,jk) &
	215	& + z1_2dt * ( fse3t_a(:,:,jk) - fse3t_b(:,:,jk) ) ) * tmask(:,:,jk)
	216	END DO
	217	! IF( ln_vvl_layer ) wn(:,:,:) = 0.e0
	218	CALL wrk_dealloc( jpi, jpj, jpk, zhdiv )
	219	ELSE ! z_star and linear free surface cases
	220	DO jk = jpkm1, 1, -1 ! integrate from the bottom the hor. divergence
	221	! computation of w
	222	wn(:,:,jk) = wn(:,:,jk+1) - ( fse3t_n(:,:,jk) * hdivn(:,:,jk) &
	223	& + z1_2dt * ( fse3t_a(:,:,jk) - fse3t_b(:,:,jk) ) ) * tmask(:,:,jk)
	224	END DO
[1438]	225	ENDIF
[592]	226
[2528]	227	#if defined key_bdy
[4327]	228	IF (lk_bdy) THEN
	229	DO jk = 1, jpkm1
	230	wn(:,:,jk) = wn(:,:,jk) * bdytmask(:,:)
	231	END DO
	232	ENDIF
[2528]	233	#endif
[4292]	234	!
	235	IF( nn_timing == 1 ) CALL timing_stop('wzv')
[592]	236
	237
[4292]	238	END SUBROUTINE wzv
	239
	240	SUBROUTINE ssh_swp( kt )
[1438]	241	!!----------------------------------------------------------------------
	242	!! * ROUTINE ssh_nxt *
	243	!!
	244	!! ** Purpose : achieve the sea surface height time stepping by
	245	!! applying Asselin time filter and swapping the arrays
[4292]	246	!! ssha already computed in ssh_nxt
[1438]	247	!!
[2528]	248	!! ** Method : - apply Asselin time fiter to now ssh (excluding the forcing
	249	!! from the filter, see Leclair and Madec 2010) and swap :
	250	!! sshn = ssha + atfp * ( sshb -2 sshn + ssha )
	251	!! - atfp * rdt * ( emp_b - emp ) / rau0
	252	!! sshn = ssha
[1438]	253	!!
	254	!! ** action : - sshb, sshn : before & now sea surface height
	255	!! ready for the next time step
[2528]	256	!!
	257	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
[1438]	258	!!----------------------------------------------------------------------
[2528]	259	INTEGER, INTENT(in) :: kt ! ocean time-step index
[1438]	260	!!----------------------------------------------------------------------
[3294]	261	!
[4292]	262	IF( nn_timing == 1 ) CALL timing_start('ssh_swp')
[3294]	263	!
[1438]	264	IF( kt == nit000 ) THEN
	265	IF(lwp) WRITE(numout,*)
[4292]	266	IF(lwp) WRITE(numout,*) 'ssh_swp : Asselin time filter and swap of sea surface height'
[1438]	267	IF(lwp) WRITE(numout,*) '~~~~~~~ '
	268	ENDIF
[592]	269
[4292]	270	# if defined key_dynspg_ts
	271	IF( ( neuler == 0 .AND. kt == nit000 ) .OR. ln_bt_fw ) THEN !** Euler time-stepping: no filter
	272	# else
	273	IF ( neuler == 0 .AND. kt == nit000 ) THEN !** Euler time-stepping at first time-step : no filter
	274	#endif
	275	sshb(:,:) = sshn(:,:) ! before <-- now
	276	sshn(:,:) = ssha(:,:) ! now <-- after (before already = now)
	277	ELSE !** Leap-Frog time-stepping: Asselin filter + swap
	278	sshb(:,:) = sshn(:,:) + atfp * ( sshb(:,:) - 2 * sshn(:,:) + ssha(:,:) ) ! before <-- now filtered
[6487]	279	IF( lk_vvl ) sshb(:,:) = sshb(:,:) - atfp * rdt / rau0 * ( emp_b(:,:) - emp(:,:) &
	280	& - rnf_b(:,:) + rnf(:,:) &
	281	& + fwfisf_b(:,:) - fwfisf(:,:) ) * ssmask(:,:)
[4292]	282	sshn(:,:) = ssha(:,:) ! now <-- after
[1438]	283	ENDIF
	284	!
[2528]	285	IF(ln_ctl) CALL prt_ctl( tab2d_1=sshb, clinfo1=' sshb - : ', mask1=tmask, ovlap=1 )
	286	!
[4292]	287	IF( nn_timing == 1 ) CALL timing_stop('ssh_swp')
[3294]	288	!
[4292]	289	END SUBROUTINE ssh_swp
[3]	290
	291	!!======================================================================
[1565]	292	END MODULE sshwzv

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

Download in other formats: