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_r12072_TOP-01_ENHANCE-11_CEthe/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r12072_TOP-01_ENHANCE-11_CEthe/src/OCE/SBC/sbcrnf.F90 @ 12109

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

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

Download in other formats: