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/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/test_moci_test_suite_namelist_read/NEMOGCM/NEMO/OPA_SRC/SBC/sbcrnf.F90 @ 9366

Last change on this file since 9366 was 9366, checked in by andmirek, 6 years ago

#2050 first version. Compiled OK in moci test suite

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