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 branches/2014/dev_r4650_UKMO14.12_STAND_ALONE_OBSOPER/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

Context Navigation

source: branches/2014/dev_r4650_UKMO14.12_STAND_ALONE_OBSOPER/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 5600

Last change on this file since 5600 was 5600, checked in by andrewryan, 9 years ago
merged in latest version of trunk alongside changes to SAO_SRC to be compatible with latest OBS
Property svn:keywords set to `Id`
File size: 29.8 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	!!----------------------------------------------------------------------
	14	!! sbc_rnf : monthly runoffs read in a NetCDF file
[1116]	15	!! sbc_rnf_init : runoffs initialisation
[888]	16	!! rnf_mouth : set river mouth mask
	17	!!----------------------------------------------------------------------
	18	USE dom_oce ! ocean space and time domain
	19	USE phycst ! physical constants
	20	USE sbc_oce ! surface boundary condition variables
[5034]	21	USE sbcisf ! PM we could remove it I think
[2715]	22	USE closea ! closed seas
[2528]	23	USE fldread ! read input field at current time step
[888]	24	USE in_out_manager ! I/O manager
	25	USE iom ! I/O module
[2715]	26	USE lib_mpp ! MPP library
[5034]	27	USE eosbn2
	28	USE wrk_nemo ! Memory allocation
[888]	29
	30	IMPLICIT NONE
	31	PRIVATE
	32
[2528]	33	PUBLIC sbc_rnf ! routine call in sbcmod module
[5600]	34	PUBLIC sbc_rnf_div ! routine called in divcurl module
[2715]	35	PUBLIC sbc_rnf_alloc ! routine call in sbcmod module
[3764]	36	PUBLIC sbc_rnf_init ! (PUBLIC for TAM)
[2715]	37	! !!* namsbc_rnf namelist *
[5600]	38	CHARACTER(len=100) :: cn_dir !: Root directory for location of rnf files
	39	LOGICAL :: ln_rnf_depth !: depth river runoffs attribute specified in a file
	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 = .true )
	42	REAL(wp) :: rn_dep_max !: depth over which runoffs is spread ( ln_rnf_depth_ini = .true )
	43	INTEGER :: nn_rnf_depth_file !: create (=1) a runoff depth file or not (=0)
	44	LOGICAL :: ln_rnf_tem !: temperature river runoffs attribute specified in a file
[4147]	45	LOGICAL , PUBLIC :: ln_rnf_sal !: salinity river runoffs attribute specified in a file
	46	TYPE(FLD_N) , PUBLIC :: sn_rnf !: information about the runoff file to be read
[5600]	47	TYPE(FLD_N) :: sn_cnf !: information about the runoff mouth file to be read
[4147]	48	TYPE(FLD_N) :: sn_s_rnf !: information about the salinities of runoff file to be read
	49	TYPE(FLD_N) :: sn_t_rnf !: information about the temperatures of runoff file to be read
	50	TYPE(FLD_N) :: sn_dep_rnf !: information about the depth which river inflow affects
	51	LOGICAL , PUBLIC :: ln_rnf_mouth !: specific treatment in mouths vicinity
[5600]	52	REAL(wp) :: rn_hrnf !: runoffs, depth over which enhanced vertical mixing is used
[4147]	53	REAL(wp) , PUBLIC :: rn_avt_rnf !: runoffs, value of the additional vertical mixing coef. [m2/s]
[5600]	54	REAL(wp) :: rn_rfact !: multiplicative factor for runoff
[888]	55
[5600]	56	LOGICAL , PUBLIC :: l_rnfcpl = .false. ! runoffs recieved from oasis
	57
[2715]	58	INTEGER , PUBLIC :: nkrnf = 0 !: nb of levels over which Kz is increased at river mouths
	59	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: rnfmsk !: river mouth mask (hori.)
	60	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:) :: rnfmsk_z !: river mouth mask (vert.)
	61	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: h_rnf !: depth of runoff in m
	62	INTEGER, PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: nk_rnf !: depth of runoff in model levels
[3764]	63	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]	64
[5600]	65	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_rnf ! structure: river runoff (file information, fields read)
	66	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_s_rnf ! structure: river runoff salinity (file information, fields read)
	67	TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_t_rnf ! structure: river runoff temperature (file information, fields read)
[2528]	68
	69	!! * Substitutions
	70	# include "domzgr_substitute.h90"
[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	!
[3832]	105	INTEGER :: ji, jj ! dummy loop indices
	106	INTEGER :: z_err = 0 ! dummy integer for error handling
[888]	107	!!----------------------------------------------------------------------
[5034]	108	REAL(wp), DIMENSION(:,:), POINTER :: ztfrz ! freezing point used for temperature correction
[3764]	109	!
[5034]	110	CALL wrk_alloc( jpi,jpj, ztfrz)
	111
[2528]	112	! ! ---------------------------------------- !
	113	IF( kt /= nit000 ) THEN ! Swap of forcing fields !
	114	! ! ---------------------------------------- !
	115	rnf_b (:,: ) = rnf (:,: ) ! Swap the ocean forcing fields except at nit000
	116	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:) ! where before fields are set at the end of the routine
	117	!
[1242]	118	ENDIF
[888]	119
[5600]	120	! !-------------------!
	121	! ! Update runoff !
	122	! !-------------------!
	123	!
	124	IF( .NOT. l_rnfcpl ) CALL fld_read ( kt, nn_fsbc, sf_rnf ) ! Read Runoffs data and provide it at kt
	125	IF( ln_rnf_tem ) CALL fld_read ( kt, nn_fsbc, sf_t_rnf ) ! idem for runoffs temperature if required
	126	IF( ln_rnf_sal ) CALL fld_read ( kt, nn_fsbc, sf_s_rnf ) ! idem for runoffs salinity if required
	127	!
	128	! Runoff reduction only associated to the ORCA2_LIM configuration
	129	! when reading the NetCDF file runoff_1m_nomask.nc
	130	IF( cp_cfg == 'orca' .AND. jp_cfg == 2 .AND. .NOT. l_rnfcpl ) THEN
	131	WHERE( 40._wp < gphit(:,:) .AND. gphit(:,:) < 65._wp )
	132	sf_rnf(1)%fnow(:,:,1) = 0.85 * sf_rnf(1)%fnow(:,:,1)
	133	END WHERE
	134	ENDIF
	135	!
	136	IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
[888]	137	!
[5600]	138	IF( .NOT. l_rnfcpl ) rnf(:,:) = rn_rfact * ( sf_rnf(1)%fnow(:,:,1) ) ! updated runoff value at time step kt
[2528]	139	!
[5600]	140	! ! set temperature & salinity content of runoffs
	141	IF( ln_rnf_tem ) THEN ! use runoffs temperature data
	142	rnf_tsc(:,:,jp_tem) = ( sf_t_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
	143	WHERE( sf_t_rnf(1)%fnow(:,:,1) == -999._wp ) ! if missing data value use SST as runoffs temperature
	144	rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
[2528]	145	END WHERE
[5600]	146	WHERE( sf_t_rnf(1)%fnow(:,:,1) == -222._wp ) ! where fwf comes from melting of ice shelves or iceberg
	147	ztfrz(:,:) = -1.9 !tfreez( sss_m(:,:) ) !PM to be discuss (trouble if sensitivity study)
	148	rnf_tsc(:,:,jp_tem) = ztfrz(:,:) * rnf(:,:) * r1_rau0 - rnf(:,:) * lfusisf * r1_rau0_rcp
	149	END WHERE
	150	ELSE ! use SST as runoffs temperature
	151	rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
[2528]	152	ENDIF
[5600]	153	! ! use runoffs salinity data
	154	IF( ln_rnf_sal ) rnf_tsc(:,:,jp_sal) = ( sf_s_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
	155	! ! else use S=0 for runoffs (done one for all in the init)
	156	CALL iom_put( "runoffs", rnf ) ! output runoffs arrays
[2528]	157	ENDIF
	158	!
[5600]	159	! ! ---------------------------------------- !
[2528]	160	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	161	! ! ---------------------------------------- !
	162	IF( ln_rstart .AND. & !* Restart: read in restart file
[3764]	163	& iom_varid( numror, 'rnf_b', ldstop = .FALSE. ) > 0 ) THEN
[2528]	164	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields red in the restart file'
	165	CALL iom_get( numror, jpdom_autoglo, 'rnf_b', rnf_b ) ! before runoff
	166	CALL iom_get( numror, jpdom_autoglo, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem) ) ! before heat content of runoff
	167	CALL iom_get( numror, jpdom_autoglo, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal) ) ! before salinity content of runoff
	168	ELSE !* no restart: set from nit000 values
	169	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields set to nit000'
[5600]	170	rnf_b (:,: ) = rnf (:,: )
	171	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[2528]	172	ENDIF
	173	ENDIF
	174	! ! ---------------------------------------- !
	175	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	176	! ! ---------------------------------------- !
	177	IF(lwp) WRITE(numout,*)
	178	IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ', &
	179	& 'at it= ', kt,' date= ', ndastp
	180	IF(lwp) WRITE(numout,*) '~~~~'
	181	CALL iom_rstput( kt, nitrst, numrow, 'rnf_b' , rnf )
	182	CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem) )
	183	CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal) )
	184	ENDIF
[5600]	185	!
[5034]	186	CALL wrk_dealloc( jpi,jpj, ztfrz)
[2528]	187	!
	188	END SUBROUTINE sbc_rnf
	189
	190
	191	SUBROUTINE sbc_rnf_div( phdivn )
	192	!!----------------------------------------------------------------------
	193	!! * ROUTINE sbc_rnf *
[3764]	194	!!
[2528]	195	!! ** Purpose : update the horizontal divergence with the runoff inflow
	196	!!
[3764]	197	!! ** Method :
	198	!! CAUTION : rnf is positive (inflow) decreasing the
[2528]	199	!! divergence and expressed in m/s
	200	!!
	201	!! ** Action : phdivn decreased by the runoff inflow
	202	!!----------------------------------------------------------------------
[2715]	203	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: phdivn ! horizontal divergence
[2528]	204	!!
	205	INTEGER :: ji, jj, jk ! dummy loop indices
	206	REAL(wp) :: zfact ! local scalar
	207	!!----------------------------------------------------------------------
	208	!
	209	zfact = 0.5_wp
	210	!
[5600]	211	IF( ln_rnf_depth .OR. ln_rnf_depth_ini ) THEN !== runoff distributed over several levels ==!
[3764]	212	IF( lk_vvl ) THEN ! variable volume case
[2528]	213	DO jj = 1, jpj ! update the depth over which runoffs are distributed
	214	DO ji = 1, jpi
[3764]	215	h_rnf(ji,jj) = 0._wp
[2528]	216	DO jk = 1, nk_rnf(ji,jj) ! recalculates h_rnf to be the depth in metres
[3764]	217	h_rnf(ji,jj) = h_rnf(ji,jj) + fse3t(ji,jj,jk) ! to the bottom of the relevant grid box
	218	END DO
[2528]	219	! ! apply the runoff input flow
	220	DO jk = 1, nk_rnf(ji,jj)
	221	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	222	END DO
	223	END DO
	224	END DO
	225	ELSE ! constant volume case : just apply the runoff input flow
[888]	226	DO jj = 1, jpj
	227	DO ji = 1, jpi
[2528]	228	DO jk = 1, nk_rnf(ji,jj)
	229	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
	230	END DO
[888]	231	END DO
	232	END DO
	233	ENDIF
[2528]	234	ELSE !== runoff put only at the surface ==!
	235	IF( lk_vvl ) THEN ! variable volume case
	236	h_rnf(:,:) = fse3t(:,:,1) ! recalculate h_rnf to be depth of top box
[1303]	237	ENDIF
[2528]	238	phdivn(:,:,1) = phdivn(:,:,1) - ( rnf(:,:) + rnf_b(:,:) ) * zfact * r1_rau0 / fse3t(:,:,1)
[888]	239	ENDIF
	240	!
[2528]	241	END SUBROUTINE sbc_rnf_div
[888]	242
	243
[2528]	244	SUBROUTINE sbc_rnf_init
[1116]	245	!!----------------------------------------------------------------------
	246	!! * ROUTINE sbc_rnf_init *
	247	!!
	248	!! ** Purpose : Initialisation of the runoffs if (ln_rnf=T)
	249	!!
	250	!! ** Method : - read the runoff namsbc_rnf namelist
	251	!!
	252	!! ** Action : - read parameters
	253	!!----------------------------------------------------------------------
[3764]	254	CHARACTER(len=32) :: rn_dep_file ! runoff file name
[5600]	255	INTEGER :: ji, jj, jk, jm ! dummy loop indices
[2528]	256	INTEGER :: ierror, inum ! temporary integer
[4147]	257	INTEGER :: ios ! Local integer output status for namelist read
[5600]	258	INTEGER :: nbrec ! temporary integer
	259	REAL(wp) :: zacoef
	260	REAL(wp), DIMENSION(12) :: zrec ! times records
	261	REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: zrnfcl
	262	REAL(wp), DIMENSION(:,: ), ALLOCATABLE :: zrnf
[3625]	263	!
[5600]	264	NAMELIST/namsbc_rnf/ cn_dir , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal, &
[3764]	265	& sn_rnf, sn_cnf , sn_s_rnf , sn_t_rnf , sn_dep_rnf, &
[5600]	266	& ln_rnf_mouth , rn_hrnf , rn_avt_rnf, rn_rfact, &
	267	& ln_rnf_depth_ini , rn_dep_max , rn_rnf_max, nn_rnf_depth_file
[1116]	268	!!----------------------------------------------------------------------
[3625]	269	!
[5600]	270	! !== allocate runoff arrays
	271	IF( sbc_rnf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
	272	!
	273	IF( .NOT. ln_rnf ) THEN ! no specific treatment in vicinity of river mouths
	274	ln_rnf_mouth = .FALSE. ! default definition needed for example by sbc_ssr or by tra_adv_muscl
	275	nkrnf = 0
	276	rnf (:,:) = 0.0_wp
	277	rnf_b (:,:) = 0.0_wp
	278	rnfmsk (:,:) = 0.0_wp
	279	rnfmsk_z(:) = 0.0_wp
	280	RETURN
	281	ENDIF
	282	!
[1116]	283	! ! ============
	284	! ! Namelist
	285	! ! ============
[4147]	286	!
	287	REWIND( numnam_ref ) ! Namelist namsbc_rnf in reference namelist : Runoffs
	288	READ ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
	289	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist', lwp )
[1116]	290
[4147]	291	REWIND( numnam_cfg ) ! Namelist namsbc_rnf in configuration namelist : Runoffs
	292	READ ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
	293	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist', lwp )
[4624]	294	IF(lwm) WRITE ( numond, namsbc_rnf )
[1116]	295	!
	296	! ! Control print
	297	IF(lwp) THEN
	298	WRITE(numout,*)
	299	WRITE(numout,*) 'sbc_rnf : runoff '
	300	WRITE(numout,*) '~~~~~~~ '
	301	WRITE(numout,*) ' Namelist namsbc_rnf'
	302	WRITE(numout,*) ' specific river mouths treatment ln_rnf_mouth = ', ln_rnf_mouth
	303	WRITE(numout,*) ' river mouth additional Kz rn_avt_rnf = ', rn_avt_rnf
	304	WRITE(numout,*) ' depth of river mouth additional mixing rn_hrnf = ', rn_hrnf
[3764]	305	WRITE(numout,*) ' multiplicative factor for runoff rn_rfact = ', rn_rfact
[1116]	306	ENDIF
	307	! ! ==================
	308	! ! Type of runoff
	309	! ! ==================
	310	!
[5600]	311	IF( .NOT. l_rnfcpl ) THEN
[2528]	312	ALLOCATE( sf_rnf(1), STAT=ierror ) ! Create sf_rnf structure (runoff inflow)
	313	IF(lwp) WRITE(numout,*)
	314	IF(lwp) WRITE(numout,*) ' runoffs inflow read in a file'
	315	IF( ierror > 0 ) THEN
	316	CALL ctl_stop( 'sbc_rnf: unable to allocate sf_rnf structure' ) ; RETURN
	317	ENDIF
	318	ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1) )
	319	IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
[1133]	320	CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf' )
[5600]	321	ENDIF
	322	!
	323	IF( ln_rnf_tem ) THEN ! Create (if required) sf_t_rnf structure
	324	IF(lwp) WRITE(numout,*)
	325	IF(lwp) WRITE(numout,*) ' runoffs temperatures read in a file'
	326	ALLOCATE( sf_t_rnf(1), STAT=ierror )
	327	IF( ierror > 0 ) THEN
	328	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' ) ; RETURN
[2528]	329	ENDIF
[5600]	330	ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1) )
	331	IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
	332	CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf' )
	333	ENDIF
	334	!
	335	IF( ln_rnf_sal ) THEN ! Create (if required) sf_s_rnf and sf_t_rnf structures
	336	IF(lwp) WRITE(numout,*)
	337	IF(lwp) WRITE(numout,*) ' runoffs salinities read in a file'
	338	ALLOCATE( sf_s_rnf(1), STAT=ierror )
	339	IF( ierror > 0 ) THEN
	340	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' ) ; RETURN
[2528]	341	ENDIF
[5600]	342	ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1) )
	343	IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
	344	CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf' )
	345	ENDIF
	346	!
	347	IF( ln_rnf_depth ) THEN ! depth of runoffs set from a file
	348	IF(lwp) WRITE(numout,*)
	349	IF(lwp) WRITE(numout,*) ' runoffs depth read in a file'
	350	rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
	351	IF( .NOT. sn_dep_rnf%ln_clim ) THEN ; WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear ! add year
	352	IF( sn_dep_rnf%cltype == 'monthly' ) WRITE(rn_dep_file, '(a,"m",i2)' ) TRIM( rn_dep_file ), nmonth ! add month
	353	ENDIF
	354	CALL iom_open ( rn_dep_file, inum ) ! open file
	355	CALL iom_get ( inum, jpdom_data, sn_dep_rnf%clvar, h_rnf ) ! read the river mouth array
	356	CALL iom_close( inum ) ! close file
[2528]	357	!
[5600]	358	nk_rnf(:,:) = 0 ! set the number of level over which river runoffs are applied
	359	DO jj = 1, jpj
	360	DO ji = 1, jpi
	361	IF( h_rnf(ji,jj) > 0._wp ) THEN
	362	jk = 2
	363	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
	364	END DO
	365	nk_rnf(ji,jj) = jk
	366	ELSEIF( h_rnf(ji,jj) == -1._wp ) THEN ; nk_rnf(ji,jj) = 1
	367	ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN ; nk_rnf(ji,jj) = mbkt(ji,jj)
	368	ELSE
	369	CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999' )
	370	WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
	371	ENDIF
	372	END DO
	373	END DO
	374	DO jj = 1, jpj ! set the associated depth
	375	DO ji = 1, jpi
	376	h_rnf(ji,jj) = 0._wp
	377	DO jk = 1, nk_rnf(ji,jj)
	378	h_rnf(ji,jj) = h_rnf(ji,jj) + fse3t(ji,jj,jk)
[3764]	379	END DO
	380	END DO
[5600]	381	END DO
	382	!
	383	ELSE IF( ln_rnf_depth_ini ) THEN ! runoffs applied at the surface
	384	!
	385	IF(lwp) WRITE(numout,*)
	386	IF(lwp) WRITE(numout,*) ' depth of runoff computed once from max value of runoff'
	387	IF(lwp) WRITE(numout,*) ' max value of the runoff climatologie (over global domain) rn_rnf_max = ', rn_rnf_max
	388	IF(lwp) WRITE(numout,*) ' depth over which runoffs is spread rn_dep_max = ', rn_dep_max
	389	IF(lwp) WRITE(numout,*) ' create (=1) a runoff depth file or not (=0) nn_rnf_depth_file = ', nn_rnf_depth_file
	390
	391	CALL iom_open( TRIM( sn_rnf%clname ), inum ) ! open runoff file
	392	CALL iom_gettime( inum, zrec, kntime=nbrec)
	393	ALLOCATE( zrnfcl(jpi,jpj,nbrec) ) ; ALLOCATE( zrnf(jpi,jpj) )
	394	DO jm = 1, nbrec
	395	CALL iom_get( inum, jpdom_data, TRIM( sn_rnf%clvar ), zrnfcl(:,:,jm), jm )
	396	END DO
	397	CALL iom_close( inum )
	398	zrnf(:,:) = MAXVAL( zrnfcl(:,:,:), DIM=3 ) ! maximum value in time
	399	DEALLOCATE( zrnfcl )
	400	!
	401	h_rnf(:,:) = 1.
	402	!
	403	zacoef = rn_dep_max / rn_rnf_max ! coef of linear relation between runoff and its depth (150m for max of runoff)
	404	!
	405	WHERE( zrnf(:,:) > 0._wp ) h_rnf(:,:) = zacoef * zrnf(:,:) ! compute depth for all runoffs
	406	!
	407	DO jj = 1, jpj ! take in account min depth of ocean rn_hmin
	408	DO ji = 1, jpi
	409	IF( zrnf(ji,jj) > 0._wp ) THEN
	410	jk = mbkt(ji,jj)
	411	h_rnf(ji,jj) = MIN( h_rnf(ji,jj), gdept_0(ji,jj,jk ) )
	412	ENDIF
	413	END DO
	414	END DO
	415	!
	416	nk_rnf(:,:) = 0 ! number of levels on which runoffs are distributed
	417	DO jj = 1, jpj
	418	DO ji = 1, jpi
	419	IF( zrnf(ji,jj) > 0._wp ) THEN
	420	jk = 2
	421	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
[2528]	422	END DO
[5600]	423	nk_rnf(ji,jj) = jk
	424	ELSE
	425	nk_rnf(ji,jj) = 1
	426	ENDIF
	427	END DO
	428	END DO
	429	!
	430	DEALLOCATE( zrnf )
	431	!
	432	DO jj = 1, jpj ! set the associated depth
	433	DO ji = 1, jpi
	434	h_rnf(ji,jj) = 0._wp
	435	DO jk = 1, nk_rnf(ji,jj)
	436	h_rnf(ji,jj) = h_rnf(ji,jj) + fse3t(ji,jj,jk)
[2528]	437	END DO
	438	END DO
[5600]	439	END DO
	440	!
	441	IF( nn_rnf_depth_file == 1 ) THEN ! save output nb levels for runoff
	442	IF(lwp) WRITE(numout,*) ' create runoff depht file'
	443	CALL iom_open ( TRIM( sn_dep_rnf%clname ), inum, ldwrt = .TRUE., kiolib = jprstlib )
	444	CALL iom_rstput( 0, 0, inum, 'rodepth', h_rnf )
	445	CALL iom_close ( inum )
[3764]	446	ENDIF
[5600]	447	ELSE ! runoffs applied at the surface
	448	nk_rnf(:,:) = 1
	449	h_rnf (:,:) = fse3t(:,:,1)
[1116]	450	ENDIF
[2528]	451	!
[3294]	452	rnf(:,:) = 0._wp ! runoff initialisation
[2528]	453	rnf_tsc(:,:,:) = 0._wp ! runoffs temperature & salinty contents initilisation
	454	!
[1116]	455	! ! ========================
	456	! ! River mouth vicinity
	457	! ! ========================
	458	!
	459	IF( ln_rnf_mouth ) THEN ! Specific treatment in vicinity of river mouths :
	460	! ! - Increase Kz in surface layers ( rn_hrnf > 0 )
	461	! ! - set to zero SSS damping (ln_ssr=T)
	462	! ! - mixed upstream-centered (ln_traadv_cen2=T)
	463	!
[2528]	464	IF ( ln_rnf_depth ) CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already', &
[3764]	465	& 'be spread through depth by ln_rnf_depth' )
[2528]	466	!
	467	nkrnf = 0 ! Number of level over which Kz increase
	468	IF( rn_hrnf > 0._wp ) THEN
[1116]	469	nkrnf = 2
[5600]	470	DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf ) ; nkrnf = nkrnf + 1
	471	END DO
[3625]	472	IF( ln_sco ) CALL ctl_warn( 'sbc_rnf: number of levels over which Kz is increased is computed for zco...' )
[1116]	473	ENDIF
	474	IF(lwp) WRITE(numout,*)
	475	IF(lwp) WRITE(numout,*) ' Specific treatment used in vicinity of river mouths :'
	476	IF(lwp) WRITE(numout,*) ' - Increase Kz in surface layers (if rn_hrnf > 0 )'
	477	IF(lwp) WRITE(numout,*) ' by ', rn_avt_rnf,' m2/s over ', nkrnf, ' w-levels'
	478	IF(lwp) WRITE(numout,*) ' - set to zero SSS damping (if ln_ssr=T)'
	479	IF(lwp) WRITE(numout,*) ' - mixed upstream-centered (if ln_traadv_cen2=T)'
	480	!
	481	CALL rnf_mouth ! set river mouth mask
	482	!
	483	ELSE ! No treatment at river mouths
	484	IF(lwp) WRITE(numout,*)
	485	IF(lwp) WRITE(numout,*) ' No specific treatment at river mouths'
[3764]	486	rnfmsk (:,:) = 0._wp
[2528]	487	rnfmsk_z(:) = 0._wp
[1116]	488	nkrnf = 0
	489	ENDIF
[3625]	490	!
[1116]	491	END SUBROUTINE sbc_rnf_init
	492
	493
[888]	494	SUBROUTINE rnf_mouth
	495	!!----------------------------------------------------------------------
	496	!! * ROUTINE rnf_mouth *
[3764]	497	!!
[888]	498	!! ** Purpose : define the river mouths mask
	499	!!
	500	!! ** Method : read the river mouth mask (=0/1) in the river runoff
[3764]	501	!! climatological file. Defined a given vertical structure.
	502	!! CAUTION, the vertical structure is hard coded on the
[888]	503	!! first 5 levels.
	504	!! This fields can be used to:
[3764]	505	!! - set an upstream advection scheme
[1116]	506	!! (ln_rnf_mouth=T and ln_traadv_cen2=T)
[3764]	507	!! - increase vertical on the top nn_krnf vertical levels
[888]	508	!! at river runoff input grid point (nn_krnf>=2, see step.F90)
	509	!! - set to zero SSS restoring flux at river mouth grid points
	510	!!
	511	!! ** Action : rnfmsk set to 1 at river runoff input, 0 elsewhere
	512	!! rnfmsk_z vertical structure
	513	!!----------------------------------------------------------------------
[2784]	514	INTEGER :: inum ! temporary integers
	515	CHARACTER(len=140) :: cl_rnfile ! runoff file name
[888]	516	!!----------------------------------------------------------------------
[3764]	517	!
[888]	518	IF(lwp) WRITE(numout,*)
	519	IF(lwp) WRITE(numout,*) 'rnf_mouth : river mouth mask'
	520	IF(lwp) WRITE(numout,*) '~~~~~~~~~ '
[3625]	521	!
[1133]	522	cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
	523	IF( .NOT. sn_cnf%ln_clim ) THEN ; WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear ! add year
	524	IF( sn_cnf%cltype == 'monthly' ) WRITE(cl_rnfile, '(a,"m",i2)' ) TRIM( cl_rnfile ), nmonth ! add month
	525	ENDIF
[3625]	526	!
[888]	527	! horizontal mask (read in NetCDF file)
	528	CALL iom_open ( cl_rnfile, inum ) ! open file
	529	CALL iom_get ( inum, jpdom_data, sn_cnf%clvar, rnfmsk ) ! read the river mouth array
	530	CALL iom_close( inum ) ! close file
[3625]	531	!
[3632]	532	IF( nn_closea == 1 ) CALL clo_rnf( rnfmsk ) ! closed sea inflow set as ruver mouth
[3625]	533	!
[3764]	534	rnfmsk_z(:) = 0._wp ! vertical structure
[888]	535	rnfmsk_z(1) = 1.0
	536	rnfmsk_z(2) = 1.0 ! **********
	537	rnfmsk_z(3) = 0.5 ! HARD CODED on the 5 first levels
	538	rnfmsk_z(4) = 0.25 ! **********
	539	rnfmsk_z(5) = 0.125
[3764]	540	!
[888]	541	END SUBROUTINE rnf_mouth
[3764]	542
[888]	543	!!======================================================================
	544	END MODULE sbcrnf

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

Download in other formats: