Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Normal
Revision Log

traadv_mus.F90 @ 8568

Last change on this file since 8568 was 8568, checked in by gm, 7 years ago
#1911 (ENHANCE-09): PART I.2 - _NONE option + remove zts + see associated wiki page
Property svn:keywords set to `Id`
File size: 15.2 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	!
[8568]	28	USE iom ! XIOS library
[3625]	29	USE timing ! Timing
	30	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[4990]	31	USE in_out_manager ! I/O manager
	32	USE lib_mpp ! distribued memory computing
	33	USE lbclnk ! ocean lateral boundary condition (or mpp link)
[3]	34
	35	IMPLICIT NONE
	36	PRIVATE
	37
[5770]	38	PUBLIC tra_adv_mus ! routine called by traadv.F90
[4990]	39
	40	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: upsmsk !: mixed upstream/centered scheme near some straits
[7646]	41	! ! and in closed seas (orca 2 and 1 configurations)
[4990]	42	REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: xind !: mixed upstream/centered index
	43
[7646]	44	LOGICAL :: l_trd ! flag to compute trends
	45	LOGICAL :: l_ptr ! flag to compute poleward transport
	46	LOGICAL :: l_hst ! flag to compute heat/salt transport
	47
[3]	48	!! * Substitutions
	49	# include "vectopt_loop_substitute.h90"
	50	!!----------------------------------------------------------------------
[2528]	51	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[1152]	52	!! $Id$
[2528]	53	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	54	!!----------------------------------------------------------------------
	55	CONTAINS
	56
[5770]	57	SUBROUTINE tra_adv_mus( kt, kit000, cdtype, p2dt, pun, pvn, pwn, &
	58	& ptb, pta, kjpt, 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	!!
[6140]	69	!! ** Action : - update pta with the now advective tracer trends
	70	!! - send trends to trdtra module for further diagnostcs (l_trdtra=T)
	71	!! - htr_adv, str_adv : 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	!!----------------------------------------------------------------------
[2528]	76	INTEGER , INTENT(in ) :: kt ! ocean time-step index
[3294]	77	INTEGER , INTENT(in ) :: kit000 ! first time step index
[2528]	78	CHARACTER(len=3) , INTENT(in ) :: cdtype ! =TRA or TRC (tracer indicator)
	79	INTEGER , INTENT(in ) :: kjpt ! number of tracers
[3718]	80	LOGICAL , INTENT(in ) :: ld_msc_ups ! use upstream scheme within muscl
[6140]	81	REAL(wp) , INTENT(in ) :: p2dt ! tracer time-step
[2528]	82	REAL(wp), DIMENSION(jpi,jpj,jpk ), INTENT(in ) :: pun, pvn, pwn ! 3 ocean velocity components
	83	REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(in ) :: ptb ! before tracer field
	84	REAL(wp), DIMENSION(jpi,jpj,jpk,kjpt), INTENT(inout) :: pta ! tracer trend
[2715]	85	!
[8568]	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	!
[8568]	94	IF( ln_timing ) CALL timing_start('tra_adv_mus')
[3294]	95	!
	96	IF( kt == kit000 ) THEN
[2528]	97	IF(lwp) WRITE(numout,*)
	98	IF(lwp) WRITE(numout,*) 'tra_adv : MUSCL advection scheme on ', cdtype
[3718]	99	IF(lwp) WRITE(numout,*) ' : mixed up-stream ', ld_msc_ups
[2528]	100	IF(lwp) WRITE(numout,*) '~~~~~~~'
[3680]	101	IF(lwp) WRITE(numout,*)
[2528]	102	!
[5770]	103	! Upstream / MUSCL scheme indicator
[3680]	104	!
[5770]	105	ALLOCATE( xind(jpi,jpj,jpk), STAT=ierr )
[7753]	106	xind(:,:,:) = 1._wp ! set equal to 1 where up-stream is not needed
[5770]	107	!
	108	IF( ld_msc_ups ) THEN ! define the upstream indicator (if asked)
	109	ALLOCATE( upsmsk(jpi,jpj), STAT=ierr )
[7753]	110	upsmsk(:,:) = 0._wp ! not upstream by default
[5770]	111	!
[4990]	112	DO jk = 1, jpkm1
[7753]	113	xind(:,:,jk) = 1._wp & ! =>1 where up-stream is not needed
	114	& - MAX ( rnfmsk(:,:) * rnfmsk_z(jk), & ! =>0 near runoff mouths (& closed sea outflows)
	115	& upsmsk(:,:) ) * tmask(:,:,jk) ! =>0 in some user defined area
[3718]	116	END DO
[3680]	117	ENDIF
[3718]	118	!
	119	ENDIF
[4990]	120	!
[7646]	121	l_trd = .FALSE.
	122	l_hst = .FALSE.
	123	l_ptr = .FALSE.
	124	IF( ( cdtype == 'TRA' .AND. l_trdtra ) .OR. ( cdtype == 'TRC' .AND. l_trdtrc ) ) l_trd = .TRUE.
	125	IF( cdtype == 'TRA' .AND. ln_diaptr ) l_ptr = .TRUE.
	126	IF( cdtype == 'TRA' .AND. ( iom_use("uadv_heattr") .OR. iom_use("vadv_heattr") .OR. &
	127	& iom_use("uadv_salttr") .OR. iom_use("vadv_salttr") ) ) l_hst = .TRUE.
	128	!
[6140]	129	DO jn = 1, kjpt !== loop over the tracers ==!
	130	!
	131	! !* Horizontal advective fluxes
	132	!
	133	! !-- first guess of the slopes
[7753]	134	zwx(:,:,jpk) = 0._wp ! bottom values
	135	zwy(:,:,jpk) = 0._wp
[6140]	136	DO jk = 1, jpkm1 ! interior values
[2528]	137	DO jj = 1, jpjm1
	138	DO ji = 1, fs_jpim1 ! vector opt.
	139	zwx(ji,jj,jk) = umask(ji,jj,jk) * ( ptb(ji+1,jj,jk,jn) - ptb(ji,jj,jk,jn) )
	140	zwy(ji,jj,jk) = vmask(ji,jj,jk) * ( ptb(ji,jj+1,jk,jn) - ptb(ji,jj,jk,jn) )
	141	END DO
	142	END DO
[3]	143	END DO
[6140]	144	CALL lbc_lnk( zwx, 'U', -1. ) ! lateral boundary conditions (changed sign)
[2528]	145	CALL lbc_lnk( zwy, 'V', -1. )
[6140]	146	! !-- Slopes of tracer
[7753]	147	zslpx(:,:,jpk) = 0._wp ! bottom values
	148	zslpy(:,:,jpk) = 0._wp
[6140]	149	DO jk = 1, jpkm1 ! interior values
[2528]	150	DO jj = 2, jpj
	151	DO ji = fs_2, jpi ! vector opt.
	152	zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji-1,jj ,jk) ) &
	153	& * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji-1,jj ,jk) ) )
	154	zslpy(ji,jj,jk) = ( zwy(ji,jj,jk) + zwy(ji ,jj-1,jk) ) &
	155	& * ( 0.25 + SIGN( 0.25, zwy(ji,jj,jk) * zwy(ji ,jj-1,jk) ) )
	156	END DO
[3]	157	END DO
	158	END DO
[503]	159	!
[6140]	160	DO jk = 1, jpkm1 !-- Slopes limitation
[2528]	161	DO jj = 2, jpj
	162	DO ji = fs_2, jpi ! vector opt.
	163	zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji ,jj,jk) ), &
	164	& 2.*ABS( zwx (ji-1,jj,jk) ), &
	165	& 2.*ABS( zwx (ji ,jj,jk) ) )
	166	zslpy(ji,jj,jk) = SIGN( 1., zslpy(ji,jj,jk) ) * MIN( ABS( zslpy(ji,jj ,jk) ), &
	167	& 2.*ABS( zwy (ji,jj-1,jk) ), &
	168	& 2.*ABS( zwy (ji,jj ,jk) ) )
[503]	169	END DO
[2528]	170	END DO
[5770]	171	END DO
	172	!
[6140]	173	DO jk = 1, jpkm1 !-- MUSCL horizontal advective fluxes
[503]	174	DO jj = 2, jpjm1
	175	DO ji = fs_2, fs_jpim1 ! vector opt.
[2528]	176	! MUSCL fluxes
	177	z0u = SIGN( 0.5, pun(ji,jj,jk) )
	178	zalpha = 0.5 - z0u
[6140]	179	zu = z0u - 0.5 * pun(ji,jj,jk) * p2dt * r1_e1e2u(ji,jj) / e3u_n(ji,jj,jk)
[4990]	180	zzwx = ptb(ji+1,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji+1,jj,jk)
	181	zzwy = ptb(ji ,jj,jk,jn) + xind(ji,jj,jk) * zu * zslpx(ji ,jj,jk)
[2528]	182	zwx(ji,jj,jk) = pun(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
	183	!
	184	z0v = SIGN( 0.5, pvn(ji,jj,jk) )
	185	zalpha = 0.5 - z0v
[6140]	186	zv = z0v - 0.5 * pvn(ji,jj,jk) * p2dt * r1_e1e2v(ji,jj) / e3v_n(ji,jj,jk)
[4990]	187	zzwx = ptb(ji,jj+1,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj+1,jk)
	188	zzwy = ptb(ji,jj ,jk,jn) + xind(ji,jj,jk) * zv * zslpy(ji,jj ,jk)
[2528]	189	zwy(ji,jj,jk) = pvn(ji,jj,jk) * ( zalpha * zzwx + (1.-zalpha) * zzwy )
[503]	190	END DO
	191	END DO
	192	END DO
[5770]	193	CALL lbc_lnk( zwx, 'U', -1. ) ; CALL lbc_lnk( zwy, 'V', -1. ) ! lateral boundary conditions (changed sign)
[503]	194	!
[6140]	195	DO jk = 1, jpkm1 !-- Tracer advective trend
[2528]	196	DO jj = 2, jpjm1
	197	DO ji = fs_2, fs_jpim1 ! vector opt.
[5770]	198	pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) - ( zwx(ji,jj,jk) - zwx(ji-1,jj ,jk ) &
	199	& + zwy(ji,jj,jk) - zwy(ji ,jj-1,jk ) ) &
[6140]	200	& * r1_e1e2t(ji,jj) / e3t_n(ji,jj,jk)
[3]	201	END DO
[2528]	202	END DO
	203	END DO
[6140]	204	! ! trend diagnostics
[7646]	205	IF( l_trd ) THEN
[4990]	206	CALL trd_tra( kt, cdtype, jn, jptra_xad, zwx, pun, ptb(:,:,:,jn) )
	207	CALL trd_tra( kt, cdtype, jn, jptra_yad, zwy, pvn, ptb(:,:,:,jn) )
[2528]	208	END IF
[7646]	209	! ! "Poleward" heat and salt transports
	210	IF( l_ptr ) CALL dia_ptr_hst( jn, 'adv', zwy(:,:,:) )
	211	! ! heat transport
	212	IF( l_hst ) CALL dia_ar5_hst( jn, 'adv', zwx(:,:,:), zwy(:,:,:) )
[6140]	213	!
	214	! !* Vertical advective fluxes
	215	!
[5770]	216	! !-- first guess of the slopes
[7753]	217	zwx(:,:, 1 ) = 0._wp ! surface & bottom boundary conditions
	218	zwx(:,:,jpk) = 0._wp
[6140]	219	DO jk = 2, jpkm1 ! interior values
[7753]	220	zwx(:,:,jk) = tmask(:,:,jk) * ( ptb(:,:,jk-1,jn) - ptb(:,:,jk,jn) )
[3]	221	END DO
[5770]	222	! !-- Slopes of tracer
[7753]	223	zslpx(:,:,1) = 0._wp ! surface values
[5770]	224	DO jk = 2, jpkm1 ! interior value
[2528]	225	DO jj = 1, jpj
	226	DO ji = 1, jpi
[6140]	227	zslpx(ji,jj,jk) = ( zwx(ji,jj,jk) + zwx(ji,jj,jk+1) ) &
	228	& * ( 0.25 + SIGN( 0.25, zwx(ji,jj,jk) * zwx(ji,jj,jk+1) ) )
[2528]	229	END DO
[3]	230	END DO
	231	END DO
[6140]	232	DO jk = 2, jpkm1 !-- Slopes limitation
	233	DO jj = 1, jpj ! interior values
[2528]	234	DO ji = 1, jpi
	235	zslpx(ji,jj,jk) = SIGN( 1., zslpx(ji,jj,jk) ) * MIN( ABS( zslpx(ji,jj,jk ) ), &
	236	& 2.*ABS( zwx (ji,jj,jk+1) ), &
	237	& 2.*ABS( zwx (ji,jj,jk ) ) )
	238	END DO
[3]	239	END DO
	240	END DO
[6140]	241	DO jk = 1, jpk-2 !-- vertical advective flux
[2528]	242	DO jj = 2, jpjm1
	243	DO ji = fs_2, fs_jpim1 ! vector opt.
	244	z0w = SIGN( 0.5, pwn(ji,jj,jk+1) )
	245	zalpha = 0.5 + z0w
[6140]	246	zw = z0w - 0.5 * pwn(ji,jj,jk+1) * p2dt * r1_e1e2t(ji,jj) / e3w_n(ji,jj,jk+1)
[4990]	247	zzwx = ptb(ji,jj,jk+1,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk+1)
	248	zzwy = ptb(ji,jj,jk ,jn) + xind(ji,jj,jk) * zw * zslpx(ji,jj,jk )
[5770]	249	zwx(ji,jj,jk+1) = pwn(ji,jj,jk+1) * ( zalpha * zzwx + (1.-zalpha) * zzwy ) * wmask(ji,jj,jk)
[2528]	250	END DO
[3]	251	END DO
	252	END DO
[6140]	253	IF( ln_linssh ) THEN ! top values, linear free surface only
	254	IF( ln_isfcav ) THEN ! ice-shelf cavities (top of the ocean)
[5770]	255	DO jj = 1, jpj
	256	DO ji = 1, jpi
	257	zwx(ji,jj, mikt(ji,jj) ) = pwn(ji,jj,mikt(ji,jj)) * ptb(ji,jj,mikt(ji,jj),jn)
	258	END DO
	259	END DO
[6140]	260	ELSE ! no cavities: only at the ocean surface
[7753]	261	zwx(:,:,1) = pwn(:,:,1) * ptb(:,:,1,jn)
[5770]	262	ENDIF
	263	ENDIF
	264	!
[6140]	265	DO jk = 1, jpkm1 !-- vertical advective trend
[2528]	266	DO jj = 2, jpjm1
[503]	267	DO ji = fs_2, fs_jpim1 ! vector opt.
[6140]	268	pta(ji,jj,jk,jn) = pta(ji,jj,jk,jn) - ( zwx(ji,jj,jk) - zwx(ji,jj,jk+1) ) * r1_e1e2t(ji,jj) / e3t_n(ji,jj,jk)
[503]	269	END DO
	270	END DO
	271	END DO
[6140]	272	! ! send trends for diagnostic
[7646]	273	IF( l_trd ) CALL trd_tra( kt, cdtype, jn, jptra_zad, zwx, pwn, ptb(:,:,:,jn) )
[503]	274	!
[6140]	275	END DO ! end of tracer loop
[503]	276	!
[8568]	277	IF( ln_timing ) CALL timing_stop('tra_adv_mus')
[2715]	278	!
[5770]	279	END SUBROUTINE tra_adv_mus
[3]	280
	281	!!======================================================================
[5770]	282	END MODULE traadv_mus

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

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

Context Navigation

source: branches/2017/dev_r7881_ENHANCE09_RK3/NEMOGCM/NEMO/RK3_SRC/TRA/traadv_mus.F90 @ 8568

Download in other formats: