| 1 | MODULE sbcssr |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE sbcssr *** |
|---|
| 4 | !! Surface module : heat and fresh water fluxes a restoring term toward observed SST/SSS |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 3.0 ! 2006-06 (G. Madec) Original code |
|---|
| 7 | !! 3.2 ! 2009-04 (B. Lemaire) Introduce iom_put |
|---|
| 8 | !!---------------------------------------------------------------------- |
|---|
| 9 | |
|---|
| 10 | !!---------------------------------------------------------------------- |
|---|
| 11 | !! sbc_ssr : add to sbc a restoring term toward SST/SSS climatology |
|---|
| 12 | !! sbc_ssr_init : initialisation of surface restoring |
|---|
| 13 | !!---------------------------------------------------------------------- |
|---|
| 14 | USE oce ! ocean dynamics and tracers |
|---|
| 15 | USE dom_oce ! ocean space and time domain |
|---|
| 16 | USE sbc_oce ! surface boundary condition |
|---|
| 17 | USE phycst ! physical constants |
|---|
| 18 | USE sbcrnf ! surface boundary condition : runoffs |
|---|
| 19 | ! |
|---|
| 20 | USE fldread ! read input fields |
|---|
| 21 | USE in_out_manager ! I/O manager |
|---|
| 22 | USE iom ! I/O manager |
|---|
| 23 | USE lib_mpp ! distribued memory computing library |
|---|
| 24 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
|---|
| 25 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
|---|
| 26 | |
|---|
| 27 | IMPLICIT NONE |
|---|
| 28 | PRIVATE |
|---|
| 29 | |
|---|
| 30 | PUBLIC sbc_ssr ! routine called in sbcmod |
|---|
| 31 | PUBLIC sbc_ssr_init ! routine called in sbcmod |
|---|
| 32 | PUBLIC sbc_ssr_alloc ! routine called in sbcmod |
|---|
| 33 | |
|---|
| 34 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: erp !: evaporation damping [kg/m2/s] |
|---|
| 35 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: qrp !: heat flux damping [w/m2] |
|---|
| 36 | REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:) :: coefice !: under ice relaxation coefficient |
|---|
| 37 | |
|---|
| 38 | ! !!* Namelist namsbc_ssr * |
|---|
| 39 | INTEGER, PUBLIC :: nn_sstr ! SST/SSS restoring indicator |
|---|
| 40 | INTEGER, PUBLIC :: nn_sssr ! SST/SSS restoring indicator |
|---|
| 41 | REAL(wp) :: rn_dqdt ! restoring factor on SST and SSS |
|---|
| 42 | REAL(wp) :: rn_deds ! restoring factor on SST and SSS |
|---|
| 43 | LOGICAL :: ln_sssr_bnd ! flag to bound erp term |
|---|
| 44 | REAL(wp) :: rn_sssr_bnd ! ABS(Max./Min.) value of erp term [mm/day] |
|---|
| 45 | INTEGER :: nn_sssr_ice ! Control of restoring under ice |
|---|
| 46 | |
|---|
| 47 | REAL(wp) , ALLOCATABLE, DIMENSION(:) :: buffer ! Temporary buffer for exchange |
|---|
| 48 | TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_sst ! structure of input SST (file informations, fields read) |
|---|
| 49 | TYPE(FLD), ALLOCATABLE, DIMENSION(:) :: sf_sss ! structure of input SSS (file informations, fields read) |
|---|
| 50 | |
|---|
| 51 | !! * Substitutions |
|---|
| 52 | # include "do_loop_substitute.h90" |
|---|
| 53 | !!---------------------------------------------------------------------- |
|---|
| 54 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
|---|
| 55 | !! $Id$ |
|---|
| 56 | !! Software governed by the CeCILL license (see ./LICENSE) |
|---|
| 57 | !!---------------------------------------------------------------------- |
|---|
| 58 | CONTAINS |
|---|
| 59 | |
|---|
| 60 | SUBROUTINE sbc_ssr( kt ) |
|---|
| 61 | !!--------------------------------------------------------------------- |
|---|
| 62 | !! *** ROUTINE sbc_ssr *** |
|---|
| 63 | !! |
|---|
| 64 | !! ** Purpose : Add to heat and/or freshwater fluxes a damping term |
|---|
| 65 | !! toward observed SST and/or SSS. |
|---|
| 66 | !! |
|---|
| 67 | !! ** Method : - Read namelist namsbc_ssr |
|---|
| 68 | !! - Read observed SST and/or SSS |
|---|
| 69 | !! - at each nscb time step |
|---|
| 70 | !! add a retroaction term on qns (nn_sstr = 1) |
|---|
| 71 | !! add a damping term on sfx (nn_sssr = 1) |
|---|
| 72 | !! add a damping term on emp (nn_sssr = 2) |
|---|
| 73 | !!--------------------------------------------------------------------- |
|---|
| 74 | INTEGER, INTENT(in ) :: kt ! ocean time step |
|---|
| 75 | !! |
|---|
| 76 | INTEGER :: ji, jj ! dummy loop indices |
|---|
| 77 | REAL(wp) :: zerp ! local scalar for evaporation damping |
|---|
| 78 | REAL(wp) :: zqrp ! local scalar for heat flux damping |
|---|
| 79 | REAL(wp) :: zsrp ! local scalar for unit conversion of rn_deds factor |
|---|
| 80 | REAL(wp) :: zerp_bnd ! local scalar for unit conversion of rn_epr_max factor |
|---|
| 81 | INTEGER :: ierror ! return error code |
|---|
| 82 | !! |
|---|
| 83 | CHARACTER(len=100) :: cn_dir ! Root directory for location of ssr files |
|---|
| 84 | TYPE(FLD_N) :: sn_sst, sn_sss ! informations about the fields to be read |
|---|
| 85 | !!---------------------------------------------------------------------- |
|---|
| 86 | ! |
|---|
| 87 | IF( nn_sstr + nn_sssr /= 0 ) THEN |
|---|
| 88 | ! |
|---|
| 89 | IF( nn_sstr == 1) CALL fld_read( kt, nn_fsbc, sf_sst ) ! Read SST data and provides it at kt |
|---|
| 90 | IF( nn_sssr >= 1) CALL fld_read( kt, nn_fsbc, sf_sss ) ! Read SSS data and provides it at kt |
|---|
| 91 | ! |
|---|
| 92 | ! ! ========================= ! |
|---|
| 93 | IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN ! Add restoring term ! |
|---|
| 94 | ! ! ========================= ! |
|---|
| 95 | ! |
|---|
| 96 | qrp(:,:) = 0._wp ! necessary init |
|---|
| 97 | erp(:,:) = 0._wp |
|---|
| 98 | ! |
|---|
| 99 | IF( nn_sstr == 1 ) THEN !* Temperature restoring term |
|---|
| 100 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) |
|---|
| 101 | zqrp = rn_dqdt * ( sst_m(ji,jj) - sf_sst(1)%fnow(ji,jj,1) ) * tmask(ji,jj,1) |
|---|
| 102 | qns(ji,jj) = qns(ji,jj) + zqrp |
|---|
| 103 | qrp(ji,jj) = zqrp |
|---|
| 104 | END_2D |
|---|
| 105 | ENDIF |
|---|
| 106 | ! |
|---|
| 107 | IF( nn_sssr /= 0 .AND. nn_sssr_ice /= 1 ) THEN |
|---|
| 108 | ! use fraction of ice ( fr_i ) to adjust relaxation under ice if nn_sssr_ice .ne. 1 |
|---|
| 109 | ! n.b. coefice is initialised and fixed to 1._wp if nn_sssr_ice = 1 |
|---|
| 110 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) |
|---|
| 111 | SELECT CASE ( nn_sssr_ice ) |
|---|
| 112 | CASE ( 0 ) ; coefice(ji,jj) = 1._wp - fr_i(ji,jj) ! no/reduced damping under ice |
|---|
| 113 | CASE DEFAULT ; coefice(ji,jj) = 1._wp + ( nn_sssr_ice - 1 ) * fr_i(ji,jj) ! reinforced damping (x nn_sssr_ice) under ice ) |
|---|
| 114 | END SELECT |
|---|
| 115 | END_2D |
|---|
| 116 | ENDIF |
|---|
| 117 | ! |
|---|
| 118 | IF( nn_sssr == 1 ) THEN !* Salinity damping term (salt flux only (sfx)) |
|---|
| 119 | zsrp = rn_deds / rday ! from [mm/day] to [kg/m2/s] |
|---|
| 120 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) |
|---|
| 121 | zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) ) & ! No damping in vicinity of river mouths |
|---|
| 122 | & * coefice(ji,jj) & ! Optional control of damping under sea-ice |
|---|
| 123 | & * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj,1) ) * tmask(ji,jj,1) |
|---|
| 124 | sfx(ji,jj) = sfx(ji,jj) + zerp ! salt flux |
|---|
| 125 | erp(ji,jj) = zerp / MAX( sss_m(ji,jj), 1.e-20 ) ! converted into an equivalent volume flux (diagnostic only) |
|---|
| 126 | END_2D |
|---|
| 127 | ! |
|---|
| 128 | ELSEIF( nn_sssr == 2 ) THEN !* Salinity damping term (volume flux (emp) and associated heat flux (qns) |
|---|
| 129 | zsrp = rn_deds / rday ! from [mm/day] to [kg/m2/s] |
|---|
| 130 | zerp_bnd = rn_sssr_bnd / rday ! - - |
|---|
| 131 | DO_2D( nn_hls, nn_hls, nn_hls, nn_hls ) |
|---|
| 132 | zerp = zsrp * ( 1. - 2.*rnfmsk(ji,jj) ) & ! No damping in vicinity of river mouths |
|---|
| 133 | & * coefice(ji,jj) & ! Optional control of damping under sea-ice |
|---|
| 134 | & * ( sss_m(ji,jj) - sf_sss(1)%fnow(ji,jj,1) ) & |
|---|
| 135 | & / MAX( sss_m(ji,jj), 1.e-20 ) * tmask(ji,jj,1) |
|---|
| 136 | IF( ln_sssr_bnd ) zerp = SIGN( 1.0_wp, zerp ) * MIN( zerp_bnd, ABS(zerp) ) |
|---|
| 137 | emp(ji,jj) = emp (ji,jj) + zerp |
|---|
| 138 | qns(ji,jj) = qns(ji,jj) - zerp * rcp * sst_m(ji,jj) |
|---|
| 139 | erp(ji,jj) = zerp |
|---|
| 140 | qrp(ji,jj) = qrp(ji,jj) - zerp * rcp * sst_m(ji,jj) |
|---|
| 141 | END_2D |
|---|
| 142 | ENDIF |
|---|
| 143 | ! outputs |
|---|
| 144 | CALL iom_put( 'hflx_ssr_cea', qrp(:,:) ) |
|---|
| 145 | IF( nn_sssr == 1 ) CALL iom_put( 'sflx_ssr_cea', erp(:,:) * sss_m(:,:) ) |
|---|
| 146 | IF( nn_sssr == 2 ) CALL iom_put( 'vflx_ssr_cea', -erp(:,:) ) |
|---|
| 147 | ! |
|---|
| 148 | ENDIF |
|---|
| 149 | ! |
|---|
| 150 | ENDIF |
|---|
| 151 | ! |
|---|
| 152 | END SUBROUTINE sbc_ssr |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | SUBROUTINE sbc_ssr_init |
|---|
| 156 | !!--------------------------------------------------------------------- |
|---|
| 157 | !! *** ROUTINE sbc_ssr_init *** |
|---|
| 158 | !! |
|---|
| 159 | !! ** Purpose : initialisation of surface damping term |
|---|
| 160 | !! |
|---|
| 161 | !! ** Method : - Read namelist namsbc_ssr |
|---|
| 162 | !! - Read observed SST and/or SSS if required |
|---|
| 163 | !!--------------------------------------------------------------------- |
|---|
| 164 | INTEGER :: ji, jj ! dummy loop indices |
|---|
| 165 | REAL(wp) :: zerp ! local scalar for evaporation damping |
|---|
| 166 | REAL(wp) :: zqrp ! local scalar for heat flux damping |
|---|
| 167 | REAL(wp) :: zsrp ! local scalar for unit conversion of rn_deds factor |
|---|
| 168 | REAL(wp) :: zerp_bnd ! local scalar for unit conversion of rn_epr_max factor |
|---|
| 169 | INTEGER :: ierror ! return error code |
|---|
| 170 | !! |
|---|
| 171 | CHARACTER(len=100) :: cn_dir ! Root directory for location of ssr files |
|---|
| 172 | TYPE(FLD_N) :: sn_sst, sn_sss ! informations about the fields to be read |
|---|
| 173 | NAMELIST/namsbc_ssr/ cn_dir, nn_sstr, nn_sssr, rn_dqdt, rn_deds, sn_sst, & |
|---|
| 174 | & sn_sss, ln_sssr_bnd, rn_sssr_bnd, nn_sssr_ice |
|---|
| 175 | INTEGER :: ios |
|---|
| 176 | !!---------------------------------------------------------------------- |
|---|
| 177 | ! |
|---|
| 178 | IF(lwp) THEN |
|---|
| 179 | WRITE(numout,*) |
|---|
| 180 | WRITE(numout,*) 'sbc_ssr : SST and/or SSS damping term ' |
|---|
| 181 | WRITE(numout,*) '~~~~~~~ ' |
|---|
| 182 | ENDIF |
|---|
| 183 | ! |
|---|
| 184 | READ ( numnam_ref, namsbc_ssr, IOSTAT = ios, ERR = 901) |
|---|
| 185 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc_ssr in reference namelist' ) |
|---|
| 186 | |
|---|
| 187 | READ ( numnam_cfg, namsbc_ssr, IOSTAT = ios, ERR = 902 ) |
|---|
| 188 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namsbc_ssr in configuration namelist' ) |
|---|
| 189 | IF(lwm) WRITE ( numond, namsbc_ssr ) |
|---|
| 190 | |
|---|
| 191 | IF(lwp) THEN !* control print |
|---|
| 192 | WRITE(numout,*) ' Namelist namsbc_ssr :' |
|---|
| 193 | WRITE(numout,*) ' SST restoring term (Yes=1) nn_sstr = ', nn_sstr |
|---|
| 194 | WRITE(numout,*) ' dQ/dT (restoring magnitude on SST) rn_dqdt = ', rn_dqdt, ' W/m2/K' |
|---|
| 195 | WRITE(numout,*) ' SSS damping term (Yes=1, salt flux) nn_sssr = ', nn_sssr |
|---|
| 196 | WRITE(numout,*) ' (Yes=2, volume flux) ' |
|---|
| 197 | WRITE(numout,*) ' dE/dS (restoring magnitude on SST) rn_deds = ', rn_deds, ' mm/day' |
|---|
| 198 | WRITE(numout,*) ' flag to bound erp term ln_sssr_bnd = ', ln_sssr_bnd |
|---|
| 199 | WRITE(numout,*) ' ABS(Max./Min.) erp threshold rn_sssr_bnd = ', rn_sssr_bnd, ' mm/day' |
|---|
| 200 | WRITE(numout,*) ' Cntrl of surface restoration under ice nn_sssr_ice = ', nn_sssr_ice |
|---|
| 201 | WRITE(numout,*) ' ( 0 = no restoration under ice)' |
|---|
| 202 | WRITE(numout,*) ' ( 1 = restoration everywhere )' |
|---|
| 203 | WRITE(numout,*) ' (>1 = enhanced restoration under ice )' |
|---|
| 204 | ENDIF |
|---|
| 205 | ! |
|---|
| 206 | IF( nn_sstr == 1 ) THEN !* set sf_sst structure & allocate arrays |
|---|
| 207 | ! |
|---|
| 208 | ALLOCATE( sf_sst(1), STAT=ierror ) |
|---|
| 209 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst structure' ) |
|---|
| 210 | ALLOCATE( sf_sst(1)%fnow(jpi,jpj,1), STAT=ierror ) |
|---|
| 211 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst now array' ) |
|---|
| 212 | ! |
|---|
| 213 | ! fill sf_sst with sn_sst and control print |
|---|
| 214 | CALL fld_fill( sf_sst, (/ sn_sst /), cn_dir, 'sbc_ssr', 'SST restoring term toward SST data', 'namsbc_ssr', no_print ) |
|---|
| 215 | IF( sf_sst(1)%ln_tint ) ALLOCATE( sf_sst(1)%fdta(jpi,jpj,1,2), STAT=ierror ) |
|---|
| 216 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sst data array' ) |
|---|
| 217 | ! |
|---|
| 218 | ENDIF |
|---|
| 219 | ! |
|---|
| 220 | IF( nn_sssr >= 1 ) THEN !* set sf_sss structure & allocate arrays |
|---|
| 221 | ! |
|---|
| 222 | ALLOCATE( sf_sss(1), STAT=ierror ) |
|---|
| 223 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss structure' ) |
|---|
| 224 | ALLOCATE( sf_sss(1)%fnow(jpi,jpj,1), STAT=ierror ) |
|---|
| 225 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss now array' ) |
|---|
| 226 | ! |
|---|
| 227 | ! fill sf_sss with sn_sss and control print |
|---|
| 228 | CALL fld_fill( sf_sss, (/ sn_sss /), cn_dir, 'sbc_ssr', 'SSS restoring term toward SSS data', 'namsbc_ssr', no_print ) |
|---|
| 229 | IF( sf_sss(1)%ln_tint ) ALLOCATE( sf_sss(1)%fdta(jpi,jpj,1,2), STAT=ierror ) |
|---|
| 230 | IF( ierror > 0 ) CALL ctl_stop( 'STOP', 'sbc_ssr: unable to allocate sf_sss data array' ) |
|---|
| 231 | ! |
|---|
| 232 | ENDIF |
|---|
| 233 | ! |
|---|
| 234 | coefice(:,:) = 1._wp ! Initialise coefice to 1._wp ; will not need to be changed if nn_sssr_ice=1 |
|---|
| 235 | ! !* Initialize qrp and erp if no restoring |
|---|
| 236 | IF( nn_sstr /= 1 ) qrp(:,:) = 0._wp |
|---|
| 237 | IF( nn_sssr /= 1 .OR. nn_sssr /= 2 ) erp(:,:) = 0._wp |
|---|
| 238 | ! |
|---|
| 239 | END SUBROUTINE sbc_ssr_init |
|---|
| 240 | |
|---|
| 241 | INTEGER FUNCTION sbc_ssr_alloc() |
|---|
| 242 | !!---------------------------------------------------------------------- |
|---|
| 243 | !! *** FUNCTION sbc_ssr_alloc *** |
|---|
| 244 | !!---------------------------------------------------------------------- |
|---|
| 245 | sbc_ssr_alloc = 0 ! set to zero if no array to be allocated |
|---|
| 246 | IF( .NOT. ALLOCATED( erp ) ) THEN |
|---|
| 247 | ALLOCATE( qrp(jpi,jpj), erp(jpi,jpj), coefice(jpi,jpj), STAT= sbc_ssr_alloc ) |
|---|
| 248 | ! |
|---|
| 249 | IF( lk_mpp ) CALL mpp_sum ( 'sbcssr', sbc_ssr_alloc ) |
|---|
| 250 | IF( sbc_ssr_alloc /= 0 ) CALL ctl_warn('sbc_ssr_alloc: failed to allocate arrays.') |
|---|
| 251 | ! |
|---|
| 252 | ENDIF |
|---|
| 253 | END FUNCTION |
|---|
| 254 | |
|---|
| 255 | !!====================================================================== |
|---|
| 256 | END MODULE sbcssr |
|---|
