Context Navigation

traadv_tvd.F90 @ 2696

Last change on this file since 2696 was 2690, checked in by gm, 13 years ago
dynamic mem: #785 ; homogeneization of the coding style associated with dyn allocation
Property svn:keywords set to `Id`
File size: 18.0 KB

Rev	Line
[3]	1	MODULE traadv_tvd
	2	!!==============================================================================
	3	!! * MODULE traadv_tvd *
[2528]	4	!! Ocean tracers: horizontal & vertical advective trend
[3]	5	!!==============================================================================
[2528]	6	!! History : OPA ! 1995-12 (L. Mortier) Original code
	7	!! ! 2000-01 (H. Loukos) adapted to ORCA
	8	!! ! 2000-10 (MA Foujols E.Kestenare) include file not routine
	9	!! ! 2000-12 (E. Kestenare M. Levy) fix bug in trtrd indexes
	10	!! ! 2001-07 (E. Durand G. Madec) adaptation to ORCA config
	11	!! 8.5 ! 2002-06 (G. Madec) F90: Free form and module
	12	!! NEMO 1.0 ! 2004-01 (A. de Miranda, G. Madec, J.M. Molines ): advective bbl
	13	!! 2.0 ! 2008-04 (S. Cravatte) add the i-, j- & k- trends computation
	14	!! - ! 2009-11 (V. Garnier) Surface pressure gradient organization
	15	!! 3.3 ! 2010-05 (C. Ethe, G. Madec) merge TRC-TRA + switch from velocity to transport
[503]	16	!!----------------------------------------------------------------------
[3]	17
	18	!!----------------------------------------------------------------------
	19	!! tra_adv_tvd : update the tracer trend with the horizontal
	20	!! and vertical advection trends using a TVD scheme
	21	!! nonosc : compute monotonic tracer fluxes by a nonoscillatory
	22	!! algorithm
	23	!!----------------------------------------------------------------------
	24	USE oce ! ocean dynamics and active tracers
	25	USE dom_oce ! ocean space and time domain
[2528]	26	USE trdmod_oce ! tracers trends
[2690]	27	USE trdtra ! tracers trends
[3]	28	USE in_out_manager ! I/O manager
[367]	29	USE dynspg_oce ! choice/control of key cpp for surface pressure gradient
[2690]	30	USE lib_mpp ! MPP library
[74]	31	USE lbclnk ! ocean lateral boundary condition (or mpp link)
[132]	32	USE diaptr ! poleward transport diagnostics
[2528]	33	USE trc_oce ! share passive tracers/Ocean variables
[3]	34
[74]	35
[3]	36	IMPLICIT NONE
	37	PRIVATE
	38
[503]	39	PUBLIC tra_adv_tvd ! routine called by step.F90
[3]	40
[2690]	41	LOGICAL :: l_trd ! flag to compute trends
[2528]	42
[3]	43	!! * Substitutions
	44	# include "domzgr_substitute.h90"
	45	# include "vectopt_loop_substitute.h90"
	46	!!----------------------------------------------------------------------
[2528]	47	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[1152]	48	!! $Id$
[2528]	49	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	50	!!----------------------------------------------------------------------
	51	CONTAINS
	52
[2528]	53	SUBROUTINE tra_adv_tvd ( kt, cdtype, p2dt, pun, pvn, pwn, &
	54	& ptb, ptn, pta, kjpt )
[3]	55	!!----------------------------------------------------------------------
	56	!! * ROUTINE tra_adv_tvd *
	57	!!
	58	!! ** Purpose : Compute the now trend due to total advection of
	59	!! tracers and add it to the general trend of tracer equations
	60	!!
	61	!! ** Method : TVD scheme, i.e. 2nd order centered scheme with
	62	!! corrected flux (monotonic correction)
	63	!! note: - this advection scheme needs a leap-frog time scheme
	64	!!
[2528]	65	!! ** Action : - update (pta) with the now advective tracer trends
	66	!! - save the trends
[503]	67	!!----------------------------------------------------------------------
[2690]	68	USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released
	69	USE oce , ONLY: zwx => ua , zwy => va ! (ua,va) used as workspace
	70	USE wrk_nemo, ONLY: zwi => wrk_3d_12 , zwz => wrk_3d_13 ! 3D workspace
	71	!
[2528]	72	INTEGER , INTENT(in ) :: kt ! ocean time-step index
	73	CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator)
	74	INTEGER , INTENT(in ) :: kjpt ! number of tracers
	75	REAL(wp), DIMENSION( jpk ), INTENT(in ) :: p2dt ! vertical profile of tracer time-step
	76	REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pun, pvn, pwn ! 3 ocean velocity components
	77	REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in ) :: ptb, ptn ! before and now tracer fields
	78	REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) :: pta ! tracer trend
[2690]	79	!
[2528]	80	INTEGER :: ji, jj, jk, jn ! dummy loop indices
	81	REAL(wp) :: z2dtt, zbtr, ztra ! local scalar
	82	REAL(wp) :: zfp_ui, zfp_vj, zfp_wk ! - -
	83	REAL(wp) :: zfm_ui, zfm_vj, zfm_wk ! - -
	84	REAL(wp), DIMENSION (:,:,:), ALLOCATABLE :: ztrdx, ztrdy, ztrdz
[3]	85	!!----------------------------------------------------------------------
	86
[2690]	87	IF( wrk_in_use(3, 12,13) ) THEN
	88	CALL ctl_stop('tra_adv_tvd: requested workspace arrays unavailable') ; RETURN
	89	ENDIF
[2590]	90
[2528]	91	IF( kt == nit000 ) THEN
	92	IF(lwp) WRITE(numout,*)
	93	IF(lwp) WRITE(numout,*) 'tra_adv_tvd : TVD advection scheme on ', cdtype
	94	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~'
	95	!
	96	l_trd = .FALSE.
	97	IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
[3]	98	ENDIF
[2528]	99	!
	100	IF( l_trd ) THEN
	101	ALLOCATE( ztrdx(jpi,jpj,jpk) ) ; ztrdx(:,:,:) = 0.e0
	102	ALLOCATE( ztrdy(jpi,jpj,jpk) ) ; ztrdy(:,:,:) = 0.e0
	103	ALLOCATE( ztrdz(jpi,jpj,jpk) ) ; ztrdz(:,:,:) = 0.e0
	104	END IF
	105	!
	106	zwi(:,:,:) = 0.e0
	107	!
	108	! ! ===========
	109	DO jn = 1, kjpt ! tracer loop
	110	! ! ===========
	111	! 1. Bottom value : flux set to zero
	112	! ----------------------------------
	113	zwx(:,:,jpk) = 0.e0 ; zwz(:,:,jpk) = 0.e0
	114	zwy(:,:,jpk) = 0.e0 ; zwi(:,:,jpk) = 0.e0
[3]	115
[2528]	116	! 2. upstream advection with initial mass fluxes & intermediate update
	117	! --------------------------------------------------------------------
	118	! upstream tracer flux in the i and j direction
	119	DO jk = 1, jpkm1
	120	DO jj = 1, jpjm1
	121	DO ji = 1, fs_jpim1 ! vector opt.
	122	! upstream scheme
	123	zfp_ui = pun(ji,jj,jk) + ABS( pun(ji,jj,jk) )
	124	zfm_ui = pun(ji,jj,jk) - ABS( pun(ji,jj,jk) )
	125	zfp_vj = pvn(ji,jj,jk) + ABS( pvn(ji,jj,jk) )
	126	zfm_vj = pvn(ji,jj,jk) - ABS( pvn(ji,jj,jk) )
	127	zwx(ji,jj,jk) = 0.5 * ( zfp_ui * ptb(ji,jj,jk,jn) + zfm_ui * ptb(ji+1,jj ,jk,jn) )
	128	zwy(ji,jj,jk) = 0.5 * ( zfp_vj * ptb(ji,jj,jk,jn) + zfm_vj * ptb(ji ,jj+1,jk,jn) )
	129	END DO
[3]	130	END DO
	131	END DO
	132
[2528]	133	! upstream tracer flux in the k direction
	134	! Surface value
	135	IF( lk_vvl ) THEN ; zwz(:,:, 1 ) = 0.e0 ! volume variable
	136	ELSE ; zwz(:,:, 1 ) = pwn(:,:,1) * ptb(:,:,1,jn) ! linear free surface
	137	ENDIF
	138	! Interior value
	139	DO jk = 2, jpkm1
	140	DO jj = 1, jpj
	141	DO ji = 1, jpi
	142	zfp_wk = pwn(ji,jj,jk) + ABS( pwn(ji,jj,jk) )
	143	zfm_wk = pwn(ji,jj,jk) - ABS( pwn(ji,jj,jk) )
	144	zwz(ji,jj,jk) = 0.5 * ( zfp_wk * ptb(ji,jj,jk,jn) + zfm_wk * ptb(ji,jj,jk-1,jn) )
	145	END DO
[3]	146	END DO
	147	END DO
	148
[2528]	149	! total advective trend
[216]	150	DO jk = 1, jpkm1
[2528]	151	z2dtt = p2dt(jk)
[216]	152	DO jj = 2, jpjm1
	153	DO ji = fs_2, fs_jpim1 ! vector opt.
[503]	154	zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
[2528]	155	! total intermediate advective trends
	156	ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) &
	157	& + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) &
	158	& + zwz(ji,jj,jk) - zwz(ji ,jj ,jk+1) )
	159	! update and guess with monotonic sheme
	160	pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra
	161	zwi(ji,jj,jk) = ( ptb(ji,jj,jk,jn) + z2dtt * ztra ) * tmask(ji,jj,jk)
[216]	162	END DO
	163	END DO
	164	END DO
[2528]	165	! ! Lateral boundary conditions on zwi (unchanged sign)
	166	CALL lbc_lnk( zwi, 'T', 1. )
	167
	168	! ! trend diagnostics (contribution of upstream fluxes)
	169	IF( l_trd ) THEN
	170	! store intermediate advective trends
	171	ztrdx(:,:,:) = zwx(:,:,:) ; ztrdy(:,:,:) = zwy(:,:,:) ; ztrdz(:,:,:) = zwz(:,:,:)
	172	END IF
	173	! ! "Poleward" heat and salt transports (contribution of upstream fluxes)
	174	IF( cdtype == 'TRA' .AND. ln_diaptr .AND. ( MOD( kt, nn_fptr ) == 0 ) ) THEN
	175	IF( jn == jp_tem ) htr_adv(:) = ptr_vj( zwy(:,:,:) )
	176	IF( jn == jp_sal ) str_adv(:) = ptr_vj( zwy(:,:,:) )
	177	ENDIF
	178
	179	! 3. antidiffusive flux : high order minus low order
	180	! --------------------------------------------------
	181	! antidiffusive flux on i and j
[503]	182	DO jk = 1, jpkm1
[2528]	183	DO jj = 1, jpjm1
	184	DO ji = 1, fs_jpim1 ! vector opt.
	185	zwx(ji,jj,jk) = 0.5 * pun(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji+1,jj,jk,jn) ) - zwx(ji,jj,jk)
	186	zwy(ji,jj,jk) = 0.5 * pvn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj+1,jk,jn) ) - zwy(ji,jj,jk)
[503]	187	END DO
	188	END DO
	189	END DO
[2528]	190
	191	! antidiffusive flux on k
	192	zwz(:,:,1) = 0.e0 ! Surface value
[503]	193	!
[2528]	194	DO jk = 2, jpkm1 ! Interior value
	195	DO jj = 1, jpj
	196	DO ji = 1, jpi
	197	zwz(ji,jj,jk) = 0.5 * pwn(ji,jj,jk) * ( ptn(ji,jj,jk,jn) + ptn(ji,jj,jk-1,jn) ) - zwz(ji,jj,jk)
[503]	198	END DO
	199	END DO
	200	END DO
[2528]	201	CALL lbc_lnk( zwx, 'U', -1. ) ; CALL lbc_lnk( zwy, 'V', -1. ) ! Lateral bondary conditions
	202	CALL lbc_lnk( zwz, 'W', 1. )
[216]	203
[2528]	204	! 4. monotonicity algorithm
	205	! -------------------------
	206	CALL nonosc( ptb(:,:,:,jn), zwx, zwy, zwz, zwi, p2dt )
[3]	207
	208
[2528]	209	! 5. final trend with corrected fluxes
	210	! ------------------------------------
[216]	211	DO jk = 1, jpkm1
	212	DO jj = 2, jpjm1
[2528]	213	DO ji = fs_2, fs_jpim1 ! vector opt.
[503]	214	zbtr = 1. / ( e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) )
[2528]	215	! total advective trends
	216	ztra = - zbtr * ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) &
	217	& + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) &
	218	& + zwz(ji,jj,jk) - zwz(ji ,jj ,jk+1) )
	219	! add them to the general tracer trends
	220	pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) + ztra
[216]	221	END DO
	222	END DO
	223	END DO
[2528]	224
	225	! ! trend diagnostics (contribution of upstream fluxes)
	226	IF( l_trd ) THEN
	227	ztrdx(:,:,:) = ztrdx(:,:,:) + zwx(:,:,:) ! <<< Add to previously computed
	228	ztrdy(:,:,:) = ztrdy(:,:,:) + zwy(:,:,:) ! <<< Add to previously computed
	229	ztrdz(:,:,:) = ztrdz(:,:,:) + zwz(:,:,:) ! <<< Add to previously computed
	230
	231	CALL trd_tra( kt, cdtype, jn, jptra_trd_xad, ztrdx, pun, ptn(:,:,:,jn) )
	232	CALL trd_tra( kt, cdtype, jn, jptra_trd_yad, ztrdy, pvn, ptn(:,:,:,jn) )
	233	CALL trd_tra( kt, cdtype, jn, jptra_trd_zad, ztrdz, pwn, ptn(:,:,:,jn) )
	234	END IF
	235	! ! "Poleward" heat and salt transports (contribution of upstream fluxes)
	236	IF( cdtype == 'TRA' .AND. ln_diaptr .AND. ( MOD( kt, nn_fptr ) == 0 ) ) THEN
	237	IF( jn == jp_tem ) htr_adv(:) = ptr_vj( zwy(:,:,:) ) + htr_adv(:)
	238	IF( jn == jp_sal ) str_adv(:) = ptr_vj( zwy(:,:,:) ) + str_adv(:)
	239	ENDIF
[503]	240	!
[2690]	241	END DO
[503]	242	!
[2528]	243	IF( l_trd ) THEN
	244	DEALLOCATE( ztrdx ) ; DEALLOCATE( ztrdy ) ; DEALLOCATE( ztrdz )
	245	END IF
	246	!
[2690]	247	IF( wrk_not_released(3, 12,13) ) CALL ctl_stop('tra_adv_tvd: failed to release workspace arrays')
[2590]	248	!
[3]	249	END SUBROUTINE tra_adv_tvd
	250
	251
[2528]	252	SUBROUTINE nonosc( pbef, paa, pbb, pcc, paft, p2dt )
[3]	253	!!---------------------------------------------------------------------
	254	!! * ROUTINE nonosc *
	255	!!
	256	!! ** Purpose : compute monotonic tracer fluxes from the upstream
	257	!! scheme and the before field by a nonoscillatory algorithm
	258	!!
	259	!! ** Method : ... ???
	260	!! warning : pbef and paft must be masked, but the boundaries
	261	!! conditions on the fluxes are not necessary zalezak (1979)
	262	!! drange (1995) multi-dimensional forward-in-time and upstream-
	263	!! in-space based differencing for fluid
	264	!!----------------------------------------------------------------------
[2690]	265	USE wrk_nemo, ONLY: wrk_in_use, wrk_not_released
	266	USE wrk_nemo, ONLY: zbetup => wrk_3d_8 , zbetdo => wrk_3d_9 ! 3D workspace
	267	USE wrk_nemo, ONLY: zbup => wrk_3d_10 , zbdo => wrk_3d_11 ! - -
	268	!
[2528]	269	REAL(wp), DIMENSION(jpk) , INTENT(in ) :: p2dt ! vertical profile of tracer time-step
	270	REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(in ) :: pbef, paft ! before & after field
	271	REAL(wp), DIMENSION (jpi,jpj,jpk), INTENT(inout) :: paa, pbb, pcc ! monotonic fluxes in the 3 directions
[2690]	272	!
	273	INTEGER :: ji, jj, jk ! dummy loop indices
	274	INTEGER :: ikm1 ! local integer
	275	REAL(wp) :: zpos, zneg, zbt, za, zb, zc, zbig, zrtrn, z2dtt ! local scalars
	276	REAL(wp) :: zau, zbu, zcu, zav, zbv, zcv, zup, zdo ! - -
[3]	277	!!----------------------------------------------------------------------
	278
[2690]	279	IF( wrk_in_use(3, 8,9,10,11) ) THEN
	280	CALL ctl_stop('nonosc: requested workspace array unavailable') ; RETURN
	281	ENDIF
[2590]	282
[2690]	283	zbig = 1.e+40_wp
	284	zrtrn = 1.e-15_wp
	285	zbetup(:,:,jpk) = 0._wp ; zbetdo(:,:,jpk) = 0._wp
[3]	286
[785]	287
[3]	288	! Search local extrema
	289	! --------------------
[785]	290	! max/min of pbef & paft with large negative/positive value (-/+zbig) inside land
	291	zbup = MAX( pbef * tmask - zbig * ( 1.e0 - tmask ), &
	292	& paft * tmask - zbig * ( 1.e0 - tmask ) )
	293	zbdo = MIN( pbef * tmask + zbig * ( 1.e0 - tmask ), &
	294	& paft * tmask + zbig * ( 1.e0 - tmask ) )
	295
[3]	296	DO jk = 1, jpkm1
	297	ikm1 = MAX(jk-1,1)
[2528]	298	z2dtt = p2dt(jk)
[3]	299	DO jj = 2, jpjm1
	300	DO ji = fs_2, fs_jpim1 ! vector opt.
	301
[785]	302	! search maximum in neighbourhood
	303	zup = MAX( zbup(ji ,jj ,jk ), &
	304	& zbup(ji-1,jj ,jk ), zbup(ji+1,jj ,jk ), &
	305	& zbup(ji ,jj-1,jk ), zbup(ji ,jj+1,jk ), &
	306	& zbup(ji ,jj ,ikm1), zbup(ji ,jj ,jk+1) )
[3]	307
[785]	308	! search minimum in neighbourhood
	309	zdo = MIN( zbdo(ji ,jj ,jk ), &
	310	& zbdo(ji-1,jj ,jk ), zbdo(ji+1,jj ,jk ), &
	311	& zbdo(ji ,jj-1,jk ), zbdo(ji ,jj+1,jk ), &
	312	& zbdo(ji ,jj ,ikm1), zbdo(ji ,jj ,jk+1) )
[3]	313
[785]	314	! positive part of the flux
[3]	315	zpos = MAX( 0., paa(ji-1,jj ,jk ) ) - MIN( 0., paa(ji ,jj ,jk ) ) &
	316	& + MAX( 0., pbb(ji ,jj-1,jk ) ) - MIN( 0., pbb(ji ,jj ,jk ) ) &
	317	& + MAX( 0., pcc(ji ,jj ,jk+1) ) - MIN( 0., pcc(ji ,jj ,jk ) )
[785]	318
	319	! negative part of the flux
[3]	320	zneg = MAX( 0., paa(ji ,jj ,jk ) ) - MIN( 0., paa(ji-1,jj ,jk ) ) &
	321	& + MAX( 0., pbb(ji ,jj ,jk ) ) - MIN( 0., pbb(ji ,jj-1,jk ) ) &
	322	& + MAX( 0., pcc(ji ,jj ,jk ) ) - MIN( 0., pcc(ji ,jj ,jk+1) )
[785]	323
[3]	324	! up & down beta terms
	325	zbt = e1t(ji,jj) * e2t(ji,jj) * fse3t(ji,jj,jk) / z2dtt
[785]	326	zbetup(ji,jj,jk) = ( zup - paft(ji,jj,jk) ) / ( zpos + zrtrn ) * zbt
	327	zbetdo(ji,jj,jk) = ( paft(ji,jj,jk) - zdo ) / ( zneg + zrtrn ) * zbt
[3]	328	END DO
	329	END DO
	330	END DO
[2528]	331	CALL lbc_lnk( zbetup, 'T', 1. ) ; CALL lbc_lnk( zbetdo, 'T', 1. ) ! lateral boundary cond. (unchanged sign)
[3]	332
	333
	334
[237]	335	! 3. monotonic flux in the i & j direction (paa & pbb)
	336	! ----------------------------------------
[3]	337	DO jk = 1, jpkm1
	338	DO jj = 2, jpjm1
	339	DO ji = fs_2, fs_jpim1 ! vector opt.
[785]	340	zau = MIN( 1.e0, zbetdo(ji,jj,jk), zbetup(ji+1,jj,jk) )
	341	zbu = MIN( 1.e0, zbetup(ji,jj,jk), zbetdo(ji+1,jj,jk) )
	342	zcu = ( 0.5 + SIGN( 0.5 , paa(ji,jj,jk) ) )
	343	paa(ji,jj,jk) = paa(ji,jj,jk) * ( zcu * zau + ( 1.e0 - zcu) * zbu )
[3]	344
[785]	345	zav = MIN( 1.e0, zbetdo(ji,jj,jk), zbetup(ji,jj+1,jk) )
	346	zbv = MIN( 1.e0, zbetup(ji,jj,jk), zbetdo(ji,jj+1,jk) )
	347	zcv = ( 0.5 + SIGN( 0.5 , pbb(ji,jj,jk) ) )
	348	pbb(ji,jj,jk) = pbb(ji,jj,jk) * ( zcv * zav + ( 1.e0 - zcv) * zbv )
[3]	349
	350	! monotonic flux in the k direction, i.e. pcc
	351	! -------------------------------------------
[785]	352	za = MIN( 1., zbetdo(ji,jj,jk+1), zbetup(ji,jj,jk) )
	353	zb = MIN( 1., zbetup(ji,jj,jk+1), zbetdo(ji,jj,jk) )
	354	zc = ( 0.5 + SIGN( 0.5 , pcc(ji,jj,jk+1) ) )
	355	pcc(ji,jj,jk+1) = pcc(ji,jj,jk+1) * ( zc * za + ( 1.e0 - zc) * zb )
[3]	356	END DO
	357	END DO
	358	END DO
[2528]	359	CALL lbc_lnk( paa, 'U', -1. ) ; CALL lbc_lnk( pbb, 'V', -1. ) ! lateral boundary condition (changed sign)
[503]	360	!
[2690]	361	IF( wrk_not_released(3, 8,9,10,11) ) CALL ctl_stop('nonosc: failed to release workspace arrays')
[2590]	362	!
[3]	363	END SUBROUTINE nonosc
	364
	365	!!======================================================================
	366	END MODULE traadv_tvd

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

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OPA_SRC/TRA/traadv_tvd.F90 @ 2696

Download in other formats: