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