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.

sbcrnf.F90 in trunk/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

Context Navigation

source: trunk/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 7727

Last change on this file since 7727 was 7698, checked in by mocavero, 7 years ago
update trunk with OpenMP parallelization
Property svn:keywords set to `Id`
File size: 32.2 KB

Rev	Line
[888]	1	MODULE sbcrnf
	2	!!======================================================================
	3	!! * MODULE sbcrnf *
	4	!! Ocean forcing: river runoff
	5	!!=====================================================================
[2528]	6	!! History : OPA ! 2000-11 (R. Hordoir, E. Durand) NetCDF FORMAT
	7	!! NEMO 1.0 ! 2002-09 (G. Madec) F90: Free form and module
[3764]	8	!! 3.0 ! 2006-07 (G. Madec) Surface module
[2528]	9	!! 3.2 ! 2009-04 (B. Lemaire) Introduce iom_put
	10	!! 3.3 ! 2010-10 (R. Furner, G. Madec) runoff distributed over ocean levels
[888]	11	!!----------------------------------------------------------------------
	12
	13	!!----------------------------------------------------------------------
[6140]	14	!! sbc_rnf : monthly runoffs read in a NetCDF file
	15	!! sbc_rnf_init : runoffs initialisation
	16	!! rnf_mouth : set river mouth mask
[888]	17	!!----------------------------------------------------------------------
[6140]	18	USE dom_oce ! ocean space and time domain
	19	USE phycst ! physical constants
	20	USE sbc_oce ! surface boundary condition variables
	21	USE sbcisf ! PM we could remove it I think
	22	USE eosbn2 ! Equation Of State
[7646]	23	USE usrdef_closea ! closed seas
[6140]	24	!
	25	USE in_out_manager ! I/O manager
	26	USE fldread ! read input field at current time step
	27	USE iom ! I/O module
	28	USE lib_mpp ! MPP library
	29	USE wrk_nemo ! Memory allocation
[888]	30
	31	IMPLICIT NONE
	32	PRIVATE
	33
[6140]	34	PUBLIC sbc_rnf ! called in sbcmod module
	35	PUBLIC sbc_rnf_div ! called in divhor module
	36	PUBLIC sbc_rnf_alloc ! called in sbcmod module
	37	PUBLIC sbc_rnf_init ! called in sbcmod module
[5836]	38
[6140]	39	! !!* namsbc_rnf namelist *
	40	CHARACTER(len=100) :: cn_dir !: Root directory for location of rnf files
[5431]	41	LOGICAL :: ln_rnf_depth !: depth river runoffs attribute specified in a file
[6140]	42	LOGICAL :: ln_rnf_depth_ini !: depth river runoffs computed at the initialisation
	43	REAL(wp) :: rn_rnf_max !: maximum value of the runoff climatologie (ln_rnf_depth_ini =T)
	44	REAL(wp) :: rn_dep_max !: depth over which runoffs is spread (ln_rnf_depth_ini =T)
	45	INTEGER :: nn_rnf_depth_file !: create (=1) a runoff depth file or not (=0)
	46	LOGICAL :: ln_rnf_tem !: temperature river runoffs attribute specified in a file
	47	LOGICAL , PUBLIC :: ln_rnf_sal !: salinity river runoffs attribute specified in a file
	48	TYPE(FLD_N) , PUBLIC :: sn_rnf !: information about the runoff file to be read
	49	TYPE(FLD_N) :: sn_cnf !: information about the runoff mouth file to be read
	50	TYPE(FLD_N) :: sn_s_rnf !: information about the salinities of runoff file to be read
	51	TYPE(FLD_N) :: sn_t_rnf !: information about the temperatures of runoff file to be read
	52	TYPE(FLD_N) :: sn_dep_rnf !: information about the depth which river inflow affects
	53	LOGICAL , PUBLIC :: ln_rnf_mouth !: specific treatment in mouths vicinity
	54	REAL(wp) :: rn_hrnf !: runoffs, depth over which enhanced vertical mixing is used
	55	REAL(wp) , PUBLIC :: rn_avt_rnf !: runoffs, value of the additional vertical mixing coef. [m2/s]
	56	REAL(wp) , PUBLIC :: rn_rfact !: multiplicative factor for runoff
[888]	57
[6140]	58	LOGICAL , PUBLIC :: l_rnfcpl = .false. !: runoffs recieved from oasis
	59	INTEGER , PUBLIC :: nkrnf = 0 !: nb of levels over which Kz is increased at river mouths
	60
[2715]	61	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnfmsk !: river mouth mask (hori.)
	62	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: rnfmsk_z !: river mouth mask (vert.)
	63	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: h_rnf !: depth of runoff in m
	64	INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: nk_rnf !: depth of runoff in model levels
[3764]	65	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: rnf_tsc_b, rnf_tsc !: before and now T & S runoff contents [K.m/s & PSU.m/s]
[888]	66
[5431]	67	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_rnf ! structure: river runoff (file information, fields read)
	68	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_s_rnf ! structure: river runoff salinity (file information, fields read)
	69	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_t_rnf ! structure: river runoff temperature (file information, fields read)
[2528]	70
[888]	71	!!----------------------------------------------------------------------
[2528]	72	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
[1146]	73	!! $Id$
[2528]	74	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[888]	75	!!----------------------------------------------------------------------
	76	CONTAINS
	77
[2715]	78	INTEGER FUNCTION sbc_rnf_alloc()
	79	!!----------------------------------------------------------------------
	80	!! * ROUTINE sbc_rnf_alloc *
	81	!!----------------------------------------------------------------------
	82	ALLOCATE( rnfmsk(jpi,jpj) , rnfmsk_z(jpk) , &
	83	& h_rnf (jpi,jpj) , nk_rnf (jpi,jpj) , &
	84	& rnf_tsc_b(jpi,jpj,jpts) , rnf_tsc (jpi,jpj,jpts) , STAT=sbc_rnf_alloc )
	85	!
	86	IF( lk_mpp ) CALL mpp_sum ( sbc_rnf_alloc )
	87	IF( sbc_rnf_alloc > 0 ) CALL ctl_warn('sbc_rnf_alloc: allocation of arrays failed')
	88	END FUNCTION sbc_rnf_alloc
	89
[3625]	90
[888]	91	SUBROUTINE sbc_rnf( kt )
	92	!!----------------------------------------------------------------------
	93	!! * ROUTINE sbc_rnf *
[3764]	94	!!
[888]	95	!! ** Purpose : Introduce a climatological run off forcing
	96	!!
[3764]	97	!! ** Method : Set each river mouth with a monthly climatology
[888]	98	!! provided from different data.
	99	!! CAUTION : upward water flux, runoff forced to be < 0
	100	!!
	101	!! ** Action : runoff updated runoff field at time-step kt
	102	!!----------------------------------------------------------------------
	103	INTEGER, INTENT(in) :: kt ! ocean time step
[3625]	104	!
[7698]	105	INTEGER :: ji, jj, jn ! dummy loop indices
	106	INTEGER :: z_err = 0 ! dummy integer for error handling
[888]	107	!!----------------------------------------------------------------------
[4990]	108	REAL(wp), DIMENSION(:,:), POINTER :: ztfrz ! freezing point used for temperature correction
[3764]	109	!
[4990]	110	CALL wrk_alloc( jpi,jpj, ztfrz)
[6460]	111	!
[5407]	112	! !-------------------!
	113	! ! Update runoff !
	114	! !-------------------!
	115	!
	116	IF( .NOT. l_rnfcpl ) CALL fld_read ( kt, nn_fsbc, sf_rnf ) ! Read Runoffs data and provide it at kt
	117	IF( ln_rnf_tem ) CALL fld_read ( kt, nn_fsbc, sf_t_rnf ) ! idem for runoffs temperature if required
	118	IF( ln_rnf_sal ) CALL fld_read ( kt, nn_fsbc, sf_s_rnf ) ! idem for runoffs salinity if required
	119	!
	120	IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
[888]	121	!
[7698]	122	IF( .NOT. l_rnfcpl ) THEN ! updated runoff value at time step kt
	123	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	124	DO jj = 1, jpj
	125	DO ji = 1, jpi
	126	rnf(ji,jj) = rn_rfact * ( sf_rnf(1)%fnow(ji,jj,1) )
	127	END DO
	128	END DO
	129	END IF
[2528]	130	!
[5407]	131	! ! set temperature & salinity content of runoffs
	132	IF( ln_rnf_tem ) THEN ! use runoffs temperature data
[7698]	133	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	134	DO jj = 1, jpj
	135	DO ji = 1, jpi
	136	rnf_tsc(ji,jj,jp_tem) = ( sf_t_rnf(1)%fnow(ji,jj,1) ) * rnf(ji,jj) * r1_rau0
	137	END DO
	138	END DO
[6140]	139	CALL eos_fzp( sss_m(:,:), ztfrz(:,:) )
[7698]	140	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	141	DO jj = 1, jpj
	142	DO ji = 1, jpi
	143	IF ( sf_t_rnf(1)%fnow(ji,jj,1) == -999._wp ) THEN ! if missing data value use SST as runoffs temperature
	144	rnf_tsc(ji,jj,jp_tem) = sst_m(ji,jj) * rnf(ji,jj) * r1_rau0
	145	END IF
	146	IF ( sf_t_rnf(1)%fnow(ji,jj,1) == -222._wp ) THEN ! where fwf comes from melting of ice shelves or iceberg
	147	rnf_tsc(ji,jj,jp_tem) = ztfrz(ji,jj) * rnf(ji,jj) * r1_rau0 - rnf(ji,jj) * rlfusisf * r1_rau0_rcp
	148	END IF
	149	END DO
	150	END DO
[5407]	151	ELSE ! use SST as runoffs temperature
[7698]	152	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	153	DO jj = 1, jpj
	154	DO ji = 1, jpi
	155	rnf_tsc(ji,jj,jp_tem) = sst_m(ji,jj) * rnf(ji,jj) * r1_rau0
	156	END DO
	157	END DO
	158	END IF
[5407]	159	! ! use runoffs salinity data
[7698]	160	IF( ln_rnf_sal ) THEN
	161	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	162	DO jj = 1, jpj
	163	DO ji = 1, jpi
	164	rnf_tsc(ji,jj,jp_sal) = ( sf_s_rnf(1)%fnow(ji,jj,1) ) * rnf(ji,jj) * r1_rau0
	165	END DO
	166	END DO
	167	END IF
	168	! ! else use S=0 for runoffs (done one for all in the init)
[5407]	169	CALL iom_put( "runoffs", rnf ) ! output runoffs arrays
[2528]	170	ENDIF
	171	!
[5407]	172	! ! ---------------------------------------- !
[2528]	173	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	174	! ! ---------------------------------------- !
	175	IF( ln_rstart .AND. & !* Restart: read in restart file
[3764]	176	& iom_varid( numror, 'rnf_b', ldstop = .FALSE. ) > 0 ) THEN
[2528]	177	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields red in the restart file'
	178	CALL iom_get( numror, jpdom_autoglo, 'rnf_b', rnf_b ) ! before runoff
	179	CALL iom_get( numror, jpdom_autoglo, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem) ) ! before heat content of runoff
	180	CALL iom_get( numror, jpdom_autoglo, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal) ) ! before salinity content of runoff
	181	ELSE !* no restart: set from nit000 values
	182	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields set to nit000'
[7698]	183	!$OMP PARALLEL
	184	!$OMP DO schedule(static) private(jj,ji)
	185	DO jj = 1, jpj
	186	DO ji = 1, jpi
	187	rnf_b (ji,jj ) = rnf (ji,jj )
	188	END DO
	189	END DO
	190	!$OMP END DO NOWAIT
	191	DO jn = 1, jpts
	192	!$OMP DO schedule(static) private(jj,ji)
	193	DO jj = 1, jpj
	194	DO ji = 1, jpi
	195	rnf_tsc_b(ji,jj,jn) = rnf_tsc(ji,jj,jn)
	196	END DO
	197	END DO
	198	END DO
	199	!$OMP END PARALLEL
[2528]	200	ENDIF
	201	ENDIF
	202	! ! ---------------------------------------- !
	203	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	204	! ! ---------------------------------------- !
	205	IF(lwp) WRITE(numout,*)
	206	IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ', &
	207	& 'at it= ', kt,' date= ', ndastp
	208	IF(lwp) WRITE(numout,*) '~~~~'
	209	CALL iom_rstput( kt, nitrst, numrow, 'rnf_b' , rnf )
	210	CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem) )
	211	CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal) )
	212	ENDIF
[5407]	213	!
[4990]	214	CALL wrk_dealloc( jpi,jpj, ztfrz)
[2528]	215	!
	216	END SUBROUTINE sbc_rnf
	217
	218
	219	SUBROUTINE sbc_rnf_div( phdivn )
	220	!!----------------------------------------------------------------------
	221	!! * ROUTINE sbc_rnf *
[3764]	222	!!
[2528]	223	!! ** Purpose : update the horizontal divergence with the runoff inflow
	224	!!
[3764]	225	!! ** Method :
	226	!! CAUTION : rnf is positive (inflow) decreasing the
[2528]	227	!! divergence and expressed in m/s
	228	!!
	229	!! ** Action : phdivn decreased by the runoff inflow
	230	!!----------------------------------------------------------------------
[2715]	231	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: phdivn ! horizontal divergence
[2528]	232	!!
[7698]	233	INTEGER :: ji, jj, jk, jn ! dummy loop indices
[2528]	234	REAL(wp) :: zfact ! local scalar
	235	!!----------------------------------------------------------------------
	236	!
	237	zfact = 0.5_wp
	238	!
[5503]	239	IF( ln_rnf_depth .OR. ln_rnf_depth_ini ) THEN !== runoff distributed over several levels ==!
[6140]	240	IF( ln_linssh ) THEN !* constant volume case : just apply the runoff input flow
[7698]	241	!$OMP PARALLEL DO schedule(static) private(jj,ji,jk)
[6140]	242	DO jj = 1, jpj
[2528]	243	DO ji = 1, jpi
	244	DO jk = 1, nk_rnf(ji,jj)
	245	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	246	END DO
	247	END DO
	248	END DO
[6140]	249	ELSE !* variable volume case
[7698]	250	!$OMP PARALLEL DO schedule(static) private(jj,ji,jk)
[6140]	251	DO jj = 1, jpj ! update the depth over which runoffs are distributed
[888]	252	DO ji = 1, jpi
[6140]	253	h_rnf(ji,jj) = 0._wp
	254	DO jk = 1, nk_rnf(ji,jj) ! recalculates h_rnf to be the depth in metres
	255	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk) ! to the bottom of the relevant grid box
	256	END DO
	257	! ! apply the runoff input flow
[2528]	258	DO jk = 1, nk_rnf(ji,jj)
	259	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	260	END DO
[888]	261	END DO
	262	END DO
	263	ENDIF
[2528]	264	ELSE !== runoff put only at the surface ==!
[7698]	265	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	266	DO jj = 1, jpj
	267	DO ji = 1, jpi
	268	h_rnf (ji,jj) = e3t_n (ji,jj,1) ! update h_rnf to be depth of top box
	269	phdivn(ji,jj,1) = phdivn(ji,jj,1) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / e3t_n(ji,jj,1)
	270	END DO
	271	END DO
[888]	272	ENDIF
	273	!
[2528]	274	END SUBROUTINE sbc_rnf_div
[888]	275
	276
[2528]	277	SUBROUTINE sbc_rnf_init
[1116]	278	!!----------------------------------------------------------------------
	279	!! * ROUTINE sbc_rnf_init *
	280	!!
	281	!! ** Purpose : Initialisation of the runoffs if (ln_rnf=T)
	282	!!
	283	!! ** Method : - read the runoff namsbc_rnf namelist
	284	!!
	285	!! ** Action : - read parameters
	286	!!----------------------------------------------------------------------
[3764]	287	CHARACTER(len=32) :: rn_dep_file ! runoff file name
[7698]	288	INTEGER :: ji, jj, jk, jm, jn ! dummy loop indices
[2528]	289	INTEGER :: ierror, inum ! temporary integer
[4147]	290	INTEGER :: ios ! Local integer output status for namelist read
[5385]	291	INTEGER :: nbrec ! temporary integer
	292	REAL(wp) :: zacoef
	293	REAL(wp), DIMENSION(12) :: zrec ! times records
	294	REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: zrnfcl
	295	REAL(wp), DIMENSION(:,: ), ALLOCATABLE :: zrnf
[3625]	296	!
[5407]	297	NAMELIST/namsbc_rnf/ cn_dir , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal, &
[3764]	298	& sn_rnf, sn_cnf , sn_s_rnf , sn_t_rnf , sn_dep_rnf, &
[5385]	299	& ln_rnf_mouth , rn_hrnf , rn_avt_rnf, rn_rfact, &
	300	& ln_rnf_depth_ini , rn_dep_max , rn_rnf_max, nn_rnf_depth_file
[1116]	301	!!----------------------------------------------------------------------
[3625]	302	!
[5431]	303	! !== allocate runoff arrays
	304	IF( sbc_rnf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
	305	!
	306	IF( .NOT. ln_rnf ) THEN ! no specific treatment in vicinity of river mouths
	307	ln_rnf_mouth = .FALSE. ! default definition needed for example by sbc_ssr or by tra_adv_muscl
	308	nkrnf = 0
[7698]	309	!$OMP PARALLEL
	310	!$OMP DO schedule(static) private(jj, ji)
	311	DO jj = 1, jpj
	312	DO ji = 1, jpi
	313	rnf (ji,jj) = 0.0_wp
	314	rnf_b (ji,jj) = 0.0_wp
	315	rnfmsk (ji,jj) = 0.0_wp
	316	END DO
	317	END DO
	318	!$OMP END DO NOWAIT
	319	!$OMP DO schedule(static) private(jk)
	320	DO jk = 1, jpk
	321	rnfmsk_z(jk) = 0.0_wp
	322	END DO
	323	!$OMP END PARALLEL
[5431]	324	RETURN
	325	ENDIF
	326	!
[1116]	327	! ! ============
	328	! ! Namelist
	329	! ! ============
[4147]	330	!
	331	REWIND( numnam_ref ) ! Namelist namsbc_rnf in reference namelist : Runoffs
	332	READ ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
	333	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist', lwp )
[1116]	334
[4147]	335	REWIND( numnam_cfg ) ! Namelist namsbc_rnf in configuration namelist : Runoffs
	336	READ ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
	337	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist', lwp )
[4624]	338	IF(lwm) WRITE ( numond, namsbc_rnf )
[1116]	339	!
	340	! ! Control print
	341	IF(lwp) THEN
	342	WRITE(numout,*)
[7646]	343	WRITE(numout,*) 'sbc_rnf_init : runoff '
	344	WRITE(numout,*) '~~~~~~~~~~~~ '
[1116]	345	WRITE(numout,*) ' Namelist namsbc_rnf'
	346	WRITE(numout,*) ' specific river mouths treatment ln_rnf_mouth = ', ln_rnf_mouth
	347	WRITE(numout,*) ' river mouth additional Kz rn_avt_rnf = ', rn_avt_rnf
	348	WRITE(numout,*) ' depth of river mouth additional mixing rn_hrnf = ', rn_hrnf
[3764]	349	WRITE(numout,*) ' multiplicative factor for runoff rn_rfact = ', rn_rfact
[1116]	350	ENDIF
	351	! ! ==================
	352	! ! Type of runoff
	353	! ! ==================
	354	!
[5407]	355	IF( .NOT. l_rnfcpl ) THEN
[2528]	356	ALLOCATE( sf_rnf(1), STAT=ierror ) ! Create sf_rnf structure (runoff inflow)
	357	IF(lwp) WRITE(numout,*)
	358	IF(lwp) WRITE(numout,*) ' runoffs inflow read in a file'
	359	IF( ierror > 0 ) THEN
[7646]	360	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_rnf structure' ) ; RETURN
[2528]	361	ENDIF
	362	ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1) )
	363	IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	364	CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf', no_print )
[5407]	365	ENDIF
	366	!
	367	IF( ln_rnf_tem ) THEN ! Create (if required) sf_t_rnf structure
	368	IF(lwp) WRITE(numout,*)
	369	IF(lwp) WRITE(numout,*) ' runoffs temperatures read in a file'
	370	ALLOCATE( sf_t_rnf(1), STAT=ierror )
	371	IF( ierror > 0 ) THEN
	372	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' ) ; RETURN
[2528]	373	ENDIF
[5407]	374	ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1) )
	375	IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	376	CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf', no_print )
[5407]	377	ENDIF
	378	!
	379	IF( ln_rnf_sal ) THEN ! Create (if required) sf_s_rnf and sf_t_rnf structures
	380	IF(lwp) WRITE(numout,*)
	381	IF(lwp) WRITE(numout,*) ' runoffs salinities read in a file'
	382	ALLOCATE( sf_s_rnf(1), STAT=ierror )
	383	IF( ierror > 0 ) THEN
	384	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' ) ; RETURN
[2528]	385	ENDIF
[5407]	386	ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1) )
	387	IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	388	CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf', no_print )
[5407]	389	ENDIF
	390	!
	391	IF( ln_rnf_depth ) THEN ! depth of runoffs set from a file
	392	IF(lwp) WRITE(numout,*)
	393	IF(lwp) WRITE(numout,*) ' runoffs depth read in a file'
	394	rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
	395	IF( .NOT. sn_dep_rnf%ln_clim ) THEN ; WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear ! add year
	396	IF( sn_dep_rnf%cltype == 'monthly' ) WRITE(rn_dep_file, '(a,"m",i2)' ) TRIM( rn_dep_file ), nmonth ! add month
	397	ENDIF
	398	CALL iom_open ( rn_dep_file, inum ) ! open file
	399	CALL iom_get ( inum, jpdom_data, sn_dep_rnf%clvar, h_rnf ) ! read the river mouth array
	400	CALL iom_close( inum ) ! close file
[2528]	401	!
[7698]	402	!$OMP PARALLEL
	403	!$OMP DO schedule(static) private(jj, ji)
[5407]	404	DO jj = 1, jpj
	405	DO ji = 1, jpi
[7698]	406	nk_rnf(ji,jj) = 0 ! set the number of level over which river runoffs are applied
	407	END DO
	408	END DO
	409	!$OMP DO schedule(static) private(jj, ji, jk)
	410	DO jj = 1, jpj
	411	DO ji = 1, jpi
[5407]	412	IF( h_rnf(ji,jj) > 0._wp ) THEN
	413	jk = 2
	414	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
	415	END DO
	416	nk_rnf(ji,jj) = jk
	417	ELSEIF( h_rnf(ji,jj) == -1._wp ) THEN ; nk_rnf(ji,jj) = 1
	418	ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN ; nk_rnf(ji,jj) = mbkt(ji,jj)
	419	ELSE
	420	CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999' )
	421	WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
	422	ENDIF
[3764]	423	END DO
[5407]	424	END DO
[7698]	425	!$OMP DO schedule(static) private(jj, ji, jk)
[5407]	426	DO jj = 1, jpj ! set the associated depth
	427	DO ji = 1, jpi
	428	h_rnf(ji,jj) = 0._wp
	429	DO jk = 1, nk_rnf(ji,jj)
[6140]	430	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
[2528]	431	END DO
	432	END DO
[5407]	433	END DO
[7698]	434	!$OMP END PARALLEL
[5407]	435	!
	436	ELSE IF( ln_rnf_depth_ini ) THEN ! runoffs applied at the surface
	437	!
	438	IF(lwp) WRITE(numout,*)
	439	IF(lwp) WRITE(numout,*) ' depth of runoff computed once from max value of runoff'
	440	IF(lwp) WRITE(numout,*) ' max value of the runoff climatologie (over global domain) rn_rnf_max = ', rn_rnf_max
	441	IF(lwp) WRITE(numout,*) ' depth over which runoffs is spread rn_dep_max = ', rn_dep_max
	442	IF(lwp) WRITE(numout,*) ' create (=1) a runoff depth file or not (=0) nn_rnf_depth_file = ', nn_rnf_depth_file
[5385]	443
[5407]	444	CALL iom_open( TRIM( sn_rnf%clname ), inum ) ! open runoff file
	445	CALL iom_gettime( inum, zrec, kntime=nbrec)
	446	ALLOCATE( zrnfcl(jpi,jpj,nbrec) ) ; ALLOCATE( zrnf(jpi,jpj) )
	447	DO jm = 1, nbrec
	448	CALL iom_get( inum, jpdom_data, TRIM( sn_rnf%clvar ), zrnfcl(:,:,jm), jm )
	449	END DO
	450	CALL iom_close( inum )
	451	zrnf(:,:) = MAXVAL( zrnfcl(:,:,:), DIM=3 ) ! maximum value in time
	452	DEALLOCATE( zrnfcl )
	453	!
	454	zacoef = rn_dep_max / rn_rnf_max ! coef of linear relation between runoff and its depth (150m for max of runoff)
	455	!
[7698]	456	!$OMP PARALLEL
	457	IF( zrnf(ji,jj) > 0._wp ) THEN
	458	!$OMP DO schedule(static) private(jj, ji)
	459	DO jj = 1, jpj
	460	DO ji = 1, jpi
	461	h_rnf(ji,jj) = zacoef * zrnf(ji,jj) ! compute depth for all runoffs
	462	END DO
	463	END DO
	464	END IF
[5407]	465	!
[7698]	466	!$OMP DO schedule(static) private(jj, ji, jk)
[5407]	467	DO jj = 1, jpj ! take in account min depth of ocean rn_hmin
	468	DO ji = 1, jpi
	469	IF( zrnf(ji,jj) > 0._wp ) THEN
	470	jk = mbkt(ji,jj)
	471	h_rnf(ji,jj) = MIN( h_rnf(ji,jj), gdept_0(ji,jj,jk ) )
	472	ENDIF
[5385]	473	END DO
[5407]	474	END DO
	475	!
[7698]	476	!$OMP DO schedule(static) private(jj, ji)
[5407]	477	DO jj = 1, jpj
	478	DO ji = 1, jpi
[7698]	479	nk_rnf(ji,jj) = 0 ! number of levels on which runoffs are distributed
	480	END DO
	481	END DO
	482	!$OMP DO schedule(static) private(jj, ji, jk)
	483	DO jj = 1, jpj
	484	DO ji = 1, jpi
[5407]	485	IF( zrnf(ji,jj) > 0._wp ) THEN
	486	jk = 2
	487	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
	488	END DO
	489	nk_rnf(ji,jj) = jk
	490	ELSE
	491	nk_rnf(ji,jj) = 1
	492	ENDIF
[5385]	493	END DO
[5407]	494	END DO
[7698]	495	!$OMP END PARALLEL
[5407]	496	!
	497	DEALLOCATE( zrnf )
	498	!
[7698]	499	!$OMP PARALLEL DO schedule(static) private(jj, ji, jk)
[5407]	500	DO jj = 1, jpj ! set the associated depth
	501	DO ji = 1, jpi
	502	h_rnf(ji,jj) = 0._wp
	503	DO jk = 1, nk_rnf(ji,jj)
[6140]	504	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
[5385]	505	END DO
	506	END DO
[5407]	507	END DO
	508	!
	509	IF( nn_rnf_depth_file == 1 ) THEN ! save output nb levels for runoff
	510	IF(lwp) WRITE(numout,*) ' create runoff depht file'
	511	CALL iom_open ( TRIM( sn_dep_rnf%clname ), inum, ldwrt = .TRUE., kiolib = jprstlib )
	512	CALL iom_rstput( 0, 0, inum, 'rodepth', h_rnf )
	513	CALL iom_close ( inum )
[3764]	514	ENDIF
[5407]	515	ELSE ! runoffs applied at the surface
[7698]	516	!$OMP PARALLEL DO schedule(static) private(jj, ji)
	517	DO jj = 1, jpj
	518	DO ji = 1, jpi
	519	nk_rnf(ji,jj) = 1
	520	h_rnf (ji,jj) = e3t_n(ji,jj,1)
	521	END DO
	522	END DO
[1116]	523	ENDIF
[2528]	524	!
[7698]	525	!$OMP PARALLEL
	526	!$OMP DO schedule(static) private(jj, ji)
	527	DO jj = 1, jpj
	528	DO ji = 1, jpi
	529	rnf(ji,jj) = 0._wp ! runoff initialisation
	530	END DO
	531	END DO
	532	!$OMP END DO NOWAIT
	533	DO jn = 1, jpts
	534	!$OMP DO schedule(static) private(jj, ji)
	535	DO jj = 1, jpj
	536	DO ji = 1, jpi
	537	rnf_tsc(ji,jj,jn) = 0._wp ! runoffs temperature & salinty contents initilisation
	538	END DO
	539	END DO
	540	END DO
	541	!$OMP END PARALLEL
[2528]	542	!
[1116]	543	! ! ========================
	544	! ! River mouth vicinity
	545	! ! ========================
	546	!
	547	IF( ln_rnf_mouth ) THEN ! Specific treatment in vicinity of river mouths :
	548	! ! - Increase Kz in surface layers ( rn_hrnf > 0 )
	549	! ! - set to zero SSS damping (ln_ssr=T)
	550	! ! - mixed upstream-centered (ln_traadv_cen2=T)
	551	!
[2528]	552	IF ( ln_rnf_depth ) CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already', &
[3764]	553	& 'be spread through depth by ln_rnf_depth' )
[2528]	554	!
	555	nkrnf = 0 ! Number of level over which Kz increase
	556	IF( rn_hrnf > 0._wp ) THEN
[1116]	557	nkrnf = 2
[5407]	558	DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf ) ; nkrnf = nkrnf + 1
	559	END DO
[7646]	560	IF( ln_sco ) CALL ctl_warn( 'sbc_rnf_init: number of levels over which Kz is increased is computed for zco...' )
[1116]	561	ENDIF
	562	IF(lwp) WRITE(numout,*)
	563	IF(lwp) WRITE(numout,*) ' Specific treatment used in vicinity of river mouths :'
	564	IF(lwp) WRITE(numout,*) ' - Increase Kz in surface layers (if rn_hrnf > 0 )'
	565	IF(lwp) WRITE(numout,*) ' by ', rn_avt_rnf,' m2/s over ', nkrnf, ' w-levels'
	566	IF(lwp) WRITE(numout,*) ' - set to zero SSS damping (if ln_ssr=T)'
	567	IF(lwp) WRITE(numout,*) ' - mixed upstream-centered (if ln_traadv_cen2=T)'
	568	!
	569	CALL rnf_mouth ! set river mouth mask
	570	!
	571	ELSE ! No treatment at river mouths
	572	IF(lwp) WRITE(numout,*)
	573	IF(lwp) WRITE(numout,*) ' No specific treatment at river mouths'
[7698]	574	!$OMP PARALLEL
	575	!$OMP DO schedule(static) private(jj, ji)
	576	DO jj = 1, jpj
	577	DO ji = 1, jpi
	578	rnfmsk (ji,jj) = 0._wp
	579	END DO
	580	END DO
	581	!$OMP END DO NOWAIT
	582	!$OMP DO schedule(static) private(jk)
	583	DO jk = 1, jpk
	584	rnfmsk_z(jk) = 0._wp
	585	END DO
	586	!$OMP END PARALLEL
[1116]	587	nkrnf = 0
	588	ENDIF
[3625]	589	!
[1116]	590	END SUBROUTINE sbc_rnf_init
	591
	592
[888]	593	SUBROUTINE rnf_mouth
	594	!!----------------------------------------------------------------------
	595	!! * ROUTINE rnf_mouth *
[3764]	596	!!
[888]	597	!! ** Purpose : define the river mouths mask
	598	!!
	599	!! ** Method : read the river mouth mask (=0/1) in the river runoff
[3764]	600	!! climatological file. Defined a given vertical structure.
	601	!! CAUTION, the vertical structure is hard coded on the
[888]	602	!! first 5 levels.
	603	!! This fields can be used to:
[3764]	604	!! - set an upstream advection scheme
[1116]	605	!! (ln_rnf_mouth=T and ln_traadv_cen2=T)
[3764]	606	!! - increase vertical on the top nn_krnf vertical levels
[888]	607	!! at river runoff input grid point (nn_krnf>=2, see step.F90)
	608	!! - set to zero SSS restoring flux at river mouth grid points
	609	!!
	610	!! ** Action : rnfmsk set to 1 at river runoff input, 0 elsewhere
	611	!! rnfmsk_z vertical structure
	612	!!----------------------------------------------------------------------
[2784]	613	INTEGER :: inum ! temporary integers
	614	CHARACTER(len=140) :: cl_rnfile ! runoff file name
[888]	615	!!----------------------------------------------------------------------
[3764]	616	!
[888]	617	IF(lwp) WRITE(numout,*)
[7646]	618	IF(lwp) WRITE(numout,*) ' rnf_mouth : river mouth mask'
	619	IF(lwp) WRITE(numout,*) ' ~~~~~~~~~ '
[3625]	620	!
[1133]	621	cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
	622	IF( .NOT. sn_cnf%ln_clim ) THEN ; WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear ! add year
	623	IF( sn_cnf%cltype == 'monthly' ) WRITE(cl_rnfile, '(a,"m",i2)' ) TRIM( cl_rnfile ), nmonth ! add month
	624	ENDIF
[3625]	625	!
[888]	626	! horizontal mask (read in NetCDF file)
	627	CALL iom_open ( cl_rnfile, inum ) ! open file
	628	CALL iom_get ( inum, jpdom_data, sn_cnf%clvar, rnfmsk ) ! read the river mouth array
	629	CALL iom_close( inum ) ! close file
[3625]	630	!
[3632]	631	IF( nn_closea == 1 ) CALL clo_rnf( rnfmsk ) ! closed sea inflow set as ruver mouth
[3625]	632	!
[3764]	633	rnfmsk_z(:) = 0._wp ! vertical structure
[888]	634	rnfmsk_z(1) = 1.0
	635	rnfmsk_z(2) = 1.0 ! **********
	636	rnfmsk_z(3) = 0.5 ! HARD CODED on the 5 first levels
	637	rnfmsk_z(4) = 0.25 ! **********
	638	rnfmsk_z(5) = 0.125
[3764]	639	!
[888]	640	END SUBROUTINE rnf_mouth
[3764]	641
[888]	642	!!======================================================================
	643	END MODULE sbcrnf

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

Download in other formats: