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 NEMO/branches/2019/dev_r10984_HPC-13_IRRMANN_BDY_optimization/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r10984_HPC-13_IRRMANN_BDY_optimization/src/OCE/SBC/sbcrnf.F90 @ 11317

Last change on this file since 11317 was 11317, checked in by smasson, 5 years ago
dev_r10984_HPC-13 : improve error handling, see #2307 and #2285
Property svn:keywords set to `Id`
File size: 29.3 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
[9161]	23	USE 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
[888]	29
	30	IMPLICIT NONE
	31	PRIVATE
	32
[6140]	33	PUBLIC sbc_rnf ! called in sbcmod module
	34	PUBLIC sbc_rnf_div ! called in divhor module
	35	PUBLIC sbc_rnf_alloc ! called in sbcmod module
	36	PUBLIC sbc_rnf_init ! called in sbcmod module
[5836]	37
[6140]	38	! !!* namsbc_rnf namelist *
	39	CHARACTER(len=100) :: cn_dir !: Root directory for location of rnf files
[9023]	40	LOGICAL , PUBLIC :: ln_rnf_depth !: depth river runoffs attribute specified in a file
[6140]	41	LOGICAL :: ln_rnf_depth_ini !: depth river runoffs computed at the initialisation
	42	REAL(wp) :: rn_rnf_max !: maximum value of the runoff climatologie (ln_rnf_depth_ini =T)
	43	REAL(wp) :: rn_dep_max !: depth over which runoffs is spread (ln_rnf_depth_ini =T)
	44	INTEGER :: nn_rnf_depth_file !: create (=1) a runoff depth file or not (=0)
	45	LOGICAL :: ln_rnf_tem !: temperature river runoffs attribute specified in a file
	46	LOGICAL , PUBLIC :: ln_rnf_sal !: salinity river runoffs attribute specified in a file
	47	TYPE(FLD_N) , PUBLIC :: sn_rnf !: information about the runoff file to be read
	48	TYPE(FLD_N) :: sn_cnf !: information about the runoff mouth file to be read
	49	TYPE(FLD_N) :: sn_s_rnf !: information about the salinities of runoff file to be read
	50	TYPE(FLD_N) :: sn_t_rnf !: information about the temperatures of runoff file to be read
	51	TYPE(FLD_N) :: sn_dep_rnf !: information about the depth which river inflow affects
	52	LOGICAL , PUBLIC :: ln_rnf_mouth !: specific treatment in mouths vicinity
	53	REAL(wp) :: rn_hrnf !: runoffs, depth over which enhanced vertical mixing is used
	54	REAL(wp) , PUBLIC :: rn_avt_rnf !: runoffs, value of the additional vertical mixing coef. [m2/s]
	55	REAL(wp) , PUBLIC :: rn_rfact !: multiplicative factor for runoff
[888]	56
[6140]	57	LOGICAL , PUBLIC :: l_rnfcpl = .false. !: runoffs recieved from oasis
	58	INTEGER , PUBLIC :: nkrnf = 0 !: nb of levels over which Kz is increased at river mouths
	59
[2715]	60	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnfmsk !: river mouth mask (hori.)
	61	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: rnfmsk_z !: river mouth mask (vert.)
	62	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: h_rnf !: depth of runoff in m
	63	INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: nk_rnf !: depth of runoff in model levels
[3764]	64	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]	65
[5431]	66	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_rnf ! structure: river runoff (file information, fields read)
	67	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_s_rnf ! structure: river runoff salinity (file information, fields read)
	68	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_t_rnf ! structure: river runoff temperature (file information, fields read)
[2528]	69
[888]	70	!!----------------------------------------------------------------------
[9598]	71	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1146]	72	!! $Id$
[10068]	73	!! Software governed by the CeCILL license (see ./LICENSE)
[888]	74	!!----------------------------------------------------------------------
	75	CONTAINS
	76
[2715]	77	INTEGER FUNCTION sbc_rnf_alloc()
	78	!!----------------------------------------------------------------------
	79	!! * ROUTINE sbc_rnf_alloc *
	80	!!----------------------------------------------------------------------
	81	ALLOCATE( rnfmsk(jpi,jpj) , rnfmsk_z(jpk) , &
	82	& h_rnf (jpi,jpj) , nk_rnf (jpi,jpj) , &
	83	& rnf_tsc_b(jpi,jpj,jpts) , rnf_tsc (jpi,jpj,jpts) , STAT=sbc_rnf_alloc )
	84	!
[10425]	85	CALL mpp_sum ( 'sbcrnf', sbc_rnf_alloc )
[2715]	86	IF( sbc_rnf_alloc > 0 ) CALL ctl_warn('sbc_rnf_alloc: allocation of arrays failed')
	87	END FUNCTION sbc_rnf_alloc
	88
[3625]	89
[888]	90	SUBROUTINE sbc_rnf( kt )
	91	!!----------------------------------------------------------------------
	92	!! * ROUTINE sbc_rnf *
[3764]	93	!!
[888]	94	!! ** Purpose : Introduce a climatological run off forcing
	95	!!
[3764]	96	!! ** Method : Set each river mouth with a monthly climatology
[888]	97	!! provided from different data.
	98	!! CAUTION : upward water flux, runoff forced to be < 0
	99	!!
	100	!! ** Action : runoff updated runoff field at time-step kt
	101	!!----------------------------------------------------------------------
	102	INTEGER, INTENT(in) :: kt ! ocean time step
[3625]	103	!
[7753]	104	INTEGER :: ji, jj ! dummy loop indices
	105	INTEGER :: z_err = 0 ! dummy integer for error handling
[888]	106	!!----------------------------------------------------------------------
[9125]	107	REAL(wp), DIMENSION(jpi,jpj) :: ztfrz ! freezing point used for temperature correction
[3764]	108	!
[6460]	109	!
[5407]	110	! !-------------------!
	111	! ! Update runoff !
	112	! !-------------------!
	113	!
	114	IF( .NOT. l_rnfcpl ) CALL fld_read ( kt, nn_fsbc, sf_rnf ) ! Read Runoffs data and provide it at kt
	115	IF( ln_rnf_tem ) CALL fld_read ( kt, nn_fsbc, sf_t_rnf ) ! idem for runoffs temperature if required
	116	IF( ln_rnf_sal ) CALL fld_read ( kt, nn_fsbc, sf_s_rnf ) ! idem for runoffs salinity if required
	117	!
	118	IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
[888]	119	!
[9727]	120	IF( .NOT. l_rnfcpl ) rnf(:,:) = rn_rfact * ( sf_rnf(1)%fnow(:,:,1) ) * tmask(:,:,1) ! updated runoff value at time step kt
[2528]	121	!
[9023]	122	! ! set temperature & salinity content of runoffs
[5407]	123	IF( ln_rnf_tem ) THEN ! use runoffs temperature data
[7753]	124	rnf_tsc(:,:,jp_tem) = ( sf_t_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
[6140]	125	CALL eos_fzp( sss_m(:,:), ztfrz(:,:) )
[7753]	126	WHERE( sf_t_rnf(1)%fnow(:,:,1) == -999._wp ) ! if missing data value use SST as runoffs temperature
	127	rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
	128	END WHERE
	129	WHERE( sf_t_rnf(1)%fnow(:,:,1) == -222._wp ) ! where fwf comes from melting of ice shelves or iceberg
[9935]	130	rnf_tsc(:,:,jp_tem) = ztfrz(:,:) * rnf(:,:) * r1_rau0 - rnf(:,:) * rLfusisf * r1_rau0_rcp
[7753]	131	END WHERE
[5407]	132	ELSE ! use SST as runoffs temperature
[9023]	133	!CEOD River is fresh water so must at least be 0 unless we consider ice
	134	rnf_tsc(:,:,jp_tem) = MAX(sst_m(:,:),0.0_wp) * rnf(:,:) * r1_rau0
[7753]	135	ENDIF
[5407]	136	! ! use runoffs salinity data
[7753]	137	IF( ln_rnf_sal ) rnf_tsc(:,:,jp_sal) = ( sf_s_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
	138	! ! else use S=0 for runoffs (done one for all in the init)
[7968]	139	IF( iom_use('runoffs') ) CALL iom_put( 'runoffs' , rnf(:,:) ) ! output runoff mass flux
	140	IF( iom_use('hflx_rnf_cea') ) CALL iom_put( 'hflx_rnf_cea', rnf_tsc(:,:,jp_tem) * rau0 * rcp ) ! output runoff sensible heat (W/m2)
[2528]	141	ENDIF
	142	!
[5407]	143	! ! ---------------------------------------- !
[2528]	144	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	145	! ! ---------------------------------------- !
	146	IF( ln_rstart .AND. & !* Restart: read in restart file
[3764]	147	& iom_varid( numror, 'rnf_b', ldstop = .FALSE. ) > 0 ) THEN
[9367]	148	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields red in the restart file', lrxios
	149	CALL iom_get( numror, jpdom_autoglo, 'rnf_b', rnf_b, ldxios = lrxios ) ! before runoff
	150	CALL iom_get( numror, jpdom_autoglo, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem), ldxios = lrxios ) ! before heat content of runoff
	151	CALL iom_get( numror, jpdom_autoglo, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal), ldxios = lrxios ) ! before salinity content of runoff
[2528]	152	ELSE !* no restart: set from nit000 values
	153	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields set to nit000'
[7753]	154	rnf_b (:,: ) = rnf (:,: )
	155	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[2528]	156	ENDIF
	157	ENDIF
	158	! ! ---------------------------------------- !
	159	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	160	! ! ---------------------------------------- !
	161	IF(lwp) WRITE(numout,*)
	162	IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ', &
	163	& 'at it= ', kt,' date= ', ndastp
	164	IF(lwp) WRITE(numout,*) '~~~~'
[9367]	165	IF( lwxios ) CALL iom_swap( cwxios_context )
	166	CALL iom_rstput( kt, nitrst, numrow, 'rnf_b' , rnf, ldxios = lwxios )
	167	CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem), ldxios = lwxios )
	168	CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal), ldxios = lwxios )
	169	IF( lwxios ) CALL iom_swap( cxios_context )
[2528]	170	ENDIF
[5407]	171	!
[2528]	172	END SUBROUTINE sbc_rnf
	173
	174
	175	SUBROUTINE sbc_rnf_div( phdivn )
	176	!!----------------------------------------------------------------------
	177	!! * ROUTINE sbc_rnf *
[3764]	178	!!
[2528]	179	!! ** Purpose : update the horizontal divergence with the runoff inflow
	180	!!
[3764]	181	!! ** Method :
	182	!! CAUTION : rnf is positive (inflow) decreasing the
[2528]	183	!! divergence and expressed in m/s
	184	!!
	185	!! ** Action : phdivn decreased by the runoff inflow
	186	!!----------------------------------------------------------------------
[2715]	187	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: phdivn ! horizontal divergence
[2528]	188	!!
[7753]	189	INTEGER :: ji, jj, jk ! dummy loop indices
[2528]	190	REAL(wp) :: zfact ! local scalar
	191	!!----------------------------------------------------------------------
	192	!
	193	zfact = 0.5_wp
	194	!
[5503]	195	IF( ln_rnf_depth .OR. ln_rnf_depth_ini ) THEN !== runoff distributed over several levels ==!
[6140]	196	IF( ln_linssh ) THEN !* constant volume case : just apply the runoff input flow
	197	DO jj = 1, jpj
[2528]	198	DO ji = 1, jpi
	199	DO jk = 1, nk_rnf(ji,jj)
	200	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	201	END DO
	202	END DO
	203	END DO
[6140]	204	ELSE !* variable volume case
	205	DO jj = 1, jpj ! update the depth over which runoffs are distributed
[888]	206	DO ji = 1, jpi
[6140]	207	h_rnf(ji,jj) = 0._wp
	208	DO jk = 1, nk_rnf(ji,jj) ! recalculates h_rnf to be the depth in metres
	209	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk) ! to the bottom of the relevant grid box
	210	END DO
	211	! ! apply the runoff input flow
[2528]	212	DO jk = 1, nk_rnf(ji,jj)
	213	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	214	END DO
[888]	215	END DO
	216	END DO
	217	ENDIF
[2528]	218	ELSE !== runoff put only at the surface ==!
[7753]	219	h_rnf (:,:) = e3t_n (:,:,1) ! update h_rnf to be depth of top box
	220	phdivn(:,:,1) = phdivn(:,:,1) - ( rnf(:,:) + rnf_b(:,:) ) * zfact * r1_rau0 / e3t_n(:,:,1)
[888]	221	ENDIF
	222	!
[2528]	223	END SUBROUTINE sbc_rnf_div
[888]	224
	225
[2528]	226	SUBROUTINE sbc_rnf_init
[1116]	227	!!----------------------------------------------------------------------
	228	!! * ROUTINE sbc_rnf_init *
	229	!!
	230	!! ** Purpose : Initialisation of the runoffs if (ln_rnf=T)
	231	!!
	232	!! ** Method : - read the runoff namsbc_rnf namelist
	233	!!
	234	!! ** Action : - read parameters
	235	!!----------------------------------------------------------------------
[3764]	236	CHARACTER(len=32) :: rn_dep_file ! runoff file name
[7753]	237	INTEGER :: ji, jj, jk, jm ! dummy loop indices
[2528]	238	INTEGER :: ierror, inum ! temporary integer
[4147]	239	INTEGER :: ios ! Local integer output status for namelist read
[5385]	240	INTEGER :: nbrec ! temporary integer
	241	REAL(wp) :: zacoef
[10523]	242	REAL(wp), DIMENSION(jpi,jpj,2) :: zrnfcl
[9169]	243	!!
[5407]	244	NAMELIST/namsbc_rnf/ cn_dir , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal, &
[3764]	245	& sn_rnf, sn_cnf , sn_s_rnf , sn_t_rnf , sn_dep_rnf, &
[5385]	246	& ln_rnf_mouth , rn_hrnf , rn_avt_rnf, rn_rfact, &
	247	& ln_rnf_depth_ini , rn_dep_max , rn_rnf_max, nn_rnf_depth_file
[1116]	248	!!----------------------------------------------------------------------
[3625]	249	!
[5431]	250	! !== allocate runoff arrays
	251	IF( sbc_rnf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
	252	!
	253	IF( .NOT. ln_rnf ) THEN ! no specific treatment in vicinity of river mouths
	254	ln_rnf_mouth = .FALSE. ! default definition needed for example by sbc_ssr or by tra_adv_muscl
	255	nkrnf = 0
[7753]	256	rnf (:,:) = 0.0_wp
	257	rnf_b (:,:) = 0.0_wp
	258	rnfmsk (:,:) = 0.0_wp
	259	rnfmsk_z(:) = 0.0_wp
[5431]	260	RETURN
	261	ENDIF
	262	!
[1116]	263	! ! ============
	264	! ! Namelist
	265	! ! ============
[4147]	266	!
	267	REWIND( numnam_ref ) ! Namelist namsbc_rnf in reference namelist : Runoffs
	268	READ ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
[11317]	269	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist' )
[1116]	270
[4147]	271	REWIND( numnam_cfg ) ! Namelist namsbc_rnf in configuration namelist : Runoffs
	272	READ ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
[11317]	273	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist' )
[4624]	274	IF(lwm) WRITE ( numond, namsbc_rnf )
[1116]	275	!
	276	! ! Control print
	277	IF(lwp) THEN
	278	WRITE(numout,*)
[7646]	279	WRITE(numout,*) 'sbc_rnf_init : runoff '
	280	WRITE(numout,*) '~~~~~~~~~~~~ '
[1116]	281	WRITE(numout,*) ' Namelist namsbc_rnf'
	282	WRITE(numout,*) ' specific river mouths treatment ln_rnf_mouth = ', ln_rnf_mouth
	283	WRITE(numout,*) ' river mouth additional Kz rn_avt_rnf = ', rn_avt_rnf
	284	WRITE(numout,*) ' depth of river mouth additional mixing rn_hrnf = ', rn_hrnf
[3764]	285	WRITE(numout,*) ' multiplicative factor for runoff rn_rfact = ', rn_rfact
[1116]	286	ENDIF
	287	! ! ==================
	288	! ! Type of runoff
	289	! ! ==================
	290	!
[5407]	291	IF( .NOT. l_rnfcpl ) THEN
[2528]	292	ALLOCATE( sf_rnf(1), STAT=ierror ) ! Create sf_rnf structure (runoff inflow)
	293	IF(lwp) WRITE(numout,*)
[9169]	294	IF(lwp) WRITE(numout,*) ' ==>>> runoffs inflow read in a file'
[2528]	295	IF( ierror > 0 ) THEN
[7646]	296	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_rnf structure' ) ; RETURN
[2528]	297	ENDIF
	298	ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1) )
	299	IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	300	CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf', no_print )
[5407]	301	ENDIF
	302	!
	303	IF( ln_rnf_tem ) THEN ! Create (if required) sf_t_rnf structure
	304	IF(lwp) WRITE(numout,*)
[9169]	305	IF(lwp) WRITE(numout,*) ' ==>>> runoffs temperatures read in a file'
[5407]	306	ALLOCATE( sf_t_rnf(1), STAT=ierror )
	307	IF( ierror > 0 ) THEN
	308	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' ) ; RETURN
[2528]	309	ENDIF
[5407]	310	ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1) )
	311	IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	312	CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf', no_print )
[5407]	313	ENDIF
	314	!
	315	IF( ln_rnf_sal ) THEN ! Create (if required) sf_s_rnf and sf_t_rnf structures
	316	IF(lwp) WRITE(numout,*)
[9169]	317	IF(lwp) WRITE(numout,*) ' ==>>> runoffs salinities read in a file'
[5407]	318	ALLOCATE( sf_s_rnf(1), STAT=ierror )
	319	IF( ierror > 0 ) THEN
	320	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' ) ; RETURN
[2528]	321	ENDIF
[5407]	322	ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1) )
	323	IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]	324	CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf', no_print )
[5407]	325	ENDIF
	326	!
	327	IF( ln_rnf_depth ) THEN ! depth of runoffs set from a file
	328	IF(lwp) WRITE(numout,*)
[9169]	329	IF(lwp) WRITE(numout,*) ' ==>>> runoffs depth read in a file'
[5407]	330	rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
	331	IF( .NOT. sn_dep_rnf%ln_clim ) THEN ; WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear ! add year
	332	IF( sn_dep_rnf%cltype == 'monthly' ) WRITE(rn_dep_file, '(a,"m",i2)' ) TRIM( rn_dep_file ), nmonth ! add month
	333	ENDIF
	334	CALL iom_open ( rn_dep_file, inum ) ! open file
	335	CALL iom_get ( inum, jpdom_data, sn_dep_rnf%clvar, h_rnf ) ! read the river mouth array
	336	CALL iom_close( inum ) ! close file
[2528]	337	!
[7753]	338	nk_rnf(:,:) = 0 ! set the number of level over which river runoffs are applied
[5407]	339	DO jj = 1, jpj
	340	DO ji = 1, jpi
	341	IF( h_rnf(ji,jj) > 0._wp ) THEN
	342	jk = 2
	343	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
	344	END DO
	345	nk_rnf(ji,jj) = jk
	346	ELSEIF( h_rnf(ji,jj) == -1._wp ) THEN ; nk_rnf(ji,jj) = 1
	347	ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN ; nk_rnf(ji,jj) = mbkt(ji,jj)
	348	ELSE
	349	CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999' )
	350	WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
	351	ENDIF
[3764]	352	END DO
[5407]	353	END DO
	354	DO jj = 1, jpj ! set the associated depth
	355	DO ji = 1, jpi
	356	h_rnf(ji,jj) = 0._wp
	357	DO jk = 1, nk_rnf(ji,jj)
[6140]	358	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
[2528]	359	END DO
	360	END DO
[5407]	361	END DO
	362	!
	363	ELSE IF( ln_rnf_depth_ini ) THEN ! runoffs applied at the surface
	364	!
	365	IF(lwp) WRITE(numout,*)
[9169]	366	IF(lwp) WRITE(numout,*) ' ==>>> depth of runoff computed once from max value of runoff'
	367	IF(lwp) WRITE(numout,*) ' max value of the runoff climatologie (over global domain) rn_rnf_max = ', rn_rnf_max
	368	IF(lwp) WRITE(numout,*) ' depth over which runoffs is spread rn_dep_max = ', rn_dep_max
	369	IF(lwp) WRITE(numout,*) ' create (=1) a runoff depth file or not (=0) nn_rnf_depth_file = ', nn_rnf_depth_file
[5385]	370
[5407]	371	CALL iom_open( TRIM( sn_rnf%clname ), inum ) ! open runoff file
[10522]	372	nbrec = iom_getszuld( inum )
[10523]	373	zrnfcl(:,:,1) = 0._wp ! init the max to 0. in 1
[5407]	374	DO jm = 1, nbrec
[10523]	375	CALL iom_get( inum, jpdom_data, TRIM( sn_rnf%clvar ), zrnfcl(:,:,2), jm ) ! read the value in 2
	376	zrnfcl(:,:,1) = MAXVAL( zrnfcl(:,:,:), DIM=3 ) ! store the maximum value in time in 1
[5407]	377	END DO
	378	CALL iom_close( inum )
	379	!
[7753]	380	h_rnf(:,:) = 1.
	381	!
[5407]	382	zacoef = rn_dep_max / rn_rnf_max ! coef of linear relation between runoff and its depth (150m for max of runoff)
	383	!
[10523]	384	WHERE( zrnfcl(:,:,1) > 0._wp ) h_rnf(:,:) = zacoef * zrnfcl(:,:,1) ! compute depth for all runoffs
[5407]	385	!
	386	DO jj = 1, jpj ! take in account min depth of ocean rn_hmin
	387	DO ji = 1, jpi
[10523]	388	IF( zrnfcl(ji,jj,1) > 0._wp ) THEN
[5407]	389	jk = mbkt(ji,jj)
	390	h_rnf(ji,jj) = MIN( h_rnf(ji,jj), gdept_0(ji,jj,jk ) )
	391	ENDIF
[5385]	392	END DO
[5407]	393	END DO
	394	!
[7753]	395	nk_rnf(:,:) = 0 ! number of levels on which runoffs are distributed
[5407]	396	DO jj = 1, jpj
	397	DO ji = 1, jpi
[10523]	398	IF( zrnfcl(ji,jj,1) > 0._wp ) THEN
[5407]	399	jk = 2
	400	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
	401	END DO
	402	nk_rnf(ji,jj) = jk
	403	ELSE
	404	nk_rnf(ji,jj) = 1
	405	ENDIF
[5385]	406	END DO
[5407]	407	END DO
	408	!
	409	DO jj = 1, jpj ! set the associated depth
	410	DO ji = 1, jpi
	411	h_rnf(ji,jj) = 0._wp
	412	DO jk = 1, nk_rnf(ji,jj)
[6140]	413	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
[5385]	414	END DO
	415	END DO
[5407]	416	END DO
	417	!
	418	IF( nn_rnf_depth_file == 1 ) THEN ! save output nb levels for runoff
[9169]	419	IF(lwp) WRITE(numout,*) ' ==>>> create runoff depht file'
[10425]	420	CALL iom_open ( TRIM( sn_dep_rnf%clname ), inum, ldwrt = .TRUE. )
[5407]	421	CALL iom_rstput( 0, 0, inum, 'rodepth', h_rnf )
	422	CALL iom_close ( inum )
[3764]	423	ENDIF
[5407]	424	ELSE ! runoffs applied at the surface
[7753]	425	nk_rnf(:,:) = 1
	426	h_rnf (:,:) = e3t_n(:,:,1)
[1116]	427	ENDIF
[2528]	428	!
[7753]	429	rnf(:,:) = 0._wp ! runoff initialisation
	430	rnf_tsc(:,:,:) = 0._wp ! runoffs temperature & salinty contents initilisation
[2528]	431	!
[1116]	432	! ! ========================
	433	! ! River mouth vicinity
	434	! ! ========================
	435	!
	436	IF( ln_rnf_mouth ) THEN ! Specific treatment in vicinity of river mouths :
	437	! ! - Increase Kz in surface layers ( rn_hrnf > 0 )
	438	! ! - set to zero SSS damping (ln_ssr=T)
	439	! ! - mixed upstream-centered (ln_traadv_cen2=T)
	440	!
[2528]	441	IF ( ln_rnf_depth ) CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already', &
[3764]	442	& 'be spread through depth by ln_rnf_depth' )
[2528]	443	!
	444	nkrnf = 0 ! Number of level over which Kz increase
	445	IF( rn_hrnf > 0._wp ) THEN
[1116]	446	nkrnf = 2
[5407]	447	DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf ) ; nkrnf = nkrnf + 1
	448	END DO
[7646]	449	IF( ln_sco ) CALL ctl_warn( 'sbc_rnf_init: number of levels over which Kz is increased is computed for zco...' )
[1116]	450	ENDIF
	451	IF(lwp) WRITE(numout,*)
[9169]	452	IF(lwp) WRITE(numout,*) ' ==>>> Specific treatment used in vicinity of river mouths :'
[1116]	453	IF(lwp) WRITE(numout,*) ' - Increase Kz in surface layers (if rn_hrnf > 0 )'
	454	IF(lwp) WRITE(numout,*) ' by ', rn_avt_rnf,' m2/s over ', nkrnf, ' w-levels'
	455	IF(lwp) WRITE(numout,*) ' - set to zero SSS damping (if ln_ssr=T)'
	456	IF(lwp) WRITE(numout,*) ' - mixed upstream-centered (if ln_traadv_cen2=T)'
	457	!
	458	CALL rnf_mouth ! set river mouth mask
	459	!
	460	ELSE ! No treatment at river mouths
	461	IF(lwp) WRITE(numout,*)
[9169]	462	IF(lwp) WRITE(numout,*) ' ==>>> No specific treatment at river mouths'
[7753]	463	rnfmsk (:,:) = 0._wp
	464	rnfmsk_z(:) = 0._wp
[1116]	465	nkrnf = 0
	466	ENDIF
[3625]	467	!
[9367]	468	IF( lwxios ) THEN
	469	CALL iom_set_rstw_var_active('rnf_b')
	470	CALL iom_set_rstw_var_active('rnf_hc_b')
	471	CALL iom_set_rstw_var_active('rnf_sc_b')
	472	ENDIF
	473
[1116]	474	END SUBROUTINE sbc_rnf_init
	475
	476
[888]	477	SUBROUTINE rnf_mouth
	478	!!----------------------------------------------------------------------
	479	!! * ROUTINE rnf_mouth *
[3764]	480	!!
[888]	481	!! ** Purpose : define the river mouths mask
	482	!!
	483	!! ** Method : read the river mouth mask (=0/1) in the river runoff
[3764]	484	!! climatological file. Defined a given vertical structure.
	485	!! CAUTION, the vertical structure is hard coded on the
[888]	486	!! first 5 levels.
	487	!! This fields can be used to:
[3764]	488	!! - set an upstream advection scheme
[1116]	489	!! (ln_rnf_mouth=T and ln_traadv_cen2=T)
[3764]	490	!! - increase vertical on the top nn_krnf vertical levels
[888]	491	!! at river runoff input grid point (nn_krnf>=2, see step.F90)
	492	!! - set to zero SSS restoring flux at river mouth grid points
	493	!!
	494	!! ** Action : rnfmsk set to 1 at river runoff input, 0 elsewhere
	495	!! rnfmsk_z vertical structure
	496	!!----------------------------------------------------------------------
[2784]	497	INTEGER :: inum ! temporary integers
	498	CHARACTER(len=140) :: cl_rnfile ! runoff file name
[888]	499	!!----------------------------------------------------------------------
[3764]	500	!
[888]	501	IF(lwp) WRITE(numout,*)
[7646]	502	IF(lwp) WRITE(numout,*) ' rnf_mouth : river mouth mask'
	503	IF(lwp) WRITE(numout,*) ' ~~~~~~~~~ '
[3625]	504	!
[1133]	505	cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
	506	IF( .NOT. sn_cnf%ln_clim ) THEN ; WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear ! add year
	507	IF( sn_cnf%cltype == 'monthly' ) WRITE(cl_rnfile, '(a,"m",i2)' ) TRIM( cl_rnfile ), nmonth ! add month
	508	ENDIF
[3625]	509	!
[888]	510	! horizontal mask (read in NetCDF file)
	511	CALL iom_open ( cl_rnfile, inum ) ! open file
	512	CALL iom_get ( inum, jpdom_data, sn_cnf%clvar, rnfmsk ) ! read the river mouth array
	513	CALL iom_close( inum ) ! close file
[3625]	514	!
[9161]	515	IF( l_clo_rnf ) CALL clo_rnf( rnfmsk ) ! closed sea inflow set as river mouth
[3625]	516	!
[3764]	517	rnfmsk_z(:) = 0._wp ! vertical structure
[888]	518	rnfmsk_z(1) = 1.0
	519	rnfmsk_z(2) = 1.0 ! **********
	520	rnfmsk_z(3) = 0.5 ! HARD CODED on the 5 first levels
	521	rnfmsk_z(4) = 0.25 ! **********
	522	rnfmsk_z(5) = 0.125
[3764]	523	!
[888]	524	END SUBROUTINE rnf_mouth
[3764]	525
[888]	526	!!======================================================================
	527	END MODULE sbcrnf

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

Download in other formats: