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.

traadv_mus.F90 in NEMO/trunk/src/OCE/TRA – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/TRA/traadv_mus.F90 @ 13295

Last change on this file since 13295 was 13295, checked in by acc, 4 years ago
Replace do-loop macros in the trunk with alternative forms with greater flexibility for extra halo applications. This alters a lot of routines but does not change any behaviour or results. do_loop_substitute.h90 is greatly simplified by this change. SETTE results are identical to those with the previous revision
Property svn:keywords set to `Id`
File size: 13.6 KB

Rev	Line
[5770]	1	MODULE traadv_mus
[503]	2	!!======================================================================
[5770]	3	!! * MODULE traadv_mus *
[2528]	4	!! Ocean tracers: horizontal & vertical advective trend
[503]	5	!!======================================================================
[2528]	6	!! History : ! 2000-06 (A.Estublier) for passive tracers
	7	!! ! 2001-08 (E.Durand, G.Madec) adapted for T & S
	8	!! NEMO 1.0 ! 2002-06 (G. Madec) F90: Free form and module
	9	!! 3.2 ! 2010-05 (C. Ethe, G. Madec) merge TRC-TRA + switch from velocity to transport
[3680]	10	!! 3.4 ! 2012-06 (P. Oddo, M. Vichi) include the upstream where needed
[5770]	11	!! 3.7 ! 2015-09 (G. Madec) add the ice-shelf cavities boundary condition
[503]	12	!!----------------------------------------------------------------------
[3]	13
	14	!!----------------------------------------------------------------------
[5770]	15	!! tra_adv_mus : update the tracer trend with the horizontal
[3]	16	!! and vertical advection trends using MUSCL scheme
	17	!!----------------------------------------------------------------------
[3625]	18	USE oce ! ocean dynamics and active tracers
[4990]	19	USE trc_oce ! share passive tracers/Ocean variables
[3625]	20	USE dom_oce ! ocean space and time domain
[4990]	21	USE trd_oce ! trends: ocean variables
	22	USE trdtra ! tracers trends manager
[5147]	23	USE sbcrnf ! river runoffs
[3625]	24	USE diaptr ! poleward transport diagnostics
[7646]	25	USE diaar5 ! AR5 diagnostics
	26
[4990]	27	!
[9019]	28	USE iom ! XIOS library
[4990]	29	USE in_out_manager ! I/O manager
	30	USE lib_mpp ! distribued memory computing
	31	USE lbclnk ! ocean lateral boundary condition (or mpp link)
[9124]	32	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[3]	33
	34	IMPLICIT NONE
	35	PRIVATE
	36
[5770]	37	PUBLIC tra_adv_mus ! routine called by traadv.F90
[4990]	38
	39	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: upsmsk !: mixed upstream/centered scheme near some straits
[7646]	40	! ! and in closed seas (orca 2 and 1 configurations)
[4990]	41	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xind !: mixed upstream/centered index
	42
[7646]	43	LOGICAL :: l_trd ! flag to compute trends
	44	LOGICAL :: l_ptr ! flag to compute poleward transport
	45	LOGICAL :: l_hst ! flag to compute heat/salt transport
	46
[3]	47	!! * Substitutions
[12377]	48	# include "do_loop_substitute.h90"
[13237]	49	# include "domzgr_substitute.h90"
[3]	50	!!----------------------------------------------------------------------
[9598]	51	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1152]	52	!! $Id$
[10068]	53	!! Software governed by the CeCILL license (see ./LICENSE)
[3]	54	!!----------------------------------------------------------------------
	55	CONTAINS
	56
[12377]	57	SUBROUTINE tra_adv_mus( kt, kit000, cdtype, p2dt, pU, pV, pW, &
	58	& Kbb, Kmm, pt, kjpt, Krhs, ld_msc_ups )
[3]	59	!!----------------------------------------------------------------------
[5770]	60	!! * ROUTINE tra_adv_mus *
[216]	61	!!
[5770]	62	!! ** Purpose : Compute the now trend due to total advection of tracers
	63	!! using a MUSCL scheme (Monotone Upstream-centered Scheme for
	64	!! Conservation Laws) and add it to the general tracer trend.
[3]	65	!!
[216]	66	!! ** Method : MUSCL scheme plus centered scheme at ocean boundaries
[5770]	67	!! ld_msc_ups=T :
[3]	68	!!
[12377]	69	!! ** Action : - update pt(:,:,:,:,Krhs) with the now advective tracer trends
[6140]	70	!! - send trends to trdtra module for further diagnostcs (l_trdtra=T)
[12377]	71	!! - poleward advective heat and salt transport (ln_diaptr=T)
[3]	72	!!
[503]	73	!! References : Estubier, A., and M. Levy, Notes Techn. Pole de Modelisation
	74	!! IPSL, Sept. 2000 (http://www.lodyc.jussieu.fr/opa)
	75	!!----------------------------------------------------------------------
[12377]	76	INTEGER , INTENT(in ) :: kt ! ocean time-step index
	77	INTEGER , INTENT(in ) :: Kbb, Kmm, Krhs ! ocean time level indices
	78	INTEGER , INTENT(in ) :: kit000 ! first time step index
	79	CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator)
	80	INTEGER , INTENT(in ) :: kjpt ! number of tracers
	81	LOGICAL , INTENT(in ) :: ld_msc_ups ! use upstream scheme within muscl
	82	REAL(wp) , INTENT(in ) :: p2dt ! tracer time-step
	83	REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pU, pV, pW ! 3 ocean volume flux components
	84	REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt,jpt), INTENT(inout) :: pt ! tracers and RHS of tracer equation
[2715]	85	!
[9019]	86	INTEGER :: ji, jj, jk, jn ! dummy loop indices
	87	INTEGER :: ierr ! local integer
	88	REAL(wp) :: zu, z0u, zzwx, zw , zalpha ! local scalars
	89	REAL(wp) :: zv, z0v, zzwy, z0w ! - -
	90	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zwx, zslpx ! 3D workspace
	91	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zwy, zslpy ! - -
[3]	92	!!----------------------------------------------------------------------
[3294]	93	!
	94	IF( kt == kit000 ) THEN
[2528]	95	IF(lwp) WRITE(numout,*)
	96	IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype
[3718]	97	IF(lwp) WRITE(numout,*) ' : mixed up-stream ', ld_msc_ups
[2528]	98	IF(lwp) WRITE(numout,*) '~~~~~~~'
[3680]	99	IF(lwp) WRITE(numout,*)
[2528]	100	!
[5770]	101	! Upstream / MUSCL scheme indicator
[3680]	102	!
[5770]	103	ALLOCATE( xind(jpi,jpj,jpk), STAT=ierr )
[7753]	104	xind(:,:,:) = 1._wp ! set equal to 1 where up-stream is not needed
[5770]	105	!
	106	IF( ld_msc_ups ) THEN ! define the upstream indicator (if asked)
	107	ALLOCATE( upsmsk(jpi,jpj), STAT=ierr )
[7753]	108	upsmsk(:,:) = 0._wp ! not upstream by default
[5770]	109	!
[4990]	110	DO jk = 1, jpkm1
[7753]	111	xind(:,:,jk) = 1._wp & ! =>1 where up-stream is not needed
	112	& - MAX ( rnfmsk(:,:) * rnfmsk_z(jk), & ! =>0 near runoff mouths (& closed sea outflows)
	113	& upsmsk(:,:) ) * tmask(:,:,jk) ! =>0 in some user defined area
[3718]	114	END DO
[3680]	115	ENDIF
[3718]	116	!
	117	ENDIF
[4990]	118	!
[7646]	119	l_trd = .FALSE.
	120	l_hst = .FALSE.
	121	l_ptr = .FALSE.
	122	IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
[12377]	123	IF( cdtype == 'TRA' .AND. ( iom_use( 'sophtadv' ) .OR. iom_use( 'sophtadv' ) ) ) l_ptr = .TRUE.
[7646]	124	IF( cdtype == 'TRA' .AND. ( iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") .OR. &
	125	& iom_use("uadv_salttr") .OR. iom_use("vadv_salttr") ) ) l_hst = .TRUE.
	126	!
[6140]	127	DO jn = 1, kjpt !== loop over the tracers ==!
	128	!
	129	! !* Horizontal advective fluxes
	130	!
	131	! !-- first guess of the slopes
[7753]	132	zwx(:,:,jpk) = 0._wp ! bottom values
	133	zwy(:,:,jpk) = 0._wp
[13295]	134	DO_3D( 1, 0, 1, 0, 1, jpkm1 )
[12377]	135	zwx(ji,jj,jk) = umask(ji,jj,jk) * ( pt(ji+1,jj,jk,jn,Kbb) - pt(ji,jj,jk,jn,Kbb) )
	136	zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( pt(ji,jj+1,jk,jn,Kbb) - pt(ji,jj,jk,jn,Kbb) )
	137	END_3D
[9094]	138	! lateral boundary conditions (changed sign)
[13226]	139	CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1.0_wp , zwy, 'V', -1.0_wp )
[6140]	140	! !-- Slopes of tracer
[7753]	141	zslpx(:,:,jpk) = 0._wp ! bottom values
	142	zslpy(:,:,jpk) = 0._wp
[13295]	143	DO_3D( 0, 1, 0, 1, 1, jpkm1 )
[13226]	144	zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji-1,jj ,jk) ) &
	145	& * ( 0.25 + SIGN( 0.25_wp, zwx(ji,jj,jk) * zwx(ji-1,jj ,jk) ) )
	146	zslpy(ji,jj,jk) = ( zwy(ji,jj,jk) + zwy(ji ,jj-1,jk) ) &
	147	& * ( 0.25 + SIGN( 0.25_wp, zwy(ji,jj,jk) * zwy(ji ,jj-1,jk) ) )
[12377]	148	END_3D
[503]	149	!
[13295]	150	DO_3D( 0, 1, 0, 1, 1, jpkm1 )
[13226]	151	zslpx(ji,jj,jk) = SIGN( 1.0_wp, zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji ,jj,jk) ), &
	152	& 2.*ABS( zwx (ji-1,jj,jk) ), &
	153	& 2.*ABS( zwx (ji ,jj,jk) ) )
	154	zslpy(ji,jj,jk) = SIGN( 1.0_wp, zslpy(ji,jj,jk) ) * MIN( ABS( zslpy(ji,jj ,jk) ), &
	155	& 2.*ABS( zwy (ji,jj-1,jk) ), &
	156	& 2.*ABS( zwy (ji,jj ,jk) ) )
[12377]	157	END_3D
[5770]	158	!
[13295]	159	DO_3D( 0, 0, 0, 0, 1, jpkm1 )
[12377]	160	! MUSCL fluxes
[13226]	161	z0u = SIGN( 0.5_wp, pU(ji,jj,jk) )
[12377]	162	zalpha = 0.5 - z0u
	163	zu = z0u - 0.5 * pU(ji,jj,jk) * p2dt * r1_e1e2u(ji,jj) / e3u(ji,jj,jk,Kmm)
	164	zzwx = pt(ji+1,jj,jk,jn,Kbb) + xind(ji,jj,jk) * zu * zslpx(ji+1,jj,jk)
	165	zzwy = pt(ji ,jj,jk,jn,Kbb) + xind(ji,jj,jk) * zu * zslpx(ji ,jj,jk)
	166	zwx(ji,jj,jk) = pU(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
	167	!
[13226]	168	z0v = SIGN( 0.5_wp, pV(ji,jj,jk) )
[12377]	169	zalpha = 0.5 - z0v
	170	zv = z0v - 0.5 * pV(ji,jj,jk) * p2dt * r1_e1e2v(ji,jj) / e3v(ji,jj,jk,Kmm)
	171	zzwx = pt(ji,jj+1,jk,jn,Kbb) + xind(ji,jj,jk) * zv * zslpy(ji,jj+1,jk)
	172	zzwy = pt(ji,jj ,jk,jn,Kbb) + xind(ji,jj,jk) * zv * zslpy(ji,jj ,jk)
	173	zwy(ji,jj,jk) = pV(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
	174	END_3D
[13226]	175	CALL lbc_lnk_multi( 'traadv_mus', zwx, 'U', -1.0_wp , zwy, 'V', -1.0_wp ) ! lateral boundary conditions (changed sign)
[503]	176	!
[13295]	177	DO_3D( 0, 0, 0, 0, 1, jpkm1 )
[12377]	178	pt(ji,jj,jk,jn,Krhs) = pt(ji,jj,jk,jn,Krhs) - ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) &
	179	& + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) ) &
	180	& * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm)
	181	END_3D
[6140]	182	! ! trend diagnostics
[7646]	183	IF( l_trd ) THEN
[12377]	184	CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_xad, zwx, pU, pt(:,:,:,jn,Kbb) )
	185	CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_yad, zwy, pV, pt(:,:,:,jn,Kbb) )
[2528]	186	END IF
[7646]	187	! ! "Poleward" heat and salt transports
	188	IF( l_ptr ) CALL dia_ptr_hst( jn, 'adv', zwy(:,:,:) )
	189	! ! heat transport
	190	IF( l_hst ) CALL dia_ar5_hst( jn, 'adv', zwx(:,:,:), zwy(:,:,:) )
[6140]	191	!
	192	! !* Vertical advective fluxes
	193	!
[5770]	194	! !-- first guess of the slopes
[7753]	195	zwx(:,:, 1 ) = 0._wp ! surface & bottom boundary conditions
	196	zwx(:,:,jpk) = 0._wp
[6140]	197	DO jk = 2, jpkm1 ! interior values
[12377]	198	zwx(:,:,jk) = tmask(:,:,jk) * ( pt(:,:,jk-1,jn,Kbb) - pt(:,:,jk,jn,Kbb) )
[3]	199	END DO
[5770]	200	! !-- Slopes of tracer
[7753]	201	zslpx(:,:,1) = 0._wp ! surface values
[13295]	202	DO_3D( 1, 1, 1, 1, 2, jpkm1 )
[13226]	203	zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) ) &
	204	& * ( 0.25 + SIGN( 0.25_wp, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) )
[12377]	205	END_3D
[13295]	206	DO_3D( 1, 1, 1, 1, 2, jpkm1 )
[13226]	207	zslpx(ji,jj,jk) = SIGN( 1.0_wp, zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji,jj,jk ) ), &
	208	& 2.*ABS( zwx (ji,jj,jk+1) ), &
	209	& 2.*ABS( zwx (ji,jj,jk ) ) )
[12377]	210	END_3D
[13295]	211	DO_3D( 0, 0, 0, 0, 1, jpk-2 )
[13226]	212	z0w = SIGN( 0.5_wp, pW(ji,jj,jk+1) )
[12377]	213	zalpha = 0.5 + z0w
	214	zw = z0w - 0.5 * pW(ji,jj,jk+1) * p2dt * r1_e1e2t(ji,jj) / e3w(ji,jj,jk+1,Kmm)
	215	zzwx = pt(ji,jj,jk+1,jn,Kbb) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk+1)
	216	zzwy = pt(ji,jj,jk ,jn,Kbb) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk )
	217	zwx(ji,jj,jk+1) = pW(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) * wmask(ji,jj,jk)
	218	END_3D
[6140]	219	IF( ln_linssh ) THEN ! top values, linear free surface only
	220	IF( ln_isfcav ) THEN ! ice-shelf cavities (top of the ocean)
[13295]	221	DO_2D( 1, 1, 1, 1 )
[12377]	222	zwx(ji,jj, mikt(ji,jj) ) = pW(ji,jj,mikt(ji,jj)) * pt(ji,jj,mikt(ji,jj),jn,Kbb)
	223	END_2D
[6140]	224	ELSE ! no cavities: only at the ocean surface
[12377]	225	zwx(:,:,1) = pW(:,:,1) * pt(:,:,1,jn,Kbb)
[5770]	226	ENDIF
	227	ENDIF
	228	!
[13295]	229	DO_3D( 0, 0, 0, 0, 1, jpkm1 )
[13237]	230	pt(ji,jj,jk,jn,Krhs) = pt(ji,jj,jk,jn,Krhs) - ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) ) &
	231	& * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm)
[12377]	232	END_3D
[6140]	233	! ! send trends for diagnostic
[12377]	234	IF( l_trd ) CALL trd_tra( kt, Kmm, Krhs, cdtype, jn, jptra_zad, zwx, pW, pt(:,:,:,jn,Kbb) )
[503]	235	!
[6140]	236	END DO ! end of tracer loop
[503]	237	!
[5770]	238	END SUBROUTINE tra_adv_mus
[3]	239
	240	!!======================================================================
[5770]	241	END MODULE traadv_mus

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

Download in other formats: