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.

dynnxt.F90 in branches/2017/dev_r8624_ENHANCE4_FREESURFACE/NEMOGCM/NEMO/OPA_SRC/DYN – NEMO

Context Navigation

source: branches/2017/dev_r8624_ENHANCE4_FREESURFACE/NEMOGCM/NEMO/OPA_SRC/DYN/dynnxt.F90 @ 8805

Last change on this file since 8805 was 8805, checked in by jchanut, 6 years ago
Enhance4-freesurface. step 1: recover tracer conservation with split explicit free surface - #1959
Property svn:keywords set to `Id`
File size: 17.4 KB

Rev	Line
[3]	1	MODULE dynnxt
[1502]	2	!!=========================================================================
[3]	3	!! * MODULE dynnxt *
	4	!! Ocean dynamics: time stepping
[1502]	5	!!=========================================================================
[1438]	6	!! History : OPA ! 1987-02 (P. Andrich, D. L Hostis) Original code
	7	!! ! 1990-10 (C. Levy, G. Madec)
	8	!! 7.0 ! 1993-03 (M. Guyon) symetrical conditions
	9	!! 8.0 ! 1997-02 (G. Madec & M. Imbard) opa, release 8.0
	10	!! 8.2 ! 1997-04 (A. Weaver) Euler forward step
	11	!! - ! 1997-06 (G. Madec) lateral boudary cond., lbc routine
	12	!! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and module
	13	!! - ! 2002-10 (C. Talandier, A-M. Treguier) Open boundary cond.
	14	!! 2.0 ! 2005-11 (V. Garnier) Surface pressure gradient organization
	15	!! 2.3 ! 2007-07 (D. Storkey) Calls to BDY routines.
[1502]	16	!! 3.2 ! 2009-06 (G. Madec, R.Benshila) re-introduce the vvl option
[2528]	17	!! 3.3 ! 2010-09 (D. Storkey, E.O'Dea) Bug fix for BDY module
[2723]	18	!! 3.3 ! 2011-03 (P. Oddo) Bug fix for time-splitting+(BDY-OBC) and not VVL
[4292]	19	!! 3.5 ! 2013-07 (J. Chanut) Compliant with time splitting changes
[6140]	20	!! 3.6 ! 2014-04 (G. Madec) add the diagnostic of the time filter trends
[5930]	21	!! 3.7 ! 2015-11 (J. Chanut) Free surface simplification
[1502]	22	!!-------------------------------------------------------------------------
[1438]	23
[1502]	24	!!-------------------------------------------------------------------------
[6140]	25	!! dyn_nxt : obtain the next (after) horizontal velocity
[1502]	26	!!-------------------------------------------------------------------------
[6140]	27	USE oce ! ocean dynamics and tracers
	28	USE dom_oce ! ocean space and time domain
	29	USE sbc_oce ! Surface boundary condition: ocean fields
	30	USE phycst ! physical constants
	31	USE dynadv ! dynamics: vector invariant versus flux form
	32	USE dynspg_ts ! surface pressure gradient: split-explicit scheme
	33	USE domvvl ! variable volume
[7646]	34	USE bdy_oce , ONLY: ln_bdy
[6140]	35	USE bdydta ! ocean open boundary conditions
	36	USE bdydyn ! ocean open boundary conditions
	37	USE bdyvol ! ocean open boundary condition (bdy_vol routines)
	38	USE trd_oce ! trends: ocean variables
	39	USE trddyn ! trend manager: dynamics
	40	USE trdken ! trend manager: kinetic energy
[4990]	41	!
[6140]	42	USE in_out_manager ! I/O manager
	43	USE iom ! I/O manager library
	44	USE lbclnk ! lateral boundary condition (or mpp link)
	45	USE lib_mpp ! MPP library
	46	USE wrk_nemo ! Memory Allocation
	47	USE prtctl ! Print control
	48	USE timing ! Timing
[2528]	49	#if defined key_agrif
	50	USE agrif_opa_interp
	51	#endif
[3]	52
	53	IMPLICIT NONE
	54	PRIVATE
	55
[1438]	56	PUBLIC dyn_nxt ! routine called by step.F90
	57
[2715]	58	!!----------------------------------------------------------------------
[2528]	59	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[1438]	60	!! $Id$
[2715]	61	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
	62	!!----------------------------------------------------------------------
[3]	63	CONTAINS
	64
	65	SUBROUTINE dyn_nxt ( kt )
	66	!!----------------------------------------------------------------------
	67	!! * ROUTINE dyn_nxt *
	68	!!
[5930]	69	!! ** Purpose : Finalize after horizontal velocity. Apply the boundary
	70	!! condition on the after velocity, achieve the time stepping
[1502]	71	!! by applying the Asselin filter on now fields and swapping
	72	!! the fields.
[3]	73	!!
[5930]	74	!! ** Method : * Ensure after velocities transport matches time splitting
	75	!! estimate (ln_dynspg_ts=T)
[3]	76	!!
[1502]	77	!! * Apply lateral boundary conditions on after velocity
	78	!! at the local domain boundaries through lbc_lnk call,
[7646]	79	!! at the one-way open boundaries (ln_bdy=T),
[4990]	80	!! at the AGRIF zoom boundaries (lk_agrif=T)
[3]	81	!!
[1502]	82	!! * Apply the time filter applied and swap of the dynamics
	83	!! arrays to start the next time step:
	84	!! (ub,vb) = (un,vn) + atfp [ (ub,vb) + (ua,va) - 2 (un,vn) ]
	85	!! (un,vn) = (ua,va).
[6140]	86	!! Note that with flux form advection and non linear free surface,
	87	!! the time filter is applied on thickness weighted velocity.
	88	!! As a result, dyn_nxt MUST be called after tra_nxt.
[1502]	89	!!
	90	!! ** Action : ub,vb filtered before horizontal velocity of next time-step
	91	!! un,vn now horizontal velocity of next time-step
[3]	92	!!----------------------------------------------------------------------
	93	INTEGER, INTENT( in ) :: kt ! ocean time-step index
[2715]	94	!
[3]	95	INTEGER :: ji, jj, jk ! dummy loop indices
[6140]	96	INTEGER :: ikt ! local integers
	97	REAL(wp) :: zue3a, zue3n, zue3b, zuf, zcoef ! local scalars
[4990]	98	REAL(wp) :: zve3a, zve3n, zve3b, zvf, z1_2dt ! - -
	99	REAL(wp), POINTER, DIMENSION(:,:) :: zue, zve
	100	REAL(wp), POINTER, DIMENSION(:,:,:) :: ze3u_f, ze3v_f, zua, zva
[1502]	101	!!----------------------------------------------------------------------
[3294]	102	!
[4990]	103	IF( nn_timing == 1 ) CALL timing_start('dyn_nxt')
[3294]	104	!
[6140]	105	IF( ln_dynspg_ts ) CALL wrk_alloc( jpi,jpj, zue, zve)
	106	IF( l_trddyn ) CALL wrk_alloc( jpi,jpj,jpk, zua, zva)
[3294]	107	!
[3]	108	IF( kt == nit000 ) THEN
	109	IF(lwp) WRITE(numout,*)
	110	IF(lwp) WRITE(numout,*) 'dyn_nxt : time stepping'
	111	IF(lwp) WRITE(numout,*) '~~~~~~~'
	112	ENDIF
	113
[5930]	114	IF ( ln_dynspg_ts ) THEN
	115	! Ensure below that barotropic velocities match time splitting estimate
	116	! Compute actual transport and replace it with ts estimate at "after" time step
[7753]	117	zue(:,:) = e3u_a(:,:,1) * ua(:,:,1) * umask(:,:,1)
	118	zve(:,:) = e3v_a(:,:,1) * va(:,:,1) * vmask(:,:,1)
[5930]	119	DO jk = 2, jpkm1
[7753]	120	zue(:,:) = zue(:,:) + e3u_a(:,:,jk) * ua(:,:,jk) * umask(:,:,jk)
	121	zve(:,:) = zve(:,:) + e3v_a(:,:,jk) * va(:,:,jk) * vmask(:,:,jk)
[1502]	122	END DO
	123	DO jk = 1, jpkm1
[7753]	124	ua(:,:,jk) = ( ua(:,:,jk) - zue(:,:) * r1_hu_a(:,:) + ua_b(:,:) ) * umask(:,:,jk)
	125	va(:,:,jk) = ( va(:,:,jk) - zve(:,:) * r1_hv_a(:,:) + va_b(:,:) ) * vmask(:,:,jk)
[592]	126	END DO
[6140]	127	!
	128	IF( .NOT.ln_bt_fw ) THEN
[5930]	129	! Remove advective velocity from "now velocities"
	130	! prior to asselin filtering
	131	! In the forward case, this is done below after asselin filtering
	132	! so that asselin contribution is removed at the same time
	133	DO jk = 1, jpkm1
[7753]	134	un(:,:,jk) = ( un(:,:,jk) - un_adv(:,:) + un_b(:,:) )*umask(:,:,jk)
	135	vn(:,:,jk) = ( vn(:,:,jk) - vn_adv(:,:) + vn_b(:,:) )*vmask(:,:,jk)
	136	END DO
[5930]	137	ENDIF
[4292]	138	ENDIF
	139
[1502]	140	! Update after velocity on domain lateral boundaries
	141	! --------------------------------------------------
[5930]	142	# if defined key_agrif
	143	CALL Agrif_dyn( kt ) !* AGRIF zoom boundaries
	144	# endif
	145	!
[1502]	146	CALL lbc_lnk( ua, 'U', -1. ) !* local domain boundaries
	147	CALL lbc_lnk( va, 'V', -1. )
	148	!
	149	! !* BDY open boundaries
[7646]	150	IF( ln_bdy .AND. ln_dynspg_exp ) CALL bdy_dyn( kt )
	151	IF( ln_bdy .AND. ln_dynspg_ts ) CALL bdy_dyn( kt, dyn3d_only=.true. )
[3294]	152
	153	!!$ Do we need a call to bdy_vol here??
	154	!
[4990]	155	IF( l_trddyn ) THEN ! prepare the atf trend computation + some diagnostics
	156	z1_2dt = 1._wp / (2. * rdt) ! Euler or leap-frog time step
	157	IF( neuler == 0 .AND. kt == nit000 ) z1_2dt = 1._wp / rdt
	158	!
	159	! ! Kinetic energy and Conversion
	160	IF( ln_KE_trd ) CALL trd_dyn( ua, va, jpdyn_ken, kt )
	161	!
	162	IF( ln_dyn_trd ) THEN ! 3D output: total momentum trends
[7753]	163	zua(:,:,:) = ( ua(:,:,:) - ub(:,:,:) ) * z1_2dt
	164	zva(:,:,:) = ( va(:,:,:) - vb(:,:,:) ) * z1_2dt
[4990]	165	CALL iom_put( "utrd_tot", zua ) ! total momentum trends, except the asselin time filter
	166	CALL iom_put( "vtrd_tot", zva )
	167	ENDIF
	168	!
[7753]	169	zua(:,:,:) = un(:,:,:) ! save the now velocity before the asselin filter
	170	zva(:,:,:) = vn(:,:,:) ! (caution: there will be a shift by 1 timestep in the
	171	! ! computation of the asselin filter trends)
[4990]	172	ENDIF
	173
[1438]	174	! Time filter and swap of dynamics arrays
	175	! ------------------------------------------
[1502]	176	IF( neuler == 0 .AND. kt == nit000 ) THEN !* Euler at first time-step: only swap
	177	DO jk = 1, jpkm1
[7753]	178	un(:,:,jk) = ua(:,:,jk) ! un <-- ua
	179	vn(:,:,jk) = va(:,:,jk)
[1438]	180	END DO
[6140]	181	IF(.NOT.ln_linssh ) THEN
[4292]	182	DO jk = 1, jpkm1
[7753]	183	e3t_b(:,:,jk) = e3t_n(:,:,jk)
	184	e3u_b(:,:,jk) = e3u_n(:,:,jk)
	185	e3v_b(:,:,jk) = e3v_n(:,:,jk)
[6140]	186	END DO
[4292]	187	ENDIF
[1502]	188	ELSE !* Leap-Frog : Asselin filter and swap
[2528]	189	! ! =============!
[6140]	190	IF( ln_linssh ) THEN ! Fixed volume !
[2528]	191	! ! =============!
[1502]	192	DO jk = 1, jpkm1
[592]	193	DO jj = 1, jpj
[1502]	194	DO ji = 1, jpi
[4990]	195	zuf = un(ji,jj,jk) + atfp * ( ub(ji,jj,jk) - 2._wp * un(ji,jj,jk) + ua(ji,jj,jk) )
	196	zvf = vn(ji,jj,jk) + atfp * ( vb(ji,jj,jk) - 2._wp * vn(ji,jj,jk) + va(ji,jj,jk) )
[1502]	197	!
	198	ub(ji,jj,jk) = zuf ! ub <-- filtered velocity
	199	vb(ji,jj,jk) = zvf
	200	un(ji,jj,jk) = ua(ji,jj,jk) ! un <-- ua
	201	vn(ji,jj,jk) = va(ji,jj,jk)
	202	END DO
	203	END DO
	204	END DO
[2528]	205	! ! ================!
	206	ELSE ! Variable volume !
	207	! ! ================!
[4292]	208	! Before scale factor at t-points
	209	! (used as a now filtered scale factor until the swap)
	210	! ----------------------------------------------------
[8805]	211	DO jk = 1, jpkm1
	212	e3t_b(:,:,jk) = e3t_n(:,:,jk) + atfp * ( e3t_b(:,:,jk) - 2._wp * e3t_n(:,:,jk) + e3t_a(:,:,jk) )
	213	END DO
	214	! Add volume filter correction: compatibility with tracer advection scheme
	215	! => time filter + conservation correction (only at the first level)
	216	zcoef = atfp * rdt * r1_rau0
	217	IF ( .NOT. ln_isf ) THEN ! if no ice shelf melting
	218	e3t_b(:,:,1) = e3t_b(:,:,1) - zcoef * ( emp_b(:,:) - emp(:,:) &
	219	& - rnf_b(:,:) + rnf(:,:) ) * tmask(:,:,1)
	220	ELSE ! if ice shelf melting
	221	DO jj = 1, jpj
	222	DO ji = 1, jpi
	223	ikt = mikt(ji,jj)
	224	e3t_b(ji,jj,ikt) = e3t_b(ji,jj,ikt) - zcoef * ( emp_b (ji,jj) - emp (ji,jj) &
	225	& - rnf_b (ji,jj) + rnf (ji,jj) &
	226	& + fwfisf_b(ji,jj) - fwfisf(ji,jj) ) * tmask(ji,jj,ikt)
	227	END DO
[6140]	228	END DO
[8805]	229	END IF
[2528]	230	!
[6140]	231	IF( ln_dynadv_vec ) THEN ! Asselin filter applied on velocity
	232	! Before filtered scale factor at (u/v)-points
	233	CALL dom_vvl_interpol( e3t_b(:,:,:), e3u_b(:,:,:), 'U' )
	234	CALL dom_vvl_interpol( e3t_b(:,:,:), e3v_b(:,:,:), 'V' )
[4292]	235	DO jk = 1, jpkm1
	236	DO jj = 1, jpj
[2528]	237	DO ji = 1, jpi
[4292]	238	zuf = un(ji,jj,jk) + atfp * ( ub(ji,jj,jk) - 2._wp * un(ji,jj,jk) + ua(ji,jj,jk) )
	239	zvf = vn(ji,jj,jk) + atfp * ( vb(ji,jj,jk) - 2._wp * vn(ji,jj,jk) + va(ji,jj,jk) )
[2528]	240	!
	241	ub(ji,jj,jk) = zuf ! ub <-- filtered velocity
	242	vb(ji,jj,jk) = zvf
	243	un(ji,jj,jk) = ua(ji,jj,jk) ! un <-- ua
	244	vn(ji,jj,jk) = va(ji,jj,jk)
	245	END DO
	246	END DO
	247	END DO
	248	!
[6140]	249	ELSE ! Asselin filter applied on thickness weighted velocity
	250	!
	251	CALL wrk_alloc( jpi,jpj,jpk, ze3u_f, ze3v_f )
	252	! Before filtered scale factor at (u/v)-points stored in ze3u_f, ze3v_f
	253	CALL dom_vvl_interpol( e3t_b(:,:,:), ze3u_f, 'U' )
	254	CALL dom_vvl_interpol( e3t_b(:,:,:), ze3v_f, 'V' )
[4292]	255	DO jk = 1, jpkm1
	256	DO jj = 1, jpj
[4312]	257	DO ji = 1, jpi
[6140]	258	zue3a = e3u_a(ji,jj,jk) * ua(ji,jj,jk)
	259	zve3a = e3v_a(ji,jj,jk) * va(ji,jj,jk)
	260	zue3n = e3u_n(ji,jj,jk) * un(ji,jj,jk)
	261	zve3n = e3v_n(ji,jj,jk) * vn(ji,jj,jk)
	262	zue3b = e3u_b(ji,jj,jk) * ub(ji,jj,jk)
	263	zve3b = e3v_b(ji,jj,jk) * vb(ji,jj,jk)
[2528]	264	!
[3294]	265	zuf = ( zue3n + atfp * ( zue3b - 2._wp * zue3n + zue3a ) ) / ze3u_f(ji,jj,jk)
	266	zvf = ( zve3n + atfp * ( zve3b - 2._wp * zve3n + zve3a ) ) / ze3v_f(ji,jj,jk)
[2528]	267	!
[3294]	268	ub(ji,jj,jk) = zuf ! ub <-- filtered velocity
[2528]	269	vb(ji,jj,jk) = zvf
[3294]	270	un(ji,jj,jk) = ua(ji,jj,jk) ! un <-- ua
[2528]	271	vn(ji,jj,jk) = va(ji,jj,jk)
	272	END DO
	273	END DO
	274	END DO
[7753]	275	e3u_b(:,:,1:jpkm1) = ze3u_f(:,:,1:jpkm1) ! e3u_b <-- filtered scale factor
	276	e3v_b(:,:,1:jpkm1) = ze3v_f(:,:,1:jpkm1)
[6140]	277	!
	278	CALL wrk_dealloc( jpi,jpj,jpk, ze3u_f, ze3v_f )
[2528]	279	ENDIF
	280	!
[3]	281	ENDIF
[2528]	282	!
[6140]	283	IF( ln_dynspg_ts .AND. ln_bt_fw ) THEN
[4312]	284	! Revert "before" velocities to time split estimate
	285	! Doing it here also means that asselin filter contribution is removed
[7753]	286	zue(:,:) = e3u_b(:,:,1) * ub(:,:,1) * umask(:,:,1)
	287	zve(:,:) = e3v_b(:,:,1) * vb(:,:,1) * vmask(:,:,1)
[4990]	288	DO jk = 2, jpkm1
[7753]	289	zue(:,:) = zue(:,:) + e3u_b(:,:,jk) * ub(:,:,jk) * umask(:,:,jk)
	290	zve(:,:) = zve(:,:) + e3v_b(:,:,jk) * vb(:,:,jk) * vmask(:,:,jk)
[4370]	291	END DO
	292	DO jk = 1, jpkm1
[7753]	293	ub(:,:,jk) = ub(:,:,jk) - (zue(:,:) * r1_hu_n(:,:) - un_b(:,:)) * umask(:,:,jk)
	294	vb(:,:,jk) = vb(:,:,jk) - (zve(:,:) * r1_hv_n(:,:) - vn_b(:,:)) * vmask(:,:,jk)
[4292]	295	END DO
	296	ENDIF
	297	!
	298	ENDIF ! neuler =/0
[4354]	299	!
	300	! Set "now" and "before" barotropic velocities for next time step:
	301	! JC: Would be more clever to swap variables than to make a full vertical
	302	! integration
	303	!
[4370]	304	!
[6140]	305	IF(.NOT.ln_linssh ) THEN
[7753]	306	hu_b(:,:) = e3u_b(:,:,1) * umask(:,:,1)
	307	hv_b(:,:) = e3v_b(:,:,1) * vmask(:,:,1)
[6140]	308	DO jk = 2, jpkm1
[7753]	309	hu_b(:,:) = hu_b(:,:) + e3u_b(:,:,jk) * umask(:,:,jk)
	310	hv_b(:,:) = hv_b(:,:) + e3v_b(:,:,jk) * vmask(:,:,jk)
[4354]	311	END DO
[7753]	312	r1_hu_b(:,:) = ssumask(:,:) / ( hu_b(:,:) + 1._wp - ssumask(:,:) )
	313	r1_hv_b(:,:) = ssvmask(:,:) / ( hv_b(:,:) + 1._wp - ssvmask(:,:) )
[4354]	314	ENDIF
	315	!
[7753]	316	un_b(:,:) = e3u_a(:,:,1) * un(:,:,1) * umask(:,:,1)
	317	ub_b(:,:) = e3u_b(:,:,1) * ub(:,:,1) * umask(:,:,1)
	318	vn_b(:,:) = e3v_a(:,:,1) * vn(:,:,1) * vmask(:,:,1)
	319	vb_b(:,:) = e3v_b(:,:,1) * vb(:,:,1) * vmask(:,:,1)
[6140]	320	DO jk = 2, jpkm1
[7753]	321	un_b(:,:) = un_b(:,:) + e3u_a(:,:,jk) * un(:,:,jk) * umask(:,:,jk)
	322	ub_b(:,:) = ub_b(:,:) + e3u_b(:,:,jk) * ub(:,:,jk) * umask(:,:,jk)
	323	vn_b(:,:) = vn_b(:,:) + e3v_a(:,:,jk) * vn(:,:,jk) * vmask(:,:,jk)
	324	vb_b(:,:) = vb_b(:,:) + e3v_b(:,:,jk) * vb(:,:,jk) * vmask(:,:,jk)
[4354]	325	END DO
[7753]	326	un_b(:,:) = un_b(:,:) * r1_hu_a(:,:)
	327	vn_b(:,:) = vn_b(:,:) * r1_hv_a(:,:)
	328	ub_b(:,:) = ub_b(:,:) * r1_hu_b(:,:)
	329	vb_b(:,:) = vb_b(:,:) * r1_hv_b(:,:)
[4354]	330	!
[6140]	331	IF( .NOT.ln_dynspg_ts ) THEN ! output the barotropic currents
	332	CALL iom_put( "ubar", un_b(:,:) )
	333	CALL iom_put( "vbar", vn_b(:,:) )
	334	ENDIF
[4990]	335	IF( l_trddyn ) THEN ! 3D output: asselin filter trends on momentum
[7753]	336	zua(:,:,:) = ( ub(:,:,:) - zua(:,:,:) ) * z1_2dt
	337	zva(:,:,:) = ( vb(:,:,:) - zva(:,:,:) ) * z1_2dt
[4990]	338	CALL trd_dyn( zua, zva, jpdyn_atf, kt )
	339	ENDIF
	340	!
[1438]	341	IF(ln_ctl) CALL prt_ctl( tab3d_1=un, clinfo1=' nxt - Un: ', mask1=umask, &
	342	& tab3d_2=vn, clinfo2=' Vn: ' , mask2=vmask )
[6140]	343	!
	344	IF( ln_dynspg_ts ) CALL wrk_dealloc( jpi,jpj, zue, zve )
	345	IF( l_trddyn ) CALL wrk_dealloc( jpi,jpj,jpk, zua, zva )
[2715]	346	!
[3294]	347	IF( nn_timing == 1 ) CALL timing_stop('dyn_nxt')
	348	!
[3]	349	END SUBROUTINE dyn_nxt
	350
[1502]	351	!!=========================================================================
[3]	352	END MODULE dynnxt

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

Download in other formats: