Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

sbcrnf.F90 @ 7910

Last change on this file since 7910 was 7910, checked in by timgraham, 7 years ago
All wrk_alloc removed
Property svn:keywords set to `Id`
File size: 28.7 KB

Line
1	MODULE sbcrnf
2	!!======================================================================
3	!! * MODULE sbcrnf *
4	!! Ocean forcing: river runoff
5	!!=====================================================================
6	!! History : OPA ! 2000-11 (R. Hordoir, E. Durand) NetCDF FORMAT
7	!! NEMO 1.0 ! 2002-09 (G. Madec) F90: Free form and module
8	!! 3.0 ! 2006-07 (G. Madec) Surface module
9	!! 3.2 ! 2009-04 (B. Lemaire) Introduce iom_put
10	!! 3.3 ! 2010-10 (R. Furner, G. Madec) runoff distributed over ocean levels
11	!!----------------------------------------------------------------------
12
13	!!----------------------------------------------------------------------
14	!! sbc_rnf : monthly runoffs read in a NetCDF file
15	!! sbc_rnf_init : runoffs initialisation
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
21	USE sbcisf ! PM we could remove it I think
22	USE eosbn2 ! Equation Of State
23	USE usrdef_closea ! closed seas
24	!
25	USE in_out_manager ! I/O manager
26	USE fldread ! read input field at current time step
27	USE iom ! I/O module
28	USE lib_mpp ! MPP library
29
30	IMPLICIT NONE
31	PRIVATE
32
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
37
38	! !!* namsbc_rnf namelist *
39	CHARACTER(len=100) :: cn_dir !: Root directory for location of rnf files
40	LOGICAL :: ln_rnf_depth !: depth river runoffs attribute specified in a file
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
56
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
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
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]
65
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)
69
70	!!----------------------------------------------------------------------
71	!! NEMO/OPA 3.3 , NEMO Consortium (2010)
72	!! $Id$
73	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
74	!!----------------------------------------------------------------------
75	CONTAINS
76
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	!
85	IF( lk_mpp ) CALL mpp_sum ( sbc_rnf_alloc )
86	IF( sbc_rnf_alloc > 0 ) CALL ctl_warn('sbc_rnf_alloc: allocation of arrays failed')
87	END FUNCTION sbc_rnf_alloc
88
89
90	SUBROUTINE sbc_rnf( kt )
91	!!----------------------------------------------------------------------
92	!! * ROUTINE sbc_rnf *
93	!!
94	!! ** Purpose : Introduce a climatological run off forcing
95	!!
96	!! ** Method : Set each river mouth with a monthly climatology
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
103	!
104	INTEGER :: ji, jj ! dummy loop indices
105	INTEGER :: z_err = 0 ! dummy integer for error handling
106	!!----------------------------------------------------------------------
107	REAL(wp), DIMENSION(jpi,jpj) :: ztfrz ! freezing point used for temperature correction
108	!
109	!
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
119	!
120	IF( .NOT. l_rnfcpl ) rnf(:,:) = rn_rfact * ( sf_rnf(1)%fnow(:,:,1) ) ! updated runoff value at time step kt
121	!
122	! ! set temperature & salinity content of runoffs
123	IF( ln_rnf_tem ) THEN ! use runoffs temperature data
124	rnf_tsc(:,:,jp_tem) = ( sf_t_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
125	CALL eos_fzp( sss_m(:,:), ztfrz(:,:) )
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
130	rnf_tsc(:,:,jp_tem) = ztfrz(:,:) * rnf(:,:) * r1_rau0 - rnf(:,:) * rlfusisf * r1_rau0_rcp
131	END WHERE
132	ELSE ! use SST as runoffs temperature
133	rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
134	ENDIF
135	! ! use runoffs salinity data
136	IF( ln_rnf_sal ) rnf_tsc(:,:,jp_sal) = ( sf_s_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
137	! ! else use S=0 for runoffs (done one for all in the init)
138	CALL iom_put( "runoffs", rnf ) ! output runoffs arrays
139	ENDIF
140	!
141	! ! ---------------------------------------- !
142	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
143	! ! ---------------------------------------- !
144	IF( ln_rstart .AND. & !* Restart: read in restart file
145	& iom_varid( numror, 'rnf_b', ldstop = .FALSE. ) > 0 ) THEN
146	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields red in the restart file'
147	CALL iom_get( numror, jpdom_autoglo, 'rnf_b', rnf_b ) ! before runoff
148	CALL iom_get( numror, jpdom_autoglo, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem) ) ! before heat content of runoff
149	CALL iom_get( numror, jpdom_autoglo, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal) ) ! before salinity content of runoff
150	ELSE !* no restart: set from nit000 values
151	IF(lwp) WRITE(numout,*) ' nit000-1 runoff forcing fields set to nit000'
152	rnf_b (:,: ) = rnf (:,: )
153	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
154	ENDIF
155	ENDIF
156	! ! ---------------------------------------- !
157	IF( lrst_oce ) THEN ! Write in the ocean restart file !
158	! ! ---------------------------------------- !
159	IF(lwp) WRITE(numout,*)
160	IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ', &
161	& 'at it= ', kt,' date= ', ndastp
162	IF(lwp) WRITE(numout,*) '~~~~'
163	CALL iom_rstput( kt, nitrst, numrow, 'rnf_b' , rnf )
164	CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem) )
165	CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal) )
166	ENDIF
167	!
168	!
169	END SUBROUTINE sbc_rnf
170
171
172	SUBROUTINE sbc_rnf_div( phdivn )
173	!!----------------------------------------------------------------------
174	!! * ROUTINE sbc_rnf *
175	!!
176	!! ** Purpose : update the horizontal divergence with the runoff inflow
177	!!
178	!! ** Method :
179	!! CAUTION : rnf is positive (inflow) decreasing the
180	!! divergence and expressed in m/s
181	!!
182	!! ** Action : phdivn decreased by the runoff inflow
183	!!----------------------------------------------------------------------
184	REAL(wp), DIMENSION(:,:,:), INTENT(inout) :: phdivn ! horizontal divergence
185	!!
186	INTEGER :: ji, jj, jk ! dummy loop indices
187	REAL(wp) :: zfact ! local scalar
188	!!----------------------------------------------------------------------
189	!
190	zfact = 0.5_wp
191	!
192	IF( ln_rnf_depth .OR. ln_rnf_depth_ini ) THEN !== runoff distributed over several levels ==!
193	IF( ln_linssh ) THEN !* constant volume case : just apply the runoff input flow
194	DO jj = 1, jpj
195	DO ji = 1, jpi
196	DO jk = 1, nk_rnf(ji,jj)
197	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
198	END DO
199	END DO
200	END DO
201	ELSE !* variable volume case
202	DO jj = 1, jpj ! update the depth over which runoffs are distributed
203	DO ji = 1, jpi
204	h_rnf(ji,jj) = 0._wp
205	DO jk = 1, nk_rnf(ji,jj) ! recalculates h_rnf to be the depth in metres
206	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk) ! to the bottom of the relevant grid box
207	END DO
208	! ! apply the runoff input flow
209	DO jk = 1, nk_rnf(ji,jj)
210	phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
211	END DO
212	END DO
213	END DO
214	ENDIF
215	ELSE !== runoff put only at the surface ==!
216	h_rnf (:,:) = e3t_n (:,:,1) ! update h_rnf to be depth of top box
217	phdivn(:,:,1) = phdivn(:,:,1) - ( rnf(:,:) + rnf_b(:,:) ) * zfact * r1_rau0 / e3t_n(:,:,1)
218	ENDIF
219	!
220	END SUBROUTINE sbc_rnf_div
221
222
223	SUBROUTINE sbc_rnf_init
224	!!----------------------------------------------------------------------
225	!! * ROUTINE sbc_rnf_init *
226	!!
227	!! ** Purpose : Initialisation of the runoffs if (ln_rnf=T)
228	!!
229	!! ** Method : - read the runoff namsbc_rnf namelist
230	!!
231	!! ** Action : - read parameters
232	!!----------------------------------------------------------------------
233	CHARACTER(len=32) :: rn_dep_file ! runoff file name
234	INTEGER :: ji, jj, jk, jm ! dummy loop indices
235	INTEGER :: ierror, inum ! temporary integer
236	INTEGER :: ios ! Local integer output status for namelist read
237	INTEGER :: nbrec ! temporary integer
238	REAL(wp) :: zacoef
239	REAL(wp), DIMENSION(12) :: zrec ! times records
240	REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: zrnfcl
241	REAL(wp), DIMENSION(:,: ), ALLOCATABLE :: zrnf
242	!
243	NAMELIST/namsbc_rnf/ cn_dir , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal, &
244	& sn_rnf, sn_cnf , sn_s_rnf , sn_t_rnf , sn_dep_rnf, &
245	& ln_rnf_mouth , rn_hrnf , rn_avt_rnf, rn_rfact, &
246	& ln_rnf_depth_ini , rn_dep_max , rn_rnf_max, nn_rnf_depth_file
247	!!----------------------------------------------------------------------
248	!
249	! !== allocate runoff arrays
250	IF( sbc_rnf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
251	!
252	IF( .NOT. ln_rnf ) THEN ! no specific treatment in vicinity of river mouths
253	ln_rnf_mouth = .FALSE. ! default definition needed for example by sbc_ssr or by tra_adv_muscl
254	nkrnf = 0
255	rnf (:,:) = 0.0_wp
256	rnf_b (:,:) = 0.0_wp
257	rnfmsk (:,:) = 0.0_wp
258	rnfmsk_z(:) = 0.0_wp
259	RETURN
260	ENDIF
261	!
262	! ! ============
263	! ! Namelist
264	! ! ============
265	!
266	REWIND( numnam_ref ) ! Namelist namsbc_rnf in reference namelist : Runoffs
267	READ ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
268	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist', lwp )
269
270	REWIND( numnam_cfg ) ! Namelist namsbc_rnf in configuration namelist : Runoffs
271	READ ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
272	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist', lwp )
273	IF(lwm) WRITE ( numond, namsbc_rnf )
274	!
275	! ! Control print
276	IF(lwp) THEN
277	WRITE(numout,*)
278	WRITE(numout,*) 'sbc_rnf_init : runoff '
279	WRITE(numout,*) '~~~~~~~~~~~~ '
280	WRITE(numout,*) ' Namelist namsbc_rnf'
281	WRITE(numout,*) ' specific river mouths treatment ln_rnf_mouth = ', ln_rnf_mouth
282	WRITE(numout,*) ' river mouth additional Kz rn_avt_rnf = ', rn_avt_rnf
283	WRITE(numout,*) ' depth of river mouth additional mixing rn_hrnf = ', rn_hrnf
284	WRITE(numout,*) ' multiplicative factor for runoff rn_rfact = ', rn_rfact
285	ENDIF
286	! ! ==================
287	! ! Type of runoff
288	! ! ==================
289	!
290	IF( .NOT. l_rnfcpl ) THEN
291	ALLOCATE( sf_rnf(1), STAT=ierror ) ! Create sf_rnf structure (runoff inflow)
292	IF(lwp) WRITE(numout,*)
293	IF(lwp) WRITE(numout,*) ' runoffs inflow read in a file'
294	IF( ierror > 0 ) THEN
295	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_rnf structure' ) ; RETURN
296	ENDIF
297	ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1) )
298	IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
299	CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf', no_print )
300	ENDIF
301	!
302	IF( ln_rnf_tem ) THEN ! Create (if required) sf_t_rnf structure
303	IF(lwp) WRITE(numout,*)
304	IF(lwp) WRITE(numout,*) ' runoffs temperatures read in a file'
305	ALLOCATE( sf_t_rnf(1), STAT=ierror )
306	IF( ierror > 0 ) THEN
307	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' ) ; RETURN
308	ENDIF
309	ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1) )
310	IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
311	CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf', no_print )
312	ENDIF
313	!
314	IF( ln_rnf_sal ) THEN ! Create (if required) sf_s_rnf and sf_t_rnf structures
315	IF(lwp) WRITE(numout,*)
316	IF(lwp) WRITE(numout,*) ' runoffs salinities read in a file'
317	ALLOCATE( sf_s_rnf(1), STAT=ierror )
318	IF( ierror > 0 ) THEN
319	CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' ) ; RETURN
320	ENDIF
321	ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1) )
322	IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
323	CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf', no_print )
324	ENDIF
325	!
326	IF( ln_rnf_depth ) THEN ! depth of runoffs set from a file
327	IF(lwp) WRITE(numout,*)
328	IF(lwp) WRITE(numout,*) ' runoffs depth read in a file'
329	rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
330	IF( .NOT. sn_dep_rnf%ln_clim ) THEN ; WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear ! add year
331	IF( sn_dep_rnf%cltype == 'monthly' ) WRITE(rn_dep_file, '(a,"m",i2)' ) TRIM( rn_dep_file ), nmonth ! add month
332	ENDIF
333	CALL iom_open ( rn_dep_file, inum ) ! open file
334	CALL iom_get ( inum, jpdom_data, sn_dep_rnf%clvar, h_rnf ) ! read the river mouth array
335	CALL iom_close( inum ) ! close file
336	!
337	nk_rnf(:,:) = 0 ! set the number of level over which river runoffs are applied
338	DO jj = 1, jpj
339	DO ji = 1, jpi
340	IF( h_rnf(ji,jj) > 0._wp ) THEN
341	jk = 2
342	DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ; jk = jk + 1
343	END DO
344	nk_rnf(ji,jj) = jk
345	ELSEIF( h_rnf(ji,jj) == -1._wp ) THEN ; nk_rnf(ji,jj) = 1
346	ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN ; nk_rnf(ji,jj) = mbkt(ji,jj)
347	ELSE
348	CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999' )
349	WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
350	ENDIF
351	END DO
352	END DO
353	DO jj = 1, jpj ! set the associated depth
354	DO ji = 1, jpi
355	h_rnf(ji,jj) = 0._wp
356	DO jk = 1, nk_rnf(ji,jj)
357	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
358	END DO
359	END DO
360	END DO
361	!
362	ELSE IF( ln_rnf_depth_ini ) THEN ! runoffs applied at the surface
363	!
364	IF(lwp) WRITE(numout,*)
365	IF(lwp) WRITE(numout,*) ' depth of runoff computed once from max value of runoff'
366	IF(lwp) WRITE(numout,*) ' max value of the runoff climatologie (over global domain) rn_rnf_max = ', rn_rnf_max
367	IF(lwp) WRITE(numout,*) ' depth over which runoffs is spread rn_dep_max = ', rn_dep_max
368	IF(lwp) WRITE(numout,*) ' create (=1) a runoff depth file or not (=0) nn_rnf_depth_file = ', nn_rnf_depth_file
369
370	CALL iom_open( TRIM( sn_rnf%clname ), inum ) ! open runoff file
371	CALL iom_gettime( inum, zrec, kntime=nbrec)
372	ALLOCATE( zrnfcl(jpi,jpj,nbrec) ) ; ALLOCATE( zrnf(jpi,jpj) )
373	DO jm = 1, nbrec
374	CALL iom_get( inum, jpdom_data, TRIM( sn_rnf%clvar ), zrnfcl(:,:,jm), jm )
375	END DO
376	CALL iom_close( inum )
377	zrnf(:,:) = MAXVAL( zrnfcl(:,:,:), DIM=3 ) ! maximum value in time
378	DEALLOCATE( zrnfcl )
379	!
380	h_rnf(:,:) = 1.
381	!
382	zacoef = rn_dep_max / rn_rnf_max ! coef of linear relation between runoff and its depth (150m for max of runoff)
383	!
384	WHERE( zrnf(:,:) > 0._wp ) h_rnf(:,:) = zacoef * zrnf(:,:) ! compute depth for all runoffs
385	!
386	DO jj = 1, jpj ! take in account min depth of ocean rn_hmin
387	DO ji = 1, jpi
388	IF( zrnf(ji,jj) > 0._wp ) THEN
389	jk = mbkt(ji,jj)
390	h_rnf(ji,jj) = MIN( h_rnf(ji,jj), gdept_0(ji,jj,jk ) )
391	ENDIF
392	END DO
393	END DO
394	!
395	nk_rnf(:,:) = 0 ! number of levels on which runoffs are distributed
396	DO jj = 1, jpj
397	DO ji = 1, jpi
398	IF( zrnf(ji,jj) > 0._wp ) THEN
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
406	END DO
407	END DO
408	!
409	DEALLOCATE( zrnf )
410	!
411	DO jj = 1, jpj ! set the associated depth
412	DO ji = 1, jpi
413	h_rnf(ji,jj) = 0._wp
414	DO jk = 1, nk_rnf(ji,jj)
415	h_rnf(ji,jj) = h_rnf(ji,jj) + e3t_n(ji,jj,jk)
416	END DO
417	END DO
418	END DO
419	!
420	IF( nn_rnf_depth_file == 1 ) THEN ! save output nb levels for runoff
421	IF(lwp) WRITE(numout,*) ' create runoff depht file'
422	CALL iom_open ( TRIM( sn_dep_rnf%clname ), inum, ldwrt = .TRUE., kiolib = jprstlib )
423	CALL iom_rstput( 0, 0, inum, 'rodepth', h_rnf )
424	CALL iom_close ( inum )
425	ENDIF
426	ELSE ! runoffs applied at the surface
427	nk_rnf(:,:) = 1
428	h_rnf (:,:) = e3t_n(:,:,1)
429	ENDIF
430	!
431	rnf(:,:) = 0._wp ! runoff initialisation
432	rnf_tsc(:,:,:) = 0._wp ! runoffs temperature & salinty contents initilisation
433	!
434	! ! ========================
435	! ! River mouth vicinity
436	! ! ========================
437	!
438	IF( ln_rnf_mouth ) THEN ! Specific treatment in vicinity of river mouths :
439	! ! - Increase Kz in surface layers ( rn_hrnf > 0 )
440	! ! - set to zero SSS damping (ln_ssr=T)
441	! ! - mixed upstream-centered (ln_traadv_cen2=T)
442	!
443	IF ( ln_rnf_depth ) CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already', &
444	& 'be spread through depth by ln_rnf_depth' )
445	!
446	nkrnf = 0 ! Number of level over which Kz increase
447	IF( rn_hrnf > 0._wp ) THEN
448	nkrnf = 2
449	DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf ) ; nkrnf = nkrnf + 1
450	END DO
451	IF( ln_sco ) CALL ctl_warn( 'sbc_rnf_init: number of levels over which Kz is increased is computed for zco...' )
452	ENDIF
453	IF(lwp) WRITE(numout,*)
454	IF(lwp) WRITE(numout,*) ' Specific treatment used in vicinity of river mouths :'
455	IF(lwp) WRITE(numout,*) ' - Increase Kz in surface layers (if rn_hrnf > 0 )'
456	IF(lwp) WRITE(numout,*) ' by ', rn_avt_rnf,' m2/s over ', nkrnf, ' w-levels'
457	IF(lwp) WRITE(numout,*) ' - set to zero SSS damping (if ln_ssr=T)'
458	IF(lwp) WRITE(numout,*) ' - mixed upstream-centered (if ln_traadv_cen2=T)'
459	!
460	CALL rnf_mouth ! set river mouth mask
461	!
462	ELSE ! No treatment at river mouths
463	IF(lwp) WRITE(numout,*)
464	IF(lwp) WRITE(numout,*) ' No specific treatment at river mouths'
465	rnfmsk (:,:) = 0._wp
466	rnfmsk_z(:) = 0._wp
467	nkrnf = 0
468	ENDIF
469	!
470	END SUBROUTINE sbc_rnf_init
471
472
473	SUBROUTINE rnf_mouth
474	!!----------------------------------------------------------------------
475	!! * ROUTINE rnf_mouth *
476	!!
477	!! ** Purpose : define the river mouths mask
478	!!
479	!! ** Method : read the river mouth mask (=0/1) in the river runoff
480	!! climatological file. Defined a given vertical structure.
481	!! CAUTION, the vertical structure is hard coded on the
482	!! first 5 levels.
483	!! This fields can be used to:
484	!! - set an upstream advection scheme
485	!! (ln_rnf_mouth=T and ln_traadv_cen2=T)
486	!! - increase vertical on the top nn_krnf vertical levels
487	!! at river runoff input grid point (nn_krnf>=2, see step.F90)
488	!! - set to zero SSS restoring flux at river mouth grid points
489	!!
490	!! ** Action : rnfmsk set to 1 at river runoff input, 0 elsewhere
491	!! rnfmsk_z vertical structure
492	!!----------------------------------------------------------------------
493	INTEGER :: inum ! temporary integers
494	CHARACTER(len=140) :: cl_rnfile ! runoff file name
495	!!----------------------------------------------------------------------
496	!
497	IF(lwp) WRITE(numout,*)
498	IF(lwp) WRITE(numout,*) ' rnf_mouth : river mouth mask'
499	IF(lwp) WRITE(numout,*) ' ~~~~~~~~~ '
500	!
501	cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
502	IF( .NOT. sn_cnf%ln_clim ) THEN ; WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear ! add year
503	IF( sn_cnf%cltype == 'monthly' ) WRITE(cl_rnfile, '(a,"m",i2)' ) TRIM( cl_rnfile ), nmonth ! add month
504	ENDIF
505	!
506	! horizontal mask (read in NetCDF file)
507	CALL iom_open ( cl_rnfile, inum ) ! open file
508	CALL iom_get ( inum, jpdom_data, sn_cnf%clvar, rnfmsk ) ! read the river mouth array
509	CALL iom_close( inum ) ! close file
510	!
511	IF( nn_closea == 1 ) CALL clo_rnf( rnfmsk ) ! closed sea inflow set as ruver mouth
512	!
513	rnfmsk_z(:) = 0._wp ! vertical structure
514	rnfmsk_z(1) = 1.0
515	rnfmsk_z(2) = 1.0 ! **********
516	rnfmsk_z(3) = 0.5 ! HARD CODED on the 5 first levels
517	rnfmsk_z(4) = 0.25 ! **********
518	rnfmsk_z(5) = 0.125
519	!
520	END SUBROUTINE rnf_mouth
521
522	!!======================================================================
523	END MODULE sbcrnf

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

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: branches/2017/dev_r7881_no_wrk_alloc/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 7910

Download in other formats: