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.

trcbc.F90 in NEMO/trunk/src/TOP – NEMO

Context Navigation

source: NEMO/trunk/src/TOP/trcbc.F90 @ 10068

Last change on this file since 10068 was 10068, checked in by nicolasmartin, 6 years ago
First part of modifications to have a common default header : fix typos and SVN keywords properties
Property svn:keywords set to `Id`
File size: 23.0 KB

Rev	Line
[4058]	1	MODULE trcbc
	2	!!======================================================================
[6140]	3	!! * MODULE trcbc *
[4058]	4	!! TOP : module for passive tracer boundary conditions
	5	!!=====================================================================
[7646]	6	!! History : 3.5 ! 2014 (M. Vichi, T. Lovato) Original
	7	!! 3.6 ! 2015 (T . Lovato) Revision and BDY support
	8	!! 4.0 ! 2016 (T . Lovato) Include application of sbc and cbc
[4058]	9	!!----------------------------------------------------------------------
[6140]	10	#if defined key_top
[4058]	11	!!----------------------------------------------------------------------
	12	!! 'key_top' TOP model
	13	!!----------------------------------------------------------------------
[7646]	14	!! trc_bc : Apply tracer Boundary Conditions
[4058]	15	!!----------------------------------------------------------------------
	16	USE par_trc ! passive tracers parameters
	17	USE oce_trc ! shared variables between ocean and passive tracers
	18	USE trc ! passive tracers common variables
	19	USE iom ! I/O manager
	20	USE lib_mpp ! MPP library
	21	USE fldread ! read input fields
[7646]	22	USE bdy_oce, ONLY: ln_bdy, nb_bdy , idx_bdy, ln_coords_file, rn_time_dmp, rn_time_dmp_out
[4058]	23
	24	IMPLICIT NONE
	25	PRIVATE
	26
[7646]	27	PUBLIC trc_bc ! called in trcstp.F90 or within TOP modules
	28	PUBLIC trc_bc_ini ! called in trcini.F90
[4058]	29
[6140]	30	INTEGER , SAVE, PUBLIC :: nb_trcobc ! number of tracers with open BC
	31	INTEGER , SAVE, PUBLIC :: nb_trcsbc ! number of tracers with surface BC
	32	INTEGER , SAVE, PUBLIC :: nb_trccbc ! number of tracers with coastal BC
[4058]	33	INTEGER , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: n_trc_indobc ! index of tracer with OBC data
	34	INTEGER , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: n_trc_indsbc ! index of tracer with SBC data
	35	INTEGER , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: n_trc_indcbc ! index of tracer with CBC data
[6140]	36	REAL(wp) , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: rf_trsfac ! multiplicative factor for SBC tracer values
	37	TYPE(FLD), SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: sf_trcsbc ! structure of data input SBC (file informations, fields read)
	38	REAL(wp) , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: rf_trcfac ! multiplicative factor for CBC tracer values
	39	TYPE(FLD), SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: sf_trccbc ! structure of data input CBC (file informations, fields read)
	40	REAL(wp) , SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: rf_trofac ! multiplicative factor for OBCtracer values
[9800]	41	#if defined key_agrif
[9788]	42	TYPE(FLD), SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:) :: sf_trcobc ! structure of data input OBC (file informations, fields read)
[9800]	43	#else
	44	TYPE(FLD), SAVE, PUBLIC, ALLOCATABLE, DIMENSION(:), TARGET :: sf_trcobc
	45	#endif
[6140]	46	TYPE(MAP_POINTER), ALLOCATABLE, DIMENSION(:) :: nbmap_ptr ! array of pointers to nbmap
[4058]	47
[7646]	48	!! * Substitutions
	49	# include "vectopt_loop_substitute.h90"
[4058]	50	!!----------------------------------------------------------------------
[9598]	51	!! NEMO/TOP 4.0 , NEMO Consortium (2018)
[6140]	52	!! $Id$
[10068]	53	!! Software governed by the CeCILL license (see ./LICENSE)
[4058]	54	!!----------------------------------------------------------------------
	55	CONTAINS
	56
[7646]	57	SUBROUTINE trc_bc_ini( ntrc )
[4058]	58	!!----------------------------------------------------------------------
[7646]	59	!! * ROUTINE trc_bc_ini *
[4058]	60	!!
	61	!! ** Purpose : initialisation of passive tracer BC data
	62	!!
	63	!! ** Method : - Read namtsd namelist
	64	!! - allocates passive tracer BC data structure
	65	!!----------------------------------------------------------------------
[9169]	66	INTEGER,INTENT(in) :: ntrc ! number of tracers
	67	!
[6140]	68	INTEGER :: jl, jn , ib, ibd, ii, ij, ik ! dummy loop indices
[4058]	69	INTEGER :: ierr0, ierr1, ierr2, ierr3 ! temporary integers
[6140]	70	INTEGER :: ios ! Local integer output status for namelist read
	71	INTEGER :: nblen, igrd ! support arrays for BDY
[4058]	72	CHARACTER(len=100) :: clndta, clntrc
	73	!
[6140]	74	CHARACTER(len=100) :: cn_dir_sbc, cn_dir_cbc, cn_dir_obc
[4058]	75	TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) :: slf_i ! local array of namelist informations on the fields to read
	76	TYPE(FLD_N), DIMENSION(jpmaxtrc) :: sn_trcobc ! open
	77	TYPE(FLD_N), DIMENSION(jpmaxtrc) :: sn_trcsbc ! surface
	78	TYPE(FLD_N), DIMENSION(jpmaxtrc) :: sn_trccbc ! coastal
	79	REAL(wp) , DIMENSION(jpmaxtrc) :: rn_trofac ! multiplicative factor for tracer values
	80	REAL(wp) , DIMENSION(jpmaxtrc) :: rn_trsfac ! multiplicative factor for tracer values
	81	REAL(wp) , DIMENSION(jpmaxtrc) :: rn_trcfac ! multiplicative factor for tracer values
	82	!!
[7646]	83	NAMELIST/namtrc_bc/ cn_dir_obc, sn_trcobc, rn_trofac, cn_dir_sbc, sn_trcsbc, rn_trsfac, &
	84	& cn_dir_cbc, sn_trccbc, rn_trcfac, ln_rnf_ctl, rn_bc_time
[6140]	85	NAMELIST/namtrc_bdy/ cn_trc_dflt, cn_trc, nn_trcdmp_bdy
[4058]	86	!!----------------------------------------------------------------------
	87	!
[6140]	88	IF( lwp ) THEN
[9169]	89	WRITE(numout,*)
[7646]	90	WRITE(numout,*) 'trc_bc_ini : Tracers Boundary Conditions (BC)'
[6140]	91	WRITE(numout,*) '~~~~~~~~~~~ '
	92	ENDIF
[4058]	93	! Initialisation and local array allocation
[9169]	94	ierr0 = 0 ; ierr1 = 0 ; ierr2 = 0 ; ierr3 = 0
[4058]	95	ALLOCATE( slf_i(ntrc), STAT=ierr0 )
	96	IF( ierr0 > 0 ) THEN
[7646]	97	CALL ctl_stop( 'trc_bc_ini: unable to allocate local slf_i' ) ; RETURN
[4058]	98	ENDIF
	99
	100	! Compute the number of tracers to be initialised with open, surface and boundary data
	101	ALLOCATE( n_trc_indobc(ntrc), STAT=ierr0 )
	102	IF( ierr0 > 0 ) THEN
[7646]	103	CALL ctl_stop( 'trc_bc_ini: unable to allocate n_trc_indobc' ) ; RETURN
[4058]	104	ENDIF
[9169]	105	nb_trcobc = 0
[4058]	106	n_trc_indobc(:) = 0
	107	!
	108	ALLOCATE( n_trc_indsbc(ntrc), STAT=ierr0 )
	109	IF( ierr0 > 0 ) THEN
[7646]	110	CALL ctl_stop( 'trc_bc_ini: unable to allocate n_trc_indsbc' ) ; RETURN
[4058]	111	ENDIF
[9169]	112	nb_trcsbc = 0
[4058]	113	n_trc_indsbc(:) = 0
	114	!
	115	ALLOCATE( n_trc_indcbc(ntrc), STAT=ierr0 )
	116	IF( ierr0 > 0 ) THEN
[7646]	117	CALL ctl_stop( 'trc_bc_ini: unable to allocate n_trc_indcbc' ) ; RETURN
[4058]	118	ENDIF
[9169]	119	nb_trccbc = 0
[4058]	120	n_trc_indcbc(:) = 0
	121	!
[6140]	122	! Read Boundary Conditions Namelists
	123	REWIND( numnat_ref ) ! Namelist namtrc_bc in reference namelist : Passive tracer data structure
	124	READ ( numnat_ref, namtrc_bc, IOSTAT = ios, ERR = 901)
[9169]	125	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_bc in reference namelist', lwp )
[6140]	126	REWIND( numnat_cfg ) ! Namelist namtrc_bc in configuration namelist : Passive tracer data structure
	127	READ ( numnat_cfg, namtrc_bc, IOSTAT = ios, ERR = 902 )
[9169]	128	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtrc_bc in configuration namelist', lwp )
[6140]	129	IF(lwm) WRITE ( numont, namtrc_bc )
	130
[7646]	131	IF ( ln_bdy ) THEN
	132	REWIND( numnat_ref ) ! Namelist namtrc_bdy in reference namelist : Passive tracer data structure
	133	READ ( numnat_ref, namtrc_bdy, IOSTAT = ios, ERR = 903)
[9169]	134	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namtrc_bdy in reference namelist', lwp )
[6140]	135
[7646]	136	REWIND( numnat_cfg ) ! Namelist namtrc_bdy in configuration namelist : Passive tracer data structure
	137	READ ( numnat_cfg, namtrc_bdy, IOSTAT = ios, ERR = 904 )
[9169]	138	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namtrc_bdy in configuration namelist', lwp )
[7646]	139	IF(lwm) WRITE ( numont, namtrc_bdy )
	140
	141	! setup up preliminary informations for BDY structure
	142	DO jn = 1, ntrc
	143	DO ib = 1, nb_bdy
	144	! Set type of obc in BDY data structure (around here we may plug user override of obc type from nml)
[9169]	145	IF ( ln_trc_obc(jn) ) THEN ; trcdta_bdy(jn,ib)%cn_obc = TRIM( cn_trc (ib) )
	146	ELSE ; trcdta_bdy(jn,ib)%cn_obc = TRIM( cn_trc_dflt(ib) )
[7646]	147	ENDIF
	148	! set damping use in BDY data structure
	149	trcdta_bdy(jn,ib)%dmp = .false.
[9169]	150	IF(nn_trcdmp_bdy(ib) == 1 .AND. ln_trc_obc(jn) ) trcdta_bdy(jn,ib)%dmp = .true.
	151	IF(nn_trcdmp_bdy(ib) == 2 ) trcdta_bdy(jn,ib)%dmp = .true.
	152	IF(trcdta_bdy(jn,ib)%cn_obc == 'frs' .AND. nn_trcdmp_bdy(ib) /= 0 ) &
	153	& CALL ctl_stop( 'trc_bc_ini: Use FRS OR relaxation' )
	154	IF( .NOT.( 0 < nn_trcdmp_bdy(ib) .AND. nn_trcdmp_bdy(ib) <= 2 ) ) &
	155	& CALL ctl_stop( 'trc_bc_ini: Not a valid option for nn_trcdmp_bdy. Allowed: 0,1,2.' )
	156	END DO
	157	END DO
[7646]	158	ELSE
	159	! Force all tracers OBC to false if bdy not used
	160	ln_trc_obc = .false.
	161	ENDIF
[6140]	162
	163	! compose BC data indexes
	164	DO jn = 1, ntrc
[4058]	165	IF( ln_trc_obc(jn) ) THEN
[9169]	166	nb_trcobc = nb_trcobc + 1 ; n_trc_indobc(jn) = nb_trcobc
[4058]	167	ENDIF
	168	IF( ln_trc_sbc(jn) ) THEN
[9169]	169	nb_trcsbc = nb_trcsbc + 1 ; n_trc_indsbc(jn) = nb_trcsbc
[4058]	170	ENDIF
	171	IF( ln_trc_cbc(jn) ) THEN
[9169]	172	nb_trccbc = nb_trccbc + 1 ; n_trc_indcbc(jn) = nb_trccbc
[4058]	173	ENDIF
[9169]	174	END DO
[4058]	175
[6140]	176	! Print summmary of Boundary Conditions
	177	IF( lwp ) THEN
[9169]	178	WRITE(numout,*)
[6140]	179	WRITE(numout,'(a,i3)') ' Total tracers to be initialized with SURFACE BCs data:', nb_trcsbc
	180	IF ( nb_trcsbc > 0 ) THEN
	181	WRITE(numout,*) ' #trc NAME Boundary Mult.Fact. '
	182	DO jn = 1, ntrc
	183	IF ( ln_trc_sbc(jn) ) WRITE(numout,9001) jn, TRIM( sn_trcsbc(jn)%clvar ), 'SBC', rn_trsfac(jn)
[9169]	184	END DO
[6140]	185	ENDIF
	186	WRITE(numout,'(2a)') ' SURFACE BC data repository : ', TRIM(cn_dir_sbc)
[9169]	187	!
	188	WRITE(numout,*)
[6140]	189	WRITE(numout,'(a,i3)') ' Total tracers to be initialized with COASTAL BCs data:', nb_trccbc
[7646]	190	IF( nb_trccbc > 0 ) THEN
[6140]	191	WRITE(numout,*) ' #trc NAME Boundary Mult.Fact. '
	192	DO jn = 1, ntrc
	193	IF ( ln_trc_cbc(jn) ) WRITE(numout, 9001) jn, TRIM( sn_trccbc(jn)%clvar ), 'CBC', rn_trcfac(jn)
[9169]	194	END DO
[6140]	195	ENDIF
	196	WRITE(numout,'(2a)') ' COASTAL BC data repository : ', TRIM(cn_dir_cbc)
[9169]	197	IF( .NOT.ln_rnf .OR. .NOT.ln_linssh ) ln_rnf_ctl = .FALSE.
[9119]	198	IF( ln_rnf_ctl ) WRITE(numout,'(a)') &
	199	& ' -> Remove runoff dilution effect on tracers with absent river load (ln_rnf_ctl = .TRUE.)'
[9169]	200	WRITE(numout,*)
[6140]	201	WRITE(numout,'(a,i3)') ' Total tracers to be initialized with OPEN BCs data:', nb_trcobc
[7646]	202
	203	IF( ln_bdy .AND. nb_trcobc > 0 ) THEN
[6140]	204	WRITE(numout,*) ' #trc NAME Boundary Mult.Fact. OBC Settings'
	205	DO jn = 1, ntrc
[9119]	206	IF ( ln_trc_obc(jn) ) WRITE(numout, 9001) jn, TRIM( sn_trcobc(jn)%clvar ), 'OBC', rn_trofac(jn), &
	207	& (trcdta_bdy(jn,ib)%cn_obc,ib=1,nb_bdy)
	208	IF ( .NOT. ln_trc_obc(jn) ) WRITE(numout, 9002) jn, 'Set data to IC and use default condition' , &
	209	& (trcdta_bdy(jn,ib)%cn_obc,ib=1,nb_bdy)
[9169]	210	END DO
[6140]	211	WRITE(numout,*) ' '
	212	DO ib = 1, nb_bdy
[9169]	213	IF(nn_trcdmp_bdy(ib) == 0) WRITE(numout,9003) ' Boundary ', ib, &
	214	& ' -> NO damping of tracers'
	215	IF(nn_trcdmp_bdy(ib) == 1) WRITE(numout,9003) ' Boundary ', ib, &
	216	& ' -> damping ONLY for tracers with external data provided'
	217	IF(nn_trcdmp_bdy(ib) == 2) WRITE(numout,9003) ' Boundary ', ib, &
	218	& ' -> damping of ALL tracers'
	219	IF(nn_trcdmp_bdy(ib) > 0) THEN
[6140]	220	WRITE(numout,9003) ' USE damping parameters from nambdy for boundary ', ib,' : '
[9169]	221	WRITE(numout,'(a,f10.2,a)') ' - Inflow damping time scale : ',rn_time_dmp (ib),' days'
[6140]	222	WRITE(numout,'(a,f10.2,a)') ' - Outflow damping time scale : ',rn_time_dmp_out(ib),' days'
[9169]	223	ENDIF
	224	END DO
[6140]	225	ENDIF
[9169]	226	!
[6140]	227	WRITE(numout,'(2a)') ' OPEN BC data repository : ', TRIM(cn_dir_obc)
[4058]	228	ENDIF
[6140]	229	9001 FORMAT(2x,i5, 3x, a15, 3x, a5, 6x, e11.3, 4x, 10a13)
	230	9002 FORMAT(2x,i5, 3x, a41, 3x, 10a13)
	231	9003 FORMAT(a, i5, a)
[4058]	232	!
[9169]	233	!
[4058]	234	! OPEN Lateral boundary conditions
[7646]	235	IF( ln_bdy .AND. nb_trcobc > 0 ) THEN
[6140]	236	ALLOCATE ( sf_trcobc(nb_trcobc), rf_trofac(nb_trcobc), nbmap_ptr(nb_trcobc), STAT=ierr1 )
[4058]	237	IF( ierr1 > 0 ) THEN
[7646]	238	CALL ctl_stop( 'trc_bc_ini: unable to allocate sf_trcobc structure' ) ; RETURN
[4058]	239	ENDIF
[9169]	240	!
[6140]	241	igrd = 1 ! Everything is at T-points here
[9169]	242	!
[4058]	243	DO jn = 1, ntrc
[6140]	244	DO ib = 1, nb_bdy
[9169]	245	!
[6140]	246	nblen = idx_bdy(ib)%nblen(igrd)
[9169]	247	!
	248	IF( ln_trc_obc(jn) ) THEN !* Initialise from external data *!
[6140]	249	jl = n_trc_indobc(jn)
	250	slf_i(jl) = sn_trcobc(jn)
	251	rf_trofac(jl) = rn_trofac(jn)
[9169]	252	ALLOCATE( sf_trcobc(jl)%fnow(nblen,1,jpk) , STAT=ierr2 )
	253	IF( sn_trcobc(jn)%ln_tint ) ALLOCATE( sf_trcobc(jl)%fdta(nblen,1,jpk,2) , STAT=ierr3 )
[6140]	254	IF( ierr2 + ierr3 > 0 ) THEN
[7646]	255	CALL ctl_stop( 'trc_bc_ini : unable to allocate passive tracer OBC data arrays' ) ; RETURN
[6140]	256	ENDIF
	257	trcdta_bdy(jn,ib)%trc => sf_trcobc(jl)%fnow(:,1,:)
	258	trcdta_bdy(jn,ib)%rn_fac = rf_trofac(jl)
	259	! create OBC mapping array
	260	nbmap_ptr(jl)%ptr => idx_bdy(ib)%nbmap(:,igrd)
	261	nbmap_ptr(jl)%ll_unstruc = ln_coords_file(igrd)
[9169]	262	!
	263	ELSE !* Initialise obc arrays from initial conditions *!
[6140]	264	ALLOCATE ( trcdta_bdy(jn,ib)%trc(nblen,jpk) )
	265	DO ibd = 1, nblen
	266	DO ik = 1, jpkm1
	267	ii = idx_bdy(ib)%nbi(ibd,igrd)
	268	ij = idx_bdy(ib)%nbj(ibd,igrd)
	269	trcdta_bdy(jn,ib)%trc(ibd,ik) = trn(ii,ij,ik,jn) * tmask(ii,ij,ik)
	270	END DO
	271	END DO
	272	trcdta_bdy(jn,ib)%rn_fac = 1._wp
[4058]	273	ENDIF
[9169]	274	END DO
	275	END DO
	276	!
[7646]	277	CALL fld_fill( sf_trcobc, slf_i, cn_dir_obc, 'trc_bc_ini', 'Passive tracer OBC data', 'namtrc_bc' )
[4058]	278	ENDIF
[7646]	279
[4058]	280	! SURFACE Boundary conditions
	281	IF( nb_trcsbc > 0 ) THEN ! allocate only if the number of tracer to initialise is greater than zero
	282	ALLOCATE( sf_trcsbc(nb_trcsbc), rf_trsfac(nb_trcsbc), STAT=ierr1 )
	283	IF( ierr1 > 0 ) THEN
[7646]	284	CALL ctl_stop( 'trc_bc_ini: unable to allocate sf_trcsbc structure' ) ; RETURN
[4058]	285	ENDIF
	286	!
	287	DO jn = 1, ntrc
	288	IF( ln_trc_sbc(jn) ) THEN ! update passive tracers arrays with input data read from file
	289	jl = n_trc_indsbc(jn)
	290	slf_i(jl) = sn_trcsbc(jn)
	291	rf_trsfac(jl) = rn_trsfac(jn)
	292	ALLOCATE( sf_trcsbc(jl)%fnow(jpi,jpj,1) , STAT=ierr2 )
	293	IF( sn_trcsbc(jn)%ln_tint ) ALLOCATE( sf_trcsbc(jl)%fdta(jpi,jpj,1,2) , STAT=ierr3 )
	294	IF( ierr2 + ierr3 > 0 ) THEN
[7646]	295	CALL ctl_stop( 'trc_bc_ini : unable to allocate passive tracer SBC data arrays' ) ; RETURN
[4058]	296	ENDIF
	297	ENDIF
	298	!
[9169]	299	END DO
[4058]	300	! ! fill sf_trcsbc with slf_i and control print
[7646]	301	CALL fld_fill( sf_trcsbc, slf_i, cn_dir_sbc, 'trc_bc_ini', 'Passive tracer SBC data', 'namtrc_bc' )
[4058]	302	!
	303	ENDIF
	304	!
	305	! COSTAL Boundary conditions
	306	IF( nb_trccbc > 0 ) THEN ! allocate only if the number of tracer to initialise is greater than zero
	307	ALLOCATE( sf_trccbc(nb_trccbc), rf_trcfac(nb_trccbc), STAT=ierr1 )
	308	IF( ierr1 > 0 ) THEN
	309	CALL ctl_stop( 'trc_bc_ini: unable to allocate sf_trccbc structure' ) ; RETURN
	310	ENDIF
	311	!
	312	DO jn = 1, ntrc
	313	IF( ln_trc_cbc(jn) ) THEN ! update passive tracers arrays with input data read from file
	314	jl = n_trc_indcbc(jn)
	315	slf_i(jl) = sn_trccbc(jn)
	316	rf_trcfac(jl) = rn_trcfac(jn)
	317	ALLOCATE( sf_trccbc(jl)%fnow(jpi,jpj,1) , STAT=ierr2 )
	318	IF( sn_trccbc(jn)%ln_tint ) ALLOCATE( sf_trccbc(jl)%fdta(jpi,jpj,1,2) , STAT=ierr3 )
	319	IF( ierr2 + ierr3 > 0 ) THEN
	320	CALL ctl_stop( 'trc_bc_ini : unable to allocate passive tracer CBC data arrays' ) ; RETURN
	321	ENDIF
	322	ENDIF
	323	!
[9169]	324	END DO
[4058]	325	! ! fill sf_trccbc with slf_i and control print
[7646]	326	CALL fld_fill( sf_trccbc, slf_i, cn_dir_cbc, 'trc_bc_ini', 'Passive tracer CBC data', 'namtrc_bc' )
[4058]	327	!
	328	ENDIF
[6140]	329	!
[4058]	330	DEALLOCATE( slf_i ) ! deallocate local field structure
[6140]	331	!
[7646]	332	END SUBROUTINE trc_bc_ini
[4058]	333
	334
[7646]	335	SUBROUTINE trc_bc(kt, jit)
[4058]	336	!!----------------------------------------------------------------------
[7646]	337	!! * ROUTINE trc_bc *
[4058]	338	!!
[7646]	339	!! ** Purpose : Apply Boundary Conditions data to tracers
[4058]	340	!!
[7646]	341	!! ** Method : 1) Read BC inputs and update data structures using fldread
	342	!! 2) Apply Boundary Conditions to tracers
[4058]	343	!!----------------------------------------------------------------------
	344	USE fldread
[9124]	345	!!
[9169]	346	INTEGER, INTENT(in) :: kt ! ocean time-step index
	347	INTEGER, INTENT(in), OPTIONAL :: jit ! subcycle time-step index (for timesplitting option)
[7646]	348	!!
	349	INTEGER :: ji, jj, jk, jn, jl ! Loop index
	350	REAL(wp) :: zfact, zrnf
[4058]	351	!!---------------------------------------------------------------------
	352	!
[9124]	353	IF( ln_timing ) CALL timing_start('trc_bc')
[4058]	354
[6140]	355	IF( kt == nit000 .AND. lwp) THEN
	356	WRITE(numout,*)
[7646]	357	WRITE(numout,*) 'trc_bc : Surface boundary conditions for passive tracers.'
[9169]	358	WRITE(numout,*) '~~~~~~~ '
[4058]	359	ENDIF
	360
[7646]	361	! 1. Update Boundary conditions data
[9169]	362	IF( PRESENT(jit) ) THEN
	363	!
[6140]	364	! OPEN boundary conditions (use time_offset=+1 as they are applied at the end of the step)
	365	IF( nb_trcobc > 0 ) THEN
	366	if (lwp) write(numout,'(a,i5,a,i10)') ' reading OBC data for ', nb_trcobc ,' variable(s) at step ', kt
[9169]	367	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trcobc, map=nbmap_ptr, kit=jit, kt_offset=+1)
[6140]	368	ENDIF
[9169]	369	!
[6140]	370	! SURFACE boundary conditions
	371	IF( nb_trcsbc > 0 ) THEN
	372	if (lwp) write(numout,'(a,i5,a,i10)') ' reading SBC data for ', nb_trcsbc ,' variable(s) at step ', kt
[9169]	373	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trcsbc, kit=jit)
[6140]	374	ENDIF
[9169]	375	!
[6140]	376	! COASTAL boundary conditions
	377	IF( nb_trccbc > 0 ) THEN
	378	if (lwp) write(numout,'(a,i5,a,i10)') ' reading CBC data for ', nb_trccbc ,' variable(s) at step ', kt
[9169]	379	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trccbc, kit=jit)
[6140]	380	ENDIF
[9169]	381	!
[6140]	382	ELSE
[9169]	383	!
[6140]	384	! OPEN boundary conditions (use time_offset=+1 as they are applied at the end of the step)
	385	IF( nb_trcobc > 0 ) THEN
	386	if (lwp) write(numout,'(a,i5,a,i10)') ' reading OBC data for ', nb_trcobc ,' variable(s) at step ', kt
[9169]	387	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trcobc, map=nbmap_ptr, kt_offset=+1)
[6140]	388	ENDIF
[9169]	389	!
[6140]	390	! SURFACE boundary conditions
	391	IF( nb_trcsbc > 0 ) THEN
	392	if (lwp) write(numout,'(a,i5,a,i10)') ' reading SBC data for ', nb_trcsbc ,' variable(s) at step ', kt
[9169]	393	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trcsbc )
[6140]	394	ENDIF
[9169]	395	!
[6140]	396	! COASTAL boundary conditions
	397	IF( nb_trccbc > 0 ) THEN
	398	if (lwp) write(numout,'(a,i5,a,i10)') ' reading CBC data for ', nb_trccbc ,' variable(s) at step ', kt
[9169]	399	CALL fld_read( kt=kt, kn_fsbc=1, sd=sf_trccbc )
[6140]	400	ENDIF
[9169]	401	!
[4058]	402	ENDIF
	403
[7646]	404	! 2. Apply Boundary conditions data
	405	!
	406	DO jn = 1 , jptra
	407	!
	408	! Remove river dilution for tracers with absent river load
[9169]	409	IF( ln_rnf_ctl .AND. .NOT.ln_trc_cbc(jn) ) THEN
[7646]	410	DO jj = 2, jpj
	411	DO ji = fs_2, fs_jpim1
	412	DO jk = 1, nk_rnf(ji,jj)
	413	zrnf = (rnf(ji,jj) + rnf_b(ji,jj)) * 0.5_wp * r1_rau0 / h_rnf(ji,jj)
	414	tra(ji,jj,jk,jn) = tra(ji,jj,jk,jn) + (trn(ji,jj,jk,jn) * zrnf)
[9169]	415	END DO
	416	END DO
	417	END DO
[7646]	418	ENDIF
[9169]	419	!
[7646]	420	! OPEN boundary conditions: trcbdy is called in trcnxt !
[9169]	421	!
[7646]	422	! SURFACE boundary conditions
[9169]	423	IF( ln_trc_sbc(jn) ) THEN
[7646]	424	jl = n_trc_indsbc(jn)
	425	DO jj = 2, jpj
	426	DO ji = fs_2, fs_jpim1 ! vector opt.
	427	zfact = 1. / ( e3t_n(ji,jj,1) * rn_bc_time )
	428	tra(ji,jj,1,jn) = tra(ji,jj,1,jn) + rf_trsfac(jl) * sf_trcsbc(jl)%fnow(ji,jj,1) * zfact
	429	END DO
	430	END DO
[9169]	431	ENDIF
	432	!
[7646]	433	! COASTAL boundary conditions
[9169]	434	IF( ln_rnf .AND. ln_trc_cbc(jn) ) THEN
[7646]	435	jl = n_trc_indcbc(jn)
	436	DO jj = 2, jpj
	437	DO ji = fs_2, fs_jpim1 ! vector opt.
	438	DO jk = 1, nk_rnf(ji,jj)
	439	zfact = rn_rfact / ( e1e2t(ji,jj) * h_rnf(ji,jj) * rn_bc_time )
	440	tra(ji,jj,jk,jn) = tra(ji,jj,jk,jn) + rf_trcfac(jl) * sf_trccbc(jl)%fnow(ji,jj,1) * zfact
[9169]	441	END DO
[7646]	442	END DO
	443	END DO
[9169]	444	ENDIF
[7646]	445	! ! ===========
	446	END DO ! tracer loop
	447	! ! ===========
[9124]	448	IF( ln_timing ) CALL timing_stop('trc_bc')
[4058]	449	!
[7646]	450	END SUBROUTINE trc_bc
[4058]	451
	452	#else
	453	!!----------------------------------------------------------------------
	454	!! Dummy module NO 3D passive tracer data
	455	!!----------------------------------------------------------------------
	456	CONTAINS
[7646]	457	SUBROUTINE trc_bc_ini( ntrc ) ! Empty routine
[6140]	458	INTEGER,INTENT(IN) :: ntrc ! number of tracers
[7646]	459	WRITE(,) 'trc_bc_ini: You should not have seen this print! error?', kt
	460	END SUBROUTINE trc_bc_ini
	461	SUBROUTINE trc_bc( kt ) ! Empty routine
	462	WRITE(,) 'trc_bc: You should not have seen this print! error?', kt
	463	END SUBROUTINE trc_bc
[4058]	464	#endif
	465
	466	!!======================================================================
	467	END MODULE trcbc

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

Download in other formats: