source: branches/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 5403

Last change on this file since 5403 was 5403, checked in by smasson, 6 years ago

dev_r5218_CNRS17_coupling: sette ok

  • Property svn:keywords set to Id
File size: 25.8 KB
Line 
1MODULE 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 closea          ! closed seas
23   USE fldread         ! read input field at current time step
24   USE in_out_manager  ! I/O manager
25   USE iom             ! I/O module
26   USE lib_mpp         ! MPP library
27   USE eosbn2
28   USE wrk_nemo        ! Memory allocation
29
30   IMPLICIT NONE
31   PRIVATE
32
33   PUBLIC   sbc_rnf       ! routine call in sbcmod module
34   PUBLIC   sbc_rnf_div   ! routine called in divcurl module
35   PUBLIC   sbc_rnf_alloc ! routine call in sbcmod module
36   PUBLIC   sbc_rnf_init  ! (PUBLIC for TAM)
37   !                                                     !!* namsbc_rnf namelist *
38   CHARACTER(len=100), PUBLIC ::   cn_dir          !: Root directory for location of ssr files
39   LOGICAL           , PUBLIC ::   ln_rnf_depth    !: depth       river runoffs attribute specified in a file
40   LOGICAL           , PUBLIC ::   ln_rnf_tem      !: temperature river runoffs attribute specified in a file
41   LOGICAL           , PUBLIC ::   ln_rnf_sal      !: salinity    river runoffs attribute specified in a file
42   TYPE(FLD_N)       , PUBLIC ::   sn_rnf          !: information about the runoff file to be read
43   TYPE(FLD_N)       , PUBLIC ::   sn_cnf          !: information about the runoff mouth file to be read
44   TYPE(FLD_N)                ::   sn_s_rnf        !: information about the salinities of runoff file to be read
45   TYPE(FLD_N)                ::   sn_t_rnf        !: information about the temperatures of runoff file to be read
46   TYPE(FLD_N)                ::   sn_dep_rnf      !: information about the depth which river inflow affects
47   LOGICAL           , PUBLIC ::   ln_rnf_mouth    !: specific treatment in mouths vicinity
48   REAL(wp)          , PUBLIC ::   rn_hrnf         !: runoffs, depth over which enhanced vertical mixing is used
49   REAL(wp)          , PUBLIC ::   rn_avt_rnf      !: runoffs, value of the additional vertical mixing coef. [m2/s]
50   REAL(wp)          , PUBLIC ::   rn_rfact        !: multiplicative factor for runoff
51
52   LOGICAL           , PUBLIC ::   l_rnfcpl = .false.       ! runoffs recieved from oasis
53
54   INTEGER , PUBLIC  ::   nkrnf = 0         !: nb of levels over which Kz is increased at river mouths
55   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   rnfmsk              !: river mouth mask (hori.)
56   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)     ::   rnfmsk_z            !: river mouth mask (vert.)
57   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   h_rnf               !: depth of runoff in m
58   INTEGER,  PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   nk_rnf              !: depth of runoff in model levels
59   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   rnf_tsc_b, rnf_tsc  !: before and now T & S runoff contents   [K.m/s & PSU.m/s]   
60
61   TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:) ::   sf_rnf       ! structure: river runoff (file information, fields read)
62   TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:) ::   sf_s_rnf     ! structure: river runoff salinity (file information, fields read) 
63   TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:) ::   sf_t_rnf     ! structure: river runoff temperature (file information, fields read) 
64 
65   !! * Substitutions 
66#  include "domzgr_substitute.h90" 
67   !!----------------------------------------------------------------------
68   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
69   !! $Id$
70   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
71   !!----------------------------------------------------------------------
72CONTAINS
73
74   INTEGER FUNCTION sbc_rnf_alloc()
75      !!----------------------------------------------------------------------
76      !!                ***  ROUTINE sbc_rnf_alloc  ***
77      !!----------------------------------------------------------------------
78      ALLOCATE( rnfmsk(jpi,jpj)         , rnfmsk_z(jpk)          ,     &
79         &      h_rnf (jpi,jpj)         , nk_rnf  (jpi,jpj)      ,     &
80         &      rnf_tsc_b(jpi,jpj,jpts) , rnf_tsc (jpi,jpj,jpts) , STAT=sbc_rnf_alloc )
81         !
82      IF( lk_mpp            )   CALL mpp_sum ( sbc_rnf_alloc )
83      IF( sbc_rnf_alloc > 0 )   CALL ctl_warn('sbc_rnf_alloc: allocation of arrays failed')
84   END FUNCTION sbc_rnf_alloc
85
86
87   SUBROUTINE sbc_rnf( kt )
88      !!----------------------------------------------------------------------
89      !!                  ***  ROUTINE sbc_rnf  ***
90      !!
91      !! ** Purpose :   Introduce a climatological run off forcing
92      !!
93      !! ** Method  :   Set each river mouth with a monthly climatology
94      !!                provided from different data.
95      !!                CAUTION : upward water flux, runoff forced to be < 0
96      !!
97      !! ** Action  :   runoff updated runoff field at time-step kt
98      !!----------------------------------------------------------------------
99      INTEGER, INTENT(in) ::   kt          ! ocean time step
100      !
101      INTEGER  ::   ji, jj    ! dummy loop indices
102      INTEGER  ::   z_err = 0 ! dummy integer for error handling
103      !!----------------------------------------------------------------------
104      REAL(wp), DIMENSION(:,:), POINTER       ::   ztfrz   ! freezing point used for temperature correction
105      !
106      CALL wrk_alloc( jpi,jpj, ztfrz)
107
108      !
109      IF( kt == nit000 )   CALL sbc_rnf_init                           ! Read namelist and allocate structures
110
111      !                                            ! ---------------------------------------- !
112      IF( kt /= nit000 ) THEN                      !          Swap of forcing fields          !
113         !                                         ! ---------------------------------------- !
114         rnf_b    (:,:  ) = rnf    (:,:  )               ! Swap the ocean forcing fields except at nit000
115         rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)               ! where before fields are set at the end of the routine
116         !
117      ENDIF
118
119      !                                            !-------------------!
120      !                                            !   Update runoff   !
121      !                                            !-------------------!
122      !
123      IF( .NOT. l_rnfcpl )   CALL fld_read ( kt, nn_fsbc, sf_rnf   )    ! Read Runoffs data and provide it at kt
124      IF(   ln_rnf_tem   )   CALL fld_read ( kt, nn_fsbc, sf_t_rnf )    ! idem for runoffs temperature if required
125      IF(   ln_rnf_sal   )   CALL fld_read ( kt, nn_fsbc, sf_s_rnf )    ! idem for runoffs salinity    if required
126      !
127      ! Runoff reduction only associated to the ORCA2_LIM configuration
128      ! when reading the NetCDF file runoff_1m_nomask.nc
129      IF( cp_cfg == 'orca' .AND. jp_cfg == 2 .AND. .NOT. l_rnfcpl )   THEN
130         WHERE( 40._wp < gphit(:,:) .AND. gphit(:,:) < 65._wp )
131            sf_rnf(1)%fnow(:,:,1) = 0.85 * sf_rnf(1)%fnow(:,:,1)
132         END WHERE
133      ENDIF
134      !
135      IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
136         !
137         IF( .NOT. l_rnfcpl )   rnf(:,:) = rn_rfact * ( sf_rnf(1)%fnow(:,:,1) )       ! updated runoff value at time step kt
138         !
139         !                                                     ! set temperature & salinity content of runoffs
140         IF( ln_rnf_tem ) THEN                                       ! use runoffs temperature data
141            rnf_tsc(:,:,jp_tem) = ( sf_t_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
142            WHERE( sf_t_rnf(1)%fnow(:,:,1) == -999._wp )             ! if missing data value use SST as runoffs temperature
143               rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
144            END WHERE
145            WHERE( sf_t_rnf(1)%fnow(:,:,1) == -222._wp )             ! where fwf comes from melting of ice shelves or iceberg
146               ztfrz(:,:) = -1.9 !tfreez( sss_m(:,:) ) !PM to be discuss (trouble if sensitivity study)
147               rnf_tsc(:,:,jp_tem) = ztfrz(:,:) * rnf(:,:) * r1_rau0 - rnf(:,:) * lfusisf * r1_rau0_rcp
148            END WHERE
149         ELSE                                                        ! use SST as runoffs temperature
150            rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rau0
151         ENDIF
152         !                                                           ! use runoffs salinity data
153         IF( ln_rnf_sal )   rnf_tsc(:,:,jp_sal) = ( sf_s_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rau0
154         !                                                           ! else use S=0 for runoffs (done one for all in the init)
155         CALL iom_put( "runoffs", rnf )         ! output runoffs arrays
156      ENDIF
157      !
158      !                                                ! ---------------------------------------- !
159      IF( kt == nit000 ) THEN                          !   set the forcing field at nit000 - 1    !
160         !                                             ! ---------------------------------------- !
161         IF( ln_rstart .AND.    &                               !* Restart: read in restart file
162            & iom_varid( numror, 'rnf_b', ldstop = .FALSE. ) > 0 ) THEN
163            IF(lwp) WRITE(numout,*) '          nit000-1 runoff forcing fields red in the restart file'
164            CALL iom_get( numror, jpdom_autoglo, 'rnf_b', rnf_b )     ! before runoff
165            CALL iom_get( numror, jpdom_autoglo, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem) )   ! before heat content of runoff
166            CALL iom_get( numror, jpdom_autoglo, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal) )   ! before salinity content of runoff
167         ELSE                                                   !* no restart: set from nit000 values
168            IF(lwp) WRITE(numout,*) '          nit000-1 runoff forcing fields set to nit000'
169            rnf_b    (:,:  ) = rnf    (:,:  )
170            rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
171         ENDIF
172      ENDIF
173      !                                                ! ---------------------------------------- !
174      IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
175         !                                             ! ---------------------------------------- !
176         IF(lwp) WRITE(numout,*)
177         IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ',   &
178            &                    'at it= ', kt,' date= ', ndastp
179         IF(lwp) WRITE(numout,*) '~~~~'
180         CALL iom_rstput( kt, nitrst, numrow, 'rnf_b' , rnf )
181         CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem) )
182         CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal) )
183      ENDIF
184      !
185      CALL wrk_dealloc( jpi,jpj, ztfrz)
186      !
187   END SUBROUTINE sbc_rnf
188
189
190   SUBROUTINE sbc_rnf_div( phdivn )
191      !!----------------------------------------------------------------------
192      !!                  ***  ROUTINE sbc_rnf  ***
193      !!
194      !! ** Purpose :   update the horizontal divergence with the runoff inflow
195      !!
196      !! ** Method  :
197      !!                CAUTION : rnf is positive (inflow) decreasing the
198      !!                          divergence and expressed in m/s
199      !!
200      !! ** Action  :   phdivn   decreased by the runoff inflow
201      !!----------------------------------------------------------------------
202      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   phdivn   ! horizontal divergence
203      !!
204      INTEGER  ::   ji, jj, jk   ! dummy loop indices
205      REAL(wp) ::   zfact     ! local scalar
206      !!----------------------------------------------------------------------
207      !
208      zfact = 0.5_wp
209      !
210      IF( ln_rnf_depth ) THEN      !==   runoff distributed over several levels   ==!
211         IF( lk_vvl ) THEN             ! variable volume case
212            DO jj = 1, jpj                   ! update the depth over which runoffs are distributed
213               DO ji = 1, jpi
214                  h_rnf(ji,jj) = 0._wp
215                  DO jk = 1, nk_rnf(ji,jj)                           ! recalculates h_rnf to be the depth in metres
216                     h_rnf(ji,jj) = h_rnf(ji,jj) + fse3t(ji,jj,jk)   ! to the bottom of the relevant grid box
217                  END DO
218                  !                          ! apply the runoff input flow
219                  DO jk = 1, nk_rnf(ji,jj)
220                     phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
221                  END DO
222               END DO
223            END DO
224         ELSE                          ! constant volume case : just apply the runoff input flow
225            DO jj = 1, jpj
226               DO ji = 1, jpi
227                  DO jk = 1, nk_rnf(ji,jj)
228                     phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rau0 / h_rnf(ji,jj)
229                  END DO
230               END DO
231            END DO
232         ENDIF
233      ELSE                       !==   runoff put only at the surface   ==!
234         IF( lk_vvl ) THEN              ! variable volume case
235            h_rnf(:,:) = fse3t(:,:,1)   ! recalculate h_rnf to be depth of top box
236         ENDIF
237         phdivn(:,:,1) = phdivn(:,:,1) - ( rnf(:,:) + rnf_b(:,:) ) * zfact * r1_rau0 / fse3t(:,:,1)
238      ENDIF
239      !
240   END SUBROUTINE sbc_rnf_div
241
242
243   SUBROUTINE sbc_rnf_init
244      !!----------------------------------------------------------------------
245      !!                  ***  ROUTINE sbc_rnf_init  ***
246      !!
247      !! ** Purpose :   Initialisation of the runoffs if (ln_rnf=T)
248      !!
249      !! ** Method  : - read the runoff namsbc_rnf namelist
250      !!
251      !! ** Action  : - read parameters
252      !!----------------------------------------------------------------------
253      CHARACTER(len=32) ::   rn_dep_file   ! runoff file name
254      INTEGER           ::   ji, jj, jk    ! dummy loop indices
255      INTEGER           ::   ierror, inum  ! temporary integer
256      INTEGER           ::   ios           ! Local integer output status for namelist read
257      !
258      NAMELIST/namsbc_rnf/ cn_dir            , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal,   &
259         &                 sn_rnf, sn_cnf    , sn_s_rnf    , sn_t_rnf  , sn_dep_rnf,   &
260         &                 ln_rnf_mouth      , rn_hrnf     , rn_avt_rnf, rn_rfact
261      !!----------------------------------------------------------------------
262      !
263      !                                   ! ============
264      !                                   !   Namelist
265      !                                   ! ============
266      !
267      REWIND( numnam_ref )              ! Namelist namsbc_rnf in reference namelist : Runoffs
268      READ  ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
269901   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist', lwp )
270
271      REWIND( numnam_cfg )              ! Namelist namsbc_rnf in configuration namelist : Runoffs
272      READ  ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
273902   IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist', lwp )
274      IF(lwm) WRITE ( numond, namsbc_rnf )
275      !
276      !                                         ! Control print
277      IF(lwp) THEN
278         WRITE(numout,*)
279         WRITE(numout,*) 'sbc_rnf : runoff '
280         WRITE(numout,*) '~~~~~~~ '
281         WRITE(numout,*) '   Namelist namsbc_rnf'
282         WRITE(numout,*) '      specific river mouths treatment            ln_rnf_mouth = ', ln_rnf_mouth
283         WRITE(numout,*) '      river mouth additional Kz                  rn_avt_rnf   = ', rn_avt_rnf
284         WRITE(numout,*) '      depth of river mouth additional mixing     rn_hrnf      = ', rn_hrnf
285         WRITE(numout,*) '      multiplicative factor for runoff           rn_rfact     = ', rn_rfact
286      ENDIF
287      !                                   ! ==================
288      !                                   !   Type of runoff
289      !                                   ! ==================
290      !                                         !==  allocate runoff arrays
291      IF( sbc_rnf_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
292      !
293      IF( .NOT. l_rnfcpl ) THEN                   
294         ALLOCATE( sf_rnf(1), STAT=ierror )      ! Create (if required) sf_rnf structure (runoff inflow)
295         IF(lwp) WRITE(numout,*)
296         IF(lwp) WRITE(numout,*) '          runoffs inflow read in a file'
297         IF( ierror > 0 ) THEN
298            CALL ctl_stop( 'sbc_rnf: unable to allocate sf_rnf structure' )   ;   RETURN
299         ENDIF
300         ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1)   )
301         IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
302         CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf' )
303      ENDIF
304      !
305      IF( ln_rnf_tem ) THEN                      ! Create (if required) sf_t_rnf structure
306         IF(lwp) WRITE(numout,*)
307         IF(lwp) WRITE(numout,*) '          runoffs temperatures read in a file'
308         ALLOCATE( sf_t_rnf(1), STAT=ierror  )
309         IF( ierror > 0 ) THEN
310            CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' )   ;   RETURN
311         ENDIF
312         ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1)   )
313         IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
314         CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf' )
315      ENDIF
316      !
317      IF( ln_rnf_sal  ) THEN                     ! Create (if required) sf_s_rnf and sf_t_rnf structures
318         IF(lwp) WRITE(numout,*)
319         IF(lwp) WRITE(numout,*) '          runoffs salinities read in a file'
320         ALLOCATE( sf_s_rnf(1), STAT=ierror  )
321         IF( ierror > 0 ) THEN
322            CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' )   ;   RETURN
323         ENDIF
324         ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1)   )
325         IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
326         CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf' )
327      ENDIF
328      !
329      IF( ln_rnf_depth ) THEN                    ! depth of runoffs set from a file
330         IF(lwp) WRITE(numout,*)
331         IF(lwp) WRITE(numout,*) '          runoffs depth read in a file'
332         rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
333         IF( .NOT. sn_dep_rnf%ln_clim ) THEN   ;   WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear    ! add year
334            IF( sn_dep_rnf%cltype == 'monthly' )   WRITE(rn_dep_file, '(a,"m",i2)'  ) TRIM( rn_dep_file ), nmonth   ! add month
335         ENDIF
336         CALL iom_open ( rn_dep_file, inum )                           ! open file
337         CALL iom_get  ( inum, jpdom_data, sn_dep_rnf%clvar, h_rnf )   ! read the river mouth array
338         CALL iom_close( inum )                                        ! close file
339         !
340         nk_rnf(:,:) = 0                               ! set the number of level over which river runoffs are applied
341         DO jj = 1, jpj
342            DO ji = 1, jpi
343               IF( h_rnf(ji,jj) > 0._wp ) THEN
344                  jk = 2
345                  DO WHILE ( jk /= mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ;  jk = jk + 1
346                  END DO
347                  nk_rnf(ji,jj) = jk
348               ELSEIF( h_rnf(ji,jj) == -1._wp   ) THEN   ;  nk_rnf(ji,jj) = 1
349               ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN   ;  nk_rnf(ji,jj) = mbkt(ji,jj)
350               ELSE
351                  CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999'  )
352                  WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
353               ENDIF
354            END DO
355         END DO
356         DO jj = 1, jpj                                ! set the associated depth
357            DO ji = 1, jpi
358               h_rnf(ji,jj) = 0._wp
359               DO jk = 1, nk_rnf(ji,jj)
360                  h_rnf(ji,jj) = h_rnf(ji,jj) + fse3t(ji,jj,jk)
361               END DO
362            END DO
363         END DO
364      ELSE                                       ! runoffs applied at the surface
365         nk_rnf(:,:) = 1
366         h_rnf (:,:) = fse3t(:,:,1)
367      ENDIF
368      !
369      rnf(:,:) =  0._wp                         ! runoff initialisation
370      rnf_tsc(:,:,:) = 0._wp                    ! runoffs temperature & salinty contents initilisation
371      !
372      !                                   ! ========================
373      !                                   !   River mouth vicinity
374      !                                   ! ========================
375      !
376      IF( ln_rnf_mouth ) THEN                   ! Specific treatment in vicinity of river mouths :
377         !                                      !    - Increase Kz in surface layers ( rn_hrnf > 0 )
378         !                                      !    - set to zero SSS damping (ln_ssr=T)
379         !                                      !    - mixed upstream-centered (ln_traadv_cen2=T)
380         !
381         IF ( ln_rnf_depth )   CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already',   &
382            &                                              'be spread through depth by ln_rnf_depth'               )
383         !
384         nkrnf = 0                                  ! Number of level over which Kz increase
385         IF( rn_hrnf > 0._wp ) THEN
386            nkrnf = 2
387            DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf )   ;   nkrnf = nkrnf + 1
388            END DO
389            IF( ln_sco )   CALL ctl_warn( 'sbc_rnf: number of levels over which Kz is increased is computed for zco...' )
390         ENDIF
391            IF(lwp) WRITE(numout,*)
392            IF(lwp) WRITE(numout,*) '          Specific treatment used in vicinity of river mouths :'
393            IF(lwp) WRITE(numout,*) '             - Increase Kz in surface layers (if rn_hrnf > 0 )'
394            IF(lwp) WRITE(numout,*) '               by ', rn_avt_rnf,' m2/s  over ', nkrnf, ' w-levels'
395            IF(lwp) WRITE(numout,*) '             - set to zero SSS damping       (if ln_ssr=T)'
396            IF(lwp) WRITE(numout,*) '             - mixed upstream-centered       (if ln_traadv_cen2=T)'
397            !
398            CALL rnf_mouth                             ! set river mouth mask
399            !
400         ELSE                                      ! No treatment at river mouths
401            IF(lwp) WRITE(numout,*)
402            IF(lwp) WRITE(numout,*) '          No specific treatment at river mouths'
403            rnfmsk  (:,:) = 0._wp
404            rnfmsk_z(:)   = 0._wp
405            nkrnf = 0
406         ENDIF
407         !
408      END SUBROUTINE sbc_rnf_init
409
410
411   SUBROUTINE rnf_mouth
412      !!----------------------------------------------------------------------
413      !!                  ***  ROUTINE rnf_mouth  ***
414      !!
415      !! ** Purpose :   define the river mouths mask
416      !!
417      !! ** Method  :   read the river mouth mask (=0/1) in the river runoff
418      !!                climatological file. Defined a given vertical structure.
419      !!                CAUTION, the vertical structure is hard coded on the
420      !!                first 5 levels.
421      !!                This fields can be used to:
422      !!                 - set an upstream advection scheme
423      !!                   (ln_rnf_mouth=T and ln_traadv_cen2=T)
424      !!                 - increase vertical on the top nn_krnf vertical levels
425      !!                   at river runoff input grid point (nn_krnf>=2, see step.F90)
426      !!                 - set to zero SSS restoring flux at river mouth grid points
427      !!
428      !! ** Action  :   rnfmsk   set to 1 at river runoff input, 0 elsewhere
429      !!                rnfmsk_z vertical structure
430      !!----------------------------------------------------------------------
431      INTEGER            ::   inum        ! temporary integers
432      CHARACTER(len=140) ::   cl_rnfile   ! runoff file name
433      !!----------------------------------------------------------------------
434      !
435      IF(lwp) WRITE(numout,*)
436      IF(lwp) WRITE(numout,*) 'rnf_mouth : river mouth mask'
437      IF(lwp) WRITE(numout,*) '~~~~~~~~~ '
438      !
439      cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
440      IF( .NOT. sn_cnf%ln_clim ) THEN   ;   WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear    ! add year
441         IF( sn_cnf%cltype == 'monthly' )   WRITE(cl_rnfile, '(a,"m",i2)'  ) TRIM( cl_rnfile ), nmonth   ! add month
442      ENDIF
443      !
444      ! horizontal mask (read in NetCDF file)
445      CALL iom_open ( cl_rnfile, inum )                           ! open file
446      CALL iom_get  ( inum, jpdom_data, sn_cnf%clvar, rnfmsk )    ! read the river mouth array
447      CALL iom_close( inum )                                      ! close file
448      !
449      IF( nn_closea == 1 )   CALL clo_rnf( rnfmsk )               ! closed sea inflow set as ruver mouth
450      !
451      rnfmsk_z(:)   = 0._wp                                       ! vertical structure
452      rnfmsk_z(1)   = 1.0
453      rnfmsk_z(2)   = 1.0                                         ! **********
454      rnfmsk_z(3)   = 0.5                                         ! HARD CODED on the 5 first levels
455      rnfmsk_z(4)   = 0.25                                        ! **********
456      rnfmsk_z(5)   = 0.125
457      !
458   END SUBROUTINE rnf_mouth
459
460   !!======================================================================
461END MODULE sbcrnf
Note: See TracBrowser for help on using the repository browser.