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_r11943_MERGE_2019/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/SBC/sbcrnf.F90 @ 12193

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

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

Download in other formats: