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 NEMO/branches/2021/ticket2607_r14608_halo1_halo2_compatibility/src/OCE/SBC – NEMO

source: NEMO/branches/2021/ticket2607_r14608_halo1_halo2_compatibility/src/OCE/SBC/sbcrnf.F90 @ 14807

Last change on this file since 14807 was 14807, checked in by hadcv, 3 years ago

#2607: Merge in trunk changes to r14778 (ticket2607_r14608_halo1_halo2_compatibility branch)

  • Property svn:keywords set to Id
File size: 30.2 KB
RevLine 
[888]1MODULE sbcrnf
2   !!======================================================================
3   !!                       ***  MODULE  sbcrnf  ***
4   !! Ocean forcing:  river runoff
5   !!=====================================================================
[2528]6   !! History :  OPA  ! 2000-11  (R. Hordoir, E. Durand)  NetCDF FORMAT
7   !!   NEMO     1.0  ! 2002-09  (G. Madec)  F90: Free form and module
[3764]8   !!            3.0  ! 2006-07  (G. Madec)  Surface module
[2528]9   !!            3.2  ! 2009-04  (B. Lemaire)  Introduce iom_put
10   !!            3.3  ! 2010-10  (R. Furner, G. Madec) runoff distributed over ocean levels
[888]11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
[6140]14   !!   sbc_rnf       : monthly runoffs read in a NetCDF file
15   !!   sbc_rnf_init  : runoffs initialisation
16   !!   rnf_mouth     : set river mouth mask
[888]17   !!----------------------------------------------------------------------
[6140]18   USE dom_oce        ! ocean space and time domain
19   USE phycst         ! physical constants
20   USE sbc_oce        ! surface boundary condition variables
21   USE eosbn2         ! Equation Of State
[12276]22   USE closea, ONLY: l_clo_rnf, clo_rnf ! closed seas
[6140]23   !
24   USE in_out_manager ! I/O manager
25   USE fldread        ! read input field at current time step
26   USE iom            ! I/O module
27   USE lib_mpp        ! MPP library
[888]28
29   IMPLICIT NONE
30   PRIVATE
31
[6140]32   PUBLIC   sbc_rnf       ! called in sbcmod module
33   PUBLIC   sbc_rnf_div   ! called in divhor module
34   PUBLIC   sbc_rnf_alloc ! called in sbcmod module
35   PUBLIC   sbc_rnf_init  ! called in sbcmod module
[14072]36
[6140]37   !                                                !!* namsbc_rnf namelist *
38   CHARACTER(len=100)         ::   cn_dir            !: Root directory for location of rnf files
[9023]39   LOGICAL           , PUBLIC ::   ln_rnf_depth      !: depth       river runoffs attribute specified in a file
[6140]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 =T)
42   REAL(wp)                   ::      rn_dep_max        !: depth over which runoffs is spread       (ln_rnf_depth_ini =T)
43   INTEGER                    ::      nn_rnf_depth_file !: create (=1) a runoff depth file or not (=0)
[14032]44   LOGICAL           , PUBLIC ::   ln_rnf_icb        !: iceberg flux is specified in a file
[6140]45   LOGICAL                    ::   ln_rnf_tem        !: temperature river runoffs attribute specified in a file
46   LOGICAL           , PUBLIC ::   ln_rnf_sal        !: salinity    river runoffs attribute specified in a file
47   TYPE(FLD_N)       , PUBLIC ::   sn_rnf            !: information about the runoff file to be read
48   TYPE(FLD_N)                ::   sn_cnf            !: information about the runoff mouth file to be read
[12276]49   TYPE(FLD_N)                ::   sn_i_rnf        !: information about the iceberg flux file to be read
[6140]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
[888]57
[6140]58   LOGICAL , PUBLIC ::   l_rnfcpl = .false.   !: runoffs recieved from oasis
59   INTEGER , PUBLIC ::   nkrnf = 0            !: nb of levels over which Kz is increased at river mouths
[14072]60
[2715]61   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   rnfmsk              !: river mouth mask (hori.)
62   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:)     ::   rnfmsk_z            !: river mouth mask (vert.)
63   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   h_rnf               !: depth of runoff in m
64   INTEGER,  PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:)   ::   nk_rnf              !: depth of runoff in model levels
[14072]65   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   rnf_tsc_b, rnf_tsc  !: before and now T & S runoff contents   [K.m/s & PSU.m/s]
[888]66
[5431]67   TYPE(FLD),        ALLOCATABLE, DIMENSION(:) ::   sf_rnf       ! structure: river runoff (file information, fields read)
[12276]68   TYPE(FLD),        ALLOCATABLE, DIMENSION(:) ::   sf_i_rnf     ! structure: iceberg flux (file information, fields read)
[14072]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
[12377]72   !! * Substitutions
73#  include "do_loop_substitute.h90"
[13237]74#  include "domzgr_substitute.h90"
[888]75   !!----------------------------------------------------------------------
[9598]76   !! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1146]77   !! $Id$
[10068]78   !! Software governed by the CeCILL license (see ./LICENSE)
[888]79   !!----------------------------------------------------------------------
80CONTAINS
81
[2715]82   INTEGER FUNCTION sbc_rnf_alloc()
83      !!----------------------------------------------------------------------
84      !!                ***  ROUTINE sbc_rnf_alloc  ***
85      !!----------------------------------------------------------------------
86      ALLOCATE( rnfmsk(jpi,jpj)         , rnfmsk_z(jpk)          ,     &
87         &      h_rnf (jpi,jpj)         , nk_rnf  (jpi,jpj)      ,     &
88         &      rnf_tsc_b(jpi,jpj,jpts) , rnf_tsc (jpi,jpj,jpts) , STAT=sbc_rnf_alloc )
89         !
[10425]90      CALL mpp_sum ( 'sbcrnf', sbc_rnf_alloc )
[2715]91      IF( sbc_rnf_alloc > 0 )   CALL ctl_warn('sbc_rnf_alloc: allocation of arrays failed')
92   END FUNCTION sbc_rnf_alloc
93
[3625]94
[888]95   SUBROUTINE sbc_rnf( kt )
96      !!----------------------------------------------------------------------
97      !!                  ***  ROUTINE sbc_rnf  ***
[3764]98      !!
[888]99      !! ** Purpose :   Introduce a climatological run off forcing
100      !!
[3764]101      !! ** Method  :   Set each river mouth with a monthly climatology
[888]102      !!                provided from different data.
103      !!                CAUTION : upward water flux, runoff forced to be < 0
104      !!
105      !! ** Action  :   runoff updated runoff field at time-step kt
106      !!----------------------------------------------------------------------
107      INTEGER, INTENT(in) ::   kt          ! ocean time step
[3625]108      !
[7753]109      INTEGER  ::   ji, jj    ! dummy loop indices
110      INTEGER  ::   z_err = 0 ! dummy integer for error handling
[888]111      !!----------------------------------------------------------------------
[9125]112      REAL(wp), DIMENSION(jpi,jpj) ::   ztfrz   ! freezing point used for temperature correction
[3764]113      !
[6460]114      !
[5407]115      !                                            !-------------------!
116      !                                            !   Update runoff   !
117      !                                            !-------------------!
118      !
[12276]119      !
120      IF( .NOT. l_rnfcpl )  THEN
121                            CALL fld_read ( kt, nn_fsbc, sf_rnf   )    ! Read Runoffs data and provide it at kt ( runoffs + iceberg )
122         IF( ln_rnf_icb )   CALL fld_read ( kt, nn_fsbc, sf_i_rnf )    ! idem for iceberg flux if required
123      ENDIF
[5407]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      IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
[888]128         !
[12276]129         IF( .NOT. l_rnfcpl ) THEN
130             rnf(:,:) = rn_rfact * ( sf_rnf(1)%fnow(:,:,1) ) * tmask(:,:,1)  ! updated runoff value at time step kt
131             IF( ln_rnf_icb ) THEN
132                fwficb(:,:) = rn_rfact * ( sf_i_rnf(1)%fnow(:,:,1) ) * tmask(:,:,1)  ! updated runoff value at time step kt
[14807]133                rnf(:,:) = rnf(:,:) + fwficb(:,:)
134                qns(:,:) = qns(:,:) - fwficb(:,:) * rLfus
135                !!qns_tot(:,:) = qns_tot(:,:) - fwficb(:,:) * rLfus               
136                !!qns_oce(:,:) = qns_oce(:,:) - fwficb(:,:) * rLfus               
137                CALL iom_put( 'iceberg_cea'  ,  fwficb(:,:)  )          ! output iceberg flux
138                CALL iom_put( 'hflx_icb_cea' , -fwficb(:,:) * rLfus )   ! output Heat Flux into Sea Water due to Iceberg Thermodynamics -->
[12276]139             ENDIF
140         ENDIF
[2528]141         !
[9023]142         !                                                           ! set temperature & salinity content of runoffs
[5407]143         IF( ln_rnf_tem ) THEN                                       ! use runoffs temperature data
[12489]144            rnf_tsc(:,:,jp_tem) = ( sf_t_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rho0
[6140]145            CALL eos_fzp( sss_m(:,:), ztfrz(:,:) )
[7753]146            WHERE( sf_t_rnf(1)%fnow(:,:,1) == -999._wp )             ! if missing data value use SST as runoffs temperature
[12489]147               rnf_tsc(:,:,jp_tem) = sst_m(:,:) * rnf(:,:) * r1_rho0
[7753]148            END WHERE
[5407]149         ELSE                                                        ! use SST as runoffs temperature
[9023]150            !CEOD River is fresh water so must at least be 0 unless we consider ice
[12489]151            rnf_tsc(:,:,jp_tem) = MAX( sst_m(:,:), 0.0_wp ) * rnf(:,:) * r1_rho0
[7753]152         ENDIF
[5407]153         !                                                           ! use runoffs salinity data
[12489]154         IF( ln_rnf_sal )   rnf_tsc(:,:,jp_sal) = ( sf_s_rnf(1)%fnow(:,:,1) ) * rnf(:,:) * r1_rho0
[7753]155         !                                                           ! else use S=0 for runoffs (done one for all in the init)
[12276]156                                         CALL iom_put( 'runoffs'     , rnf(:,:)                         )   ! output runoff mass flux
[12489]157         IF( iom_use('hflx_rnf_cea') )   CALL iom_put( 'hflx_rnf_cea', rnf_tsc(:,:,jp_tem) * rho0 * rcp )   ! output runoff sensible heat (W/m2)
[14807]158         IF( iom_use('sflx_rnf_cea') )   CALL iom_put( 'sflx_rnf_cea', rnf_tsc(:,:,jp_sal) * rho0       )   ! output runoff salt flux (g/m2/s)
[2528]159      ENDIF
160      !
[5407]161      !                                                ! ---------------------------------------- !
[2528]162      IF( kt == nit000 ) THEN                          !   set the forcing field at nit000 - 1    !
163         !                                             ! ---------------------------------------- !
[14053]164         IF( ln_rstart .AND. .NOT.l_1st_euler ) THEN         !* Restart: read in restart file
[9367]165            IF(lwp) WRITE(numout,*) '          nit000-1 runoff forcing fields red in the restart file', lrxios
[14053]166            CALL iom_get( numror, jpdom_auto, 'rnf_b'   , rnf_b                 )   ! before runoff
[13970]167            CALL iom_get( numror, jpdom_auto, 'rnf_hc_b', rnf_tsc_b(:,:,jp_tem) )   ! before heat content of runoff
168            CALL iom_get( numror, jpdom_auto, 'rnf_sc_b', rnf_tsc_b(:,:,jp_sal) )   ! before salinity content of runoff
[14053]169         ELSE                                                !* no restart: set from nit000 values
[2528]170            IF(lwp) WRITE(numout,*) '          nit000-1 runoff forcing fields set to nit000'
[7753]171            rnf_b    (:,:  ) = rnf    (:,:  )
172            rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[2528]173         ENDIF
174      ENDIF
175      !                                                ! ---------------------------------------- !
176      IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
177         !                                             ! ---------------------------------------- !
178         IF(lwp) WRITE(numout,*)
179         IF(lwp) WRITE(numout,*) 'sbcrnf : runoff forcing fields written in ocean restart file ',   &
180            &                    'at it= ', kt,' date= ', ndastp
181         IF(lwp) WRITE(numout,*) '~~~~'
[14053]182         CALL iom_rstput( kt, nitrst, numrow, 'rnf_b'   , rnf                 )
[13970]183         CALL iom_rstput( kt, nitrst, numrow, 'rnf_hc_b', rnf_tsc(:,:,jp_tem) )
184         CALL iom_rstput( kt, nitrst, numrow, 'rnf_sc_b', rnf_tsc(:,:,jp_sal) )
[2528]185      ENDIF
[5407]186      !
[2528]187   END SUBROUTINE sbc_rnf
188
189
[12377]190   SUBROUTINE sbc_rnf_div( phdivn, Kmm )
[2528]191      !!----------------------------------------------------------------------
192      !!                  ***  ROUTINE sbc_rnf  ***
[3764]193      !!
[2528]194      !! ** Purpose :   update the horizontal divergence with the runoff inflow
195      !!
[3764]196      !! ** Method  :
197      !!                CAUTION : rnf is positive (inflow) decreasing the
[2528]198      !!                          divergence and expressed in m/s
199      !!
200      !! ** Action  :   phdivn   decreased by the runoff inflow
201      !!----------------------------------------------------------------------
[12377]202      INTEGER                   , INTENT(in   ) ::   Kmm      ! ocean time level index
[2715]203      REAL(wp), DIMENSION(:,:,:), INTENT(inout) ::   phdivn   ! horizontal divergence
[2528]204      !!
[7753]205      INTEGER  ::   ji, jj, jk   ! dummy loop indices
[2528]206      REAL(wp) ::   zfact     ! local scalar
207      !!----------------------------------------------------------------------
208      !
209      zfact = 0.5_wp
210      !
[5503]211      IF( ln_rnf_depth .OR. ln_rnf_depth_ini ) THEN      !==   runoff distributed over several levels   ==!
[6140]212         IF( ln_linssh ) THEN    !* constant volume case : just apply the runoff input flow
[13295]213            DO_2D( 1, 1, 1, 1 )
[12377]214               DO jk = 1, nk_rnf(ji,jj)
[12489]215                  phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rho0 / h_rnf(ji,jj)
[2528]216               END DO
[12377]217            END_2D
[6140]218         ELSE                    !* variable volume case
[13497]219            DO_2D( 1, 1, 1, 1 )              ! update the depth over which runoffs are distributed
[12377]220               h_rnf(ji,jj) = 0._wp
[13497]221               DO jk = 1, nk_rnf(ji,jj)                             ! recalculates h_rnf to be the depth in metres
[12377]222                  h_rnf(ji,jj) = h_rnf(ji,jj) + e3t(ji,jj,jk,Kmm)   ! to the bottom of the relevant grid box
[888]223               END DO
[12377]224               !                          ! apply the runoff input flow
225               DO jk = 1, nk_rnf(ji,jj)
[12489]226                  phdivn(ji,jj,jk) = phdivn(ji,jj,jk) - ( rnf(ji,jj) + rnf_b(ji,jj) ) * zfact * r1_rho0 / h_rnf(ji,jj)
[12377]227               END DO
228            END_2D
[888]229         ENDIF
[2528]230      ELSE                       !==   runoff put only at the surface   ==!
[12377]231         h_rnf (:,:)   = e3t (:,:,1,Kmm)        ! update h_rnf to be depth of top box
[12489]232         phdivn(:,:,1) = phdivn(:,:,1) - ( rnf(:,:) + rnf_b(:,:) ) * zfact * r1_rho0 / e3t(:,:,1,Kmm)
[888]233      ENDIF
234      !
[2528]235   END SUBROUTINE sbc_rnf_div
[888]236
237
[12377]238   SUBROUTINE sbc_rnf_init( Kmm )
[1116]239      !!----------------------------------------------------------------------
240      !!                  ***  ROUTINE sbc_rnf_init  ***
241      !!
242      !! ** Purpose :   Initialisation of the runoffs if (ln_rnf=T)
243      !!
244      !! ** Method  : - read the runoff namsbc_rnf namelist
245      !!
246      !! ** Action  : - read parameters
247      !!----------------------------------------------------------------------
[12377]248      INTEGER, INTENT(in) :: Kmm           ! ocean time level index
[3764]249      CHARACTER(len=32) ::   rn_dep_file   ! runoff file name
[7753]250      INTEGER           ::   ji, jj, jk, jm    ! dummy loop indices
[2528]251      INTEGER           ::   ierror, inum  ! temporary integer
[4147]252      INTEGER           ::   ios           ! Local integer output status for namelist read
[5385]253      INTEGER           ::   nbrec         ! temporary integer
[14072]254      REAL(wp)          ::   zacoef
255      REAL(wp), DIMENSION(jpi,jpj,2) :: zrnfcl
[9169]256      !!
[12276]257      NAMELIST/namsbc_rnf/ cn_dir            , ln_rnf_depth, ln_rnf_tem, ln_rnf_sal, ln_rnf_icb,   &
258         &                 sn_rnf, sn_cnf    , sn_i_rnf, sn_s_rnf    , sn_t_rnf  , sn_dep_rnf,   &
[5385]259         &                 ln_rnf_mouth      , rn_hrnf     , rn_avt_rnf, rn_rfact,     &
260         &                 ln_rnf_depth_ini  , rn_dep_max  , rn_rnf_max, nn_rnf_depth_file
[1116]261      !!----------------------------------------------------------------------
[3625]262      !
[5431]263      !                                         !==  allocate runoff arrays
264      IF( sbc_rnf_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'sbc_rnf_alloc : unable to allocate arrays' )
265      !
[14072]266      IF( .NOT. ln_rnf ) THEN                      ! no specific treatment in vicinity of river mouths
[5431]267         ln_rnf_mouth  = .FALSE.                   ! default definition needed for example by sbc_ssr or by tra_adv_muscl
268         nkrnf         = 0
[7753]269         rnf     (:,:) = 0.0_wp
270         rnf_b   (:,:) = 0.0_wp
271         rnfmsk  (:,:) = 0.0_wp
272         rnfmsk_z(:)   = 0.0_wp
[5431]273         RETURN
274      ENDIF
275      !
[1116]276      !                                   ! ============
277      !                                   !   Namelist
278      !                                   ! ============
[4147]279      !
280      READ  ( numnam_ref, namsbc_rnf, IOSTAT = ios, ERR = 901)
[11536]281901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namsbc_rnf in reference namelist' )
[1116]282
[4147]283      READ  ( numnam_cfg, namsbc_rnf, IOSTAT = ios, ERR = 902 )
[11536]284902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namsbc_rnf in configuration namelist' )
[4624]285      IF(lwm) WRITE ( numond, namsbc_rnf )
[1116]286      !
287      !                                         ! Control print
288      IF(lwp) THEN
289         WRITE(numout,*)
[7646]290         WRITE(numout,*) 'sbc_rnf_init : runoff '
291         WRITE(numout,*) '~~~~~~~~~~~~ '
[1116]292         WRITE(numout,*) '   Namelist namsbc_rnf'
293         WRITE(numout,*) '      specific river mouths treatment            ln_rnf_mouth = ', ln_rnf_mouth
294         WRITE(numout,*) '      river mouth additional Kz                  rn_avt_rnf   = ', rn_avt_rnf
295         WRITE(numout,*) '      depth of river mouth additional mixing     rn_hrnf      = ', rn_hrnf
[3764]296         WRITE(numout,*) '      multiplicative factor for runoff           rn_rfact     = ', rn_rfact
[1116]297      ENDIF
298      !                                   ! ==================
299      !                                   !   Type of runoff
300      !                                   ! ==================
301      !
[14072]302      IF( .NOT. l_rnfcpl ) THEN
[2528]303         ALLOCATE( sf_rnf(1), STAT=ierror )         ! Create sf_rnf structure (runoff inflow)
304         IF(lwp) WRITE(numout,*)
[9169]305         IF(lwp) WRITE(numout,*) '   ==>>>   runoffs inflow read in a file'
[2528]306         IF( ierror > 0 ) THEN
[7646]307            CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_rnf structure' )   ;   RETURN
[2528]308         ENDIF
309         ALLOCATE( sf_rnf(1)%fnow(jpi,jpj,1)   )
310         IF( sn_rnf%ln_tint ) ALLOCATE( sf_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]311         CALL fld_fill( sf_rnf, (/ sn_rnf /), cn_dir, 'sbc_rnf_init', 'read runoffs data', 'namsbc_rnf', no_print )
[12276]312         !
313         IF( ln_rnf_icb ) THEN                      ! Create (if required) sf_i_rnf structure
314            IF(lwp) WRITE(numout,*)
315            IF(lwp) WRITE(numout,*) '          iceberg flux read in a file'
316            ALLOCATE( sf_i_rnf(1), STAT=ierror  )
317            IF( ierror > 0 ) THEN
318               CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_i_rnf structure' )   ;   RETURN
319            ENDIF
320            ALLOCATE( sf_i_rnf(1)%fnow(jpi,jpj,1)   )
321            IF( sn_i_rnf%ln_tint ) ALLOCATE( sf_i_rnf(1)%fdta(jpi,jpj,1,2) )
322            CALL fld_fill (sf_i_rnf, (/ sn_i_rnf /), cn_dir, 'sbc_rnf_init', 'read iceberg flux data', 'namsbc_rnf' )
323         ELSE
324            fwficb(:,:) = 0._wp
325         ENDIF
326
[5407]327      ENDIF
328      !
329      IF( ln_rnf_tem ) THEN                      ! Create (if required) sf_t_rnf structure
330         IF(lwp) WRITE(numout,*)
[9169]331         IF(lwp) WRITE(numout,*) '   ==>>>   runoffs temperatures read in a file'
[5407]332         ALLOCATE( sf_t_rnf(1), STAT=ierror  )
333         IF( ierror > 0 ) THEN
334            CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_t_rnf structure' )   ;   RETURN
[2528]335         ENDIF
[5407]336         ALLOCATE( sf_t_rnf(1)%fnow(jpi,jpj,1)   )
337         IF( sn_t_rnf%ln_tint ) ALLOCATE( sf_t_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]338         CALL fld_fill (sf_t_rnf, (/ sn_t_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff temperature data', 'namsbc_rnf', no_print )
[5407]339      ENDIF
340      !
341      IF( ln_rnf_sal  ) THEN                     ! Create (if required) sf_s_rnf and sf_t_rnf structures
342         IF(lwp) WRITE(numout,*)
[9169]343         IF(lwp) WRITE(numout,*) '   ==>>>   runoffs salinities read in a file'
[5407]344         ALLOCATE( sf_s_rnf(1), STAT=ierror  )
345         IF( ierror > 0 ) THEN
346            CALL ctl_stop( 'sbc_rnf_init: unable to allocate sf_s_rnf structure' )   ;   RETURN
[2528]347         ENDIF
[5407]348         ALLOCATE( sf_s_rnf(1)%fnow(jpi,jpj,1)   )
349         IF( sn_s_rnf%ln_tint ) ALLOCATE( sf_s_rnf(1)%fdta(jpi,jpj,1,2) )
[7646]350         CALL fld_fill (sf_s_rnf, (/ sn_s_rnf /), cn_dir, 'sbc_rnf_init', 'read runoff salinity data', 'namsbc_rnf', no_print )
[5407]351      ENDIF
352      !
353      IF( ln_rnf_depth ) THEN                    ! depth of runoffs set from a file
354         IF(lwp) WRITE(numout,*)
[9169]355         IF(lwp) WRITE(numout,*) '   ==>>>   runoffs depth read in a file'
[5407]356         rn_dep_file = TRIM( cn_dir )//TRIM( sn_dep_rnf%clname )
[14072]357         IF( .NOT. sn_dep_rnf%ln_clim ) THEN   ;   WRITE(rn_dep_file, '(a,"_y",i4)' ) TRIM( rn_dep_file ), nyear    ! add year
358            IF( sn_dep_rnf%clftyp == 'monthly' )   WRITE(rn_dep_file, '(a,"m",i2)'  ) TRIM( rn_dep_file ), nmonth   ! add month
[5407]359         ENDIF
[13286]360         CALL iom_open ( rn_dep_file, inum )                             ! open file
361         CALL iom_get  ( inum, jpdom_global, sn_dep_rnf%clvar, h_rnf )   ! read the river mouth array
362         CALL iom_close( inum )                                          ! close file
[2528]363         !
[7753]364         nk_rnf(:,:) = 0                               ! set the number of level over which river runoffs are applied
[13295]365         DO_2D( 1, 1, 1, 1 )
[12377]366            IF( h_rnf(ji,jj) > 0._wp ) THEN
367               jk = 2
368               DO WHILE ( jk < mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ;  jk = jk + 1
[2528]369               END DO
[12377]370               nk_rnf(ji,jj) = jk
371            ELSEIF( h_rnf(ji,jj) == -1._wp   ) THEN   ;  nk_rnf(ji,jj) = 1
372            ELSEIF( h_rnf(ji,jj) == -999._wp ) THEN   ;  nk_rnf(ji,jj) = mbkt(ji,jj)
373            ELSE
374               CALL ctl_stop( 'sbc_rnf_init: runoff depth not positive, and not -999 or -1, rnf value in file fort.999'  )
375               WRITE(999,*) 'ji, jj, h_rnf(ji,jj) :', ji, jj, h_rnf(ji,jj)
376            ENDIF
377         END_2D
[13497]378         DO_2D( 1, 1, 1, 1 )                           ! set the associated depth
[12377]379            h_rnf(ji,jj) = 0._wp
380            DO jk = 1, nk_rnf(ji,jj)
381               h_rnf(ji,jj) = h_rnf(ji,jj) + e3t(ji,jj,jk,Kmm)
[2528]382            END DO
[12377]383         END_2D
[5407]384         !
385      ELSE IF( ln_rnf_depth_ini ) THEN           ! runoffs applied at the surface
386         !
387         IF(lwp) WRITE(numout,*)
[9169]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
[5385]392
[5407]393         CALL iom_open( TRIM( sn_rnf%clname ), inum )    !  open runoff file
[10522]394         nbrec = iom_getszuld( inum )
[13286]395         zrnfcl(:,:,1) = 0._wp                                                            ! init the max to 0. in 1
[5407]396         DO jm = 1, nbrec
[13286]397            CALL iom_get( inum, jpdom_global, TRIM( sn_rnf%clvar ), zrnfcl(:,:,2), jm )   ! read the value in 2
398            zrnfcl(:,:,1) = MAXVAL( zrnfcl(:,:,:), DIM=3 )                                ! store the maximum value in time in 1
[5407]399         END DO
400         CALL iom_close( inum )
401         !
[7753]402         h_rnf(:,:) = 1.
403         !
[5407]404         zacoef = rn_dep_max / rn_rnf_max            ! coef of linear relation between runoff and its depth (150m for max of runoff)
405         !
[10523]406         WHERE( zrnfcl(:,:,1) > 0._wp )  h_rnf(:,:) = zacoef * zrnfcl(:,:,1)   ! compute depth for all runoffs
[5407]407         !
[13497]408         DO_2D( 1, 1, 1, 1 )                ! take in account min depth of ocean rn_hmin
[12377]409            IF( zrnfcl(ji,jj,1) > 0._wp ) THEN
410               jk = mbkt(ji,jj)
411               h_rnf(ji,jj) = MIN( h_rnf(ji,jj), gdept_0(ji,jj,jk ) )
412            ENDIF
413         END_2D
[5407]414         !
[7753]415         nk_rnf(:,:) = 0                       ! number of levels on which runoffs are distributed
[13295]416         DO_2D( 1, 1, 1, 1 )
[12377]417            IF( zrnfcl(ji,jj,1) > 0._wp ) THEN
418               jk = 2
419               DO WHILE ( jk < mbkt(ji,jj) .AND. gdept_0(ji,jj,jk) < h_rnf(ji,jj) ) ;  jk = jk + 1
420               END DO
421               nk_rnf(ji,jj) = jk
422            ELSE
423               nk_rnf(ji,jj) = 1
424            ENDIF
425         END_2D
[5407]426         !
[13497]427         DO_2D( 1, 1, 1, 1 )                          ! set the associated depth
[12377]428            h_rnf(ji,jj) = 0._wp
429            DO jk = 1, nk_rnf(ji,jj)
430               h_rnf(ji,jj) = h_rnf(ji,jj) + e3t(ji,jj,jk,Kmm)
[5385]431            END DO
[12377]432         END_2D
[5407]433         !
434         IF( nn_rnf_depth_file == 1 ) THEN      !  save  output nb levels for runoff
[9169]435            IF(lwp) WRITE(numout,*) '   ==>>>   create runoff depht file'
[10425]436            CALL iom_open  ( TRIM( sn_dep_rnf%clname ), inum, ldwrt = .TRUE. )
[5407]437            CALL iom_rstput( 0, 0, inum, 'rodepth', h_rnf )
438            CALL iom_close ( inum )
[3764]439         ENDIF
[5407]440      ELSE                                       ! runoffs applied at the surface
[7753]441         nk_rnf(:,:) = 1
[12377]442         h_rnf (:,:) = e3t(:,:,1,Kmm)
[1116]443      ENDIF
[2528]444      !
[7753]445      rnf(:,:) =  0._wp                         ! runoff initialisation
446      rnf_tsc(:,:,:) = 0._wp                    ! runoffs temperature & salinty contents initilisation
[2528]447      !
[1116]448      !                                   ! ========================
449      !                                   !   River mouth vicinity
450      !                                   ! ========================
451      !
452      IF( ln_rnf_mouth ) THEN                   ! Specific treatment in vicinity of river mouths :
453         !                                      !    - Increase Kz in surface layers ( rn_hrnf > 0 )
454         !                                      !    - set to zero SSS damping (ln_ssr=T)
455         !                                      !    - mixed upstream-centered (ln_traadv_cen2=T)
456         !
[12276]457         IF( ln_rnf_depth )   CALL ctl_warn( 'sbc_rnf_init: increased mixing turned on but effects may already',   &
[3764]458            &                                              'be spread through depth by ln_rnf_depth'               )
[2528]459         !
460         nkrnf = 0                                  ! Number of level over which Kz increase
461         IF( rn_hrnf > 0._wp ) THEN
[1116]462            nkrnf = 2
[5407]463            DO WHILE( nkrnf /= jpkm1 .AND. gdepw_1d(nkrnf+1) < rn_hrnf )   ;   nkrnf = nkrnf + 1
464            END DO
[7646]465            IF( ln_sco )   CALL ctl_warn( 'sbc_rnf_init: number of levels over which Kz is increased is computed for zco...' )
[1116]466         ENDIF
467         IF(lwp) WRITE(numout,*)
[9169]468         IF(lwp) WRITE(numout,*) '   ==>>>   Specific treatment used in vicinity of river mouths :'
[1116]469         IF(lwp) WRITE(numout,*) '             - Increase Kz in surface layers (if rn_hrnf > 0 )'
470         IF(lwp) WRITE(numout,*) '               by ', rn_avt_rnf,' m2/s  over ', nkrnf, ' w-levels'
471         IF(lwp) WRITE(numout,*) '             - set to zero SSS damping       (if ln_ssr=T)'
472         IF(lwp) WRITE(numout,*) '             - mixed upstream-centered       (if ln_traadv_cen2=T)'
473         !
474         CALL rnf_mouth                             ! set river mouth mask
475         !
476      ELSE                                      ! No treatment at river mouths
477         IF(lwp) WRITE(numout,*)
[9169]478         IF(lwp) WRITE(numout,*) '   ==>>>   No specific treatment at river mouths'
[7753]479         rnfmsk  (:,:) = 0._wp
480         rnfmsk_z(:)   = 0._wp
[1116]481         nkrnf = 0
482      ENDIF
[3625]483      !
[1116]484   END SUBROUTINE sbc_rnf_init
485
486
[888]487   SUBROUTINE rnf_mouth
488      !!----------------------------------------------------------------------
489      !!                  ***  ROUTINE rnf_mouth  ***
[3764]490      !!
[888]491      !! ** Purpose :   define the river mouths mask
492      !!
493      !! ** Method  :   read the river mouth mask (=0/1) in the river runoff
[3764]494      !!                climatological file. Defined a given vertical structure.
495      !!                CAUTION, the vertical structure is hard coded on the
[888]496      !!                first 5 levels.
497      !!                This fields can be used to:
[3764]498      !!                 - set an upstream advection scheme
[1116]499      !!                   (ln_rnf_mouth=T and ln_traadv_cen2=T)
[3764]500      !!                 - increase vertical on the top nn_krnf vertical levels
[888]501      !!                   at river runoff input grid point (nn_krnf>=2, see step.F90)
502      !!                 - set to zero SSS restoring flux at river mouth grid points
503      !!
504      !! ** Action  :   rnfmsk   set to 1 at river runoff input, 0 elsewhere
505      !!                rnfmsk_z vertical structure
506      !!----------------------------------------------------------------------
[2784]507      INTEGER            ::   inum        ! temporary integers
508      CHARACTER(len=140) ::   cl_rnfile   ! runoff file name
[888]509      !!----------------------------------------------------------------------
[3764]510      !
[888]511      IF(lwp) WRITE(numout,*)
[7646]512      IF(lwp) WRITE(numout,*) '   rnf_mouth : river mouth mask'
513      IF(lwp) WRITE(numout,*) '   ~~~~~~~~~ '
[3625]514      !
[1133]515      cl_rnfile = TRIM( cn_dir )//TRIM( sn_cnf%clname )
516      IF( .NOT. sn_cnf%ln_clim ) THEN   ;   WRITE(cl_rnfile, '(a,"_y",i4)' ) TRIM( cl_rnfile ), nyear    ! add year
[13286]517         IF( sn_cnf%clftyp == 'monthly' )   WRITE(cl_rnfile, '(a,"m",i2)'  ) TRIM( cl_rnfile ), nmonth   ! add month
[1133]518      ENDIF
[3625]519      !
[888]520      ! horizontal mask (read in NetCDF file)
[13286]521      CALL iom_open ( cl_rnfile, inum )                             ! open file
522      CALL iom_get  ( inum, jpdom_global, sn_cnf%clvar, rnfmsk )    ! read the river mouth array
523      CALL iom_close( inum )                                        ! close file
[3625]524      !
[9161]525      IF( l_clo_rnf )   CALL clo_rnf( rnfmsk )   ! closed sea inflow set as river mouth
[3625]526      !
[3764]527      rnfmsk_z(:)   = 0._wp                                       ! vertical structure
[888]528      rnfmsk_z(1)   = 1.0
529      rnfmsk_z(2)   = 1.0                                         ! **********
530      rnfmsk_z(3)   = 0.5                                         ! HARD CODED on the 5 first levels
531      rnfmsk_z(4)   = 0.25                                        ! **********
532      rnfmsk_z(5)   = 0.125
[3764]533      !
[888]534   END SUBROUTINE rnf_mouth
[3764]535
[888]536   !!======================================================================
537END MODULE sbcrnf
Note: See TracBrowser for help on using the repository browser.