source: branches/UKMO/AMM15_v3_6_STABLE_package_collate_coupling/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 10395

Last change on this file since 10395 was 8058, checked in by jgraham, 4 years ago

Clear keywords

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