[888] | 1 | MODULE sbcssm |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE sbcssm *** |
---|
| 4 | !! Surface module : provide time-mean ocean surface variables |
---|
| 5 | !!====================================================================== |
---|
[2715] | 6 | !! History : 9.0 ! 2006-07 (G. Madec) Original code |
---|
[2528] | 7 | !! 3.3 ! 2010-10 (C. Bricaud, G. Madec) add the Patm forcing for sea-ice |
---|
[6140] | 8 | !! 3.7 ! 2015-11 (G. Madec) non linear free surface by default: e3t_m always computed |
---|
[888] | 9 | !!---------------------------------------------------------------------- |
---|
| 10 | |
---|
| 11 | !!---------------------------------------------------------------------- |
---|
[6140] | 12 | !! sbc_ssm : calculate sea surface mean currents, temperature, |
---|
| 13 | !! and salinity over nn_fsbc time-step |
---|
[888] | 14 | !!---------------------------------------------------------------------- |
---|
[6140] | 15 | USE oce ! ocean dynamics and tracers |
---|
| 16 | USE dom_oce ! ocean space and time domain |
---|
| 17 | USE sbc_oce ! surface boundary condition: ocean fields |
---|
| 18 | USE sbcapr ! surface boundary condition: atmospheric pressure |
---|
| 19 | USE eosbn2 ! equation of state and related derivatives |
---|
[10425] | 20 | USE traqsr, ONLY: ln_traqsr |
---|
[4990] | 21 | ! |
---|
[6140] | 22 | USE in_out_manager ! I/O manager |
---|
| 23 | USE prtctl ! Print control |
---|
| 24 | USE iom ! IOM library |
---|
[888] | 25 | |
---|
| 26 | IMPLICIT NONE |
---|
| 27 | PRIVATE |
---|
| 28 | |
---|
[6140] | 29 | PUBLIC sbc_ssm ! routine called by step.F90 |
---|
| 30 | PUBLIC sbc_ssm_init ! routine called by sbcmod.F90 |
---|
[4292] | 31 | |
---|
[6140] | 32 | LOGICAL, SAVE :: l_ssm_mean = .FALSE. ! keep track of whether means have been read from restart file |
---|
[4292] | 33 | |
---|
[888] | 34 | !!---------------------------------------------------------------------- |
---|
[9598] | 35 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[1156] | 36 | !! $Id$ |
---|
[10068] | 37 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[888] | 38 | !!---------------------------------------------------------------------- |
---|
| 39 | CONTAINS |
---|
| 40 | |
---|
| 41 | SUBROUTINE sbc_ssm( kt ) |
---|
| 42 | !!--------------------------------------------------------------------- |
---|
| 43 | !! *** ROUTINE sbc_oce *** |
---|
| 44 | !! |
---|
| 45 | !! ** Purpose : provide ocean surface variable to sea-surface boundary |
---|
| 46 | !! condition computation |
---|
| 47 | !! |
---|
| 48 | !! ** Method : compute mean surface velocity (2 components at U and |
---|
[7646] | 49 | !! V-points) [m/s], temperature [Celsius] and salinity [psu] over |
---|
[888] | 50 | !! the periode (kt - nn_fsbc) to kt |
---|
[2528] | 51 | !! Note that the inverse barometer ssh (i.e. ssh associated with Patm) |
---|
| 52 | !! is add to ssh_m when ln_apr_dyn = T. Required for sea-ice dynamics. |
---|
[888] | 53 | !!--------------------------------------------------------------------- |
---|
[2715] | 54 | INTEGER, INTENT(in) :: kt ! ocean time step |
---|
[888] | 55 | ! |
---|
[4990] | 56 | INTEGER :: ji, jj ! loop index |
---|
[2715] | 57 | REAL(wp) :: zcoef, zf_sbc ! local scalar |
---|
[4990] | 58 | REAL(wp), DIMENSION(jpi,jpj,jpts) :: zts |
---|
[888] | 59 | !!--------------------------------------------------------------------- |
---|
[6140] | 60 | ! |
---|
[5120] | 61 | ! !* surface T-, U-, V- ocean level variables (T, S, depth, velocity) |
---|
[4990] | 62 | DO jj = 1, jpj |
---|
| 63 | DO ji = 1, jpi |
---|
| 64 | zts(ji,jj,jp_tem) = tsn(ji,jj,mikt(ji,jj),jp_tem) |
---|
| 65 | zts(ji,jj,jp_sal) = tsn(ji,jj,mikt(ji,jj),jp_sal) |
---|
| 66 | END DO |
---|
| 67 | END DO |
---|
| 68 | ! |
---|
[3607] | 69 | IF( nn_fsbc == 1 ) THEN ! Instantaneous surface fields ! |
---|
[888] | 70 | ! ! ---------------------------------------- ! |
---|
[7753] | 71 | ssu_m(:,:) = ub(:,:,1) |
---|
| 72 | ssv_m(:,:) = vb(:,:,1) |
---|
| 73 | IF( l_useCT ) THEN ; sst_m(:,:) = eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) ) |
---|
| 74 | ELSE ; sst_m(:,:) = zts(:,:,jp_tem) |
---|
[4990] | 75 | ENDIF |
---|
[7753] | 76 | sss_m(:,:) = zts(:,:,jp_sal) |
---|
[2528] | 77 | ! ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics) |
---|
[7753] | 78 | IF( ln_apr_dyn ) THEN ; ssh_m(:,:) = sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) |
---|
| 79 | ELSE ; ssh_m(:,:) = sshn(:,:) |
---|
[2528] | 80 | ENDIF |
---|
[888] | 81 | ! |
---|
[7753] | 82 | e3t_m(:,:) = e3t_n(:,:,1) |
---|
[4292] | 83 | ! |
---|
[7753] | 84 | frq_m(:,:) = fraqsr_1lev(:,:) |
---|
[5407] | 85 | ! |
---|
[888] | 86 | ELSE |
---|
[3607] | 87 | ! ! ----------------------------------------------- ! |
---|
[3614] | 88 | IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN ! Initialisation: 1st time-step, no input means ! |
---|
[3607] | 89 | ! ! ----------------------------------------------- ! |
---|
[888] | 90 | IF(lwp) WRITE(numout,*) |
---|
[7646] | 91 | IF(lwp) WRITE(numout,*) 'sbc_ssm : mean fields initialised to instantaneous values' |
---|
| 92 | IF(lwp) WRITE(numout,*) '~~~~~~~ ' |
---|
[3607] | 93 | zcoef = REAL( nn_fsbc - 1, wp ) |
---|
[7753] | 94 | ssu_m(:,:) = zcoef * ub(:,:,1) |
---|
| 95 | ssv_m(:,:) = zcoef * vb(:,:,1) |
---|
| 96 | IF( l_useCT ) THEN ; sst_m(:,:) = zcoef * eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) ) |
---|
| 97 | ELSE ; sst_m(:,:) = zcoef * zts(:,:,jp_tem) |
---|
[4990] | 98 | ENDIF |
---|
[7753] | 99 | sss_m(:,:) = zcoef * zts(:,:,jp_sal) |
---|
[4990] | 100 | ! ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics) |
---|
[7753] | 101 | IF( ln_apr_dyn ) THEN ; ssh_m(:,:) = zcoef * ( sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) ) |
---|
| 102 | ELSE ; ssh_m(:,:) = zcoef * sshn(:,:) |
---|
[888] | 103 | ENDIF |
---|
[4990] | 104 | ! |
---|
[7753] | 105 | e3t_m(:,:) = zcoef * e3t_n(:,:,1) |
---|
| 106 | ! |
---|
| 107 | frq_m(:,:) = zcoef * fraqsr_1lev(:,:) |
---|
[888] | 108 | ! ! ---------------------------------------- ! |
---|
| 109 | ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN ! Initialisation: New mean computation ! |
---|
| 110 | ! ! ---------------------------------------- ! |
---|
[7753] | 111 | ssu_m(:,:) = 0._wp ! reset to zero ocean mean sbc fields |
---|
| 112 | ssv_m(:,:) = 0._wp |
---|
| 113 | sst_m(:,:) = 0._wp |
---|
| 114 | sss_m(:,:) = 0._wp |
---|
| 115 | ssh_m(:,:) = 0._wp |
---|
| 116 | e3t_m(:,:) = 0._wp |
---|
| 117 | frq_m(:,:) = 0._wp |
---|
[888] | 118 | ENDIF |
---|
| 119 | ! ! ---------------------------------------- ! |
---|
| 120 | ! ! Cumulate at each time step ! |
---|
| 121 | ! ! ---------------------------------------- ! |
---|
[7753] | 122 | ssu_m(:,:) = ssu_m(:,:) + ub(:,:,1) |
---|
| 123 | ssv_m(:,:) = ssv_m(:,:) + vb(:,:,1) |
---|
[9019] | 124 | IF( l_useCT ) THEN ; sst_m(:,:) = sst_m(:,:) + eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) ) |
---|
[7753] | 125 | ELSE ; sst_m(:,:) = sst_m(:,:) + zts(:,:,jp_tem) |
---|
[4990] | 126 | ENDIF |
---|
[7753] | 127 | sss_m(:,:) = sss_m(:,:) + zts(:,:,jp_sal) |
---|
[2528] | 128 | ! ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics) |
---|
[7753] | 129 | IF( ln_apr_dyn ) THEN ; ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) |
---|
| 130 | ELSE ; ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) |
---|
[2528] | 131 | ENDIF |
---|
[4990] | 132 | ! |
---|
[7753] | 133 | e3t_m(:,:) = e3t_m(:,:) + e3t_n(:,:,1) |
---|
| 134 | ! |
---|
| 135 | frq_m(:,:) = frq_m(:,:) + fraqsr_1lev(:,:) |
---|
[888] | 136 | |
---|
| 137 | ! ! ---------------------------------------- ! |
---|
| 138 | IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN ! Mean value at each nn_fsbc time-step ! |
---|
| 139 | ! ! ---------------------------------------- ! |
---|
| 140 | zcoef = 1. / REAL( nn_fsbc, wp ) |
---|
[7753] | 141 | sst_m(:,:) = sst_m(:,:) * zcoef ! mean SST [Celsius] |
---|
| 142 | sss_m(:,:) = sss_m(:,:) * zcoef ! mean SSS [psu] |
---|
| 143 | ssu_m(:,:) = ssu_m(:,:) * zcoef ! mean suface current [m/s] |
---|
| 144 | ssv_m(:,:) = ssv_m(:,:) * zcoef ! |
---|
| 145 | ssh_m(:,:) = ssh_m(:,:) * zcoef ! mean SSH [m] |
---|
| 146 | e3t_m(:,:) = e3t_m(:,:) * zcoef ! mean vertical scale factor [m] |
---|
| 147 | frq_m(:,:) = frq_m(:,:) * zcoef ! mean fraction of solar net radiation absorbed in the 1st T level [-] |
---|
[888] | 148 | ! |
---|
| 149 | ENDIF |
---|
| 150 | ! ! ---------------------------------------- ! |
---|
| 151 | IF( lrst_oce ) THEN ! Write in the ocean restart file ! |
---|
| 152 | ! ! ---------------------------------------- ! |
---|
| 153 | IF(lwp) WRITE(numout,*) |
---|
| 154 | IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields written in ocean restart file ', & |
---|
| 155 | & 'at it= ', kt,' date= ', ndastp |
---|
| 156 | IF(lwp) WRITE(numout,*) '~~~~~~~' |
---|
| 157 | zf_sbc = REAL( nn_fsbc, wp ) |
---|
[9367] | 158 | IF( lwxios ) CALL iom_swap( cwxios_context ) |
---|
| 159 | CALL iom_rstput( kt, nitrst, numrow, 'nn_fsbc', zf_sbc, ldxios = lwxios ) ! sbc frequency |
---|
| 160 | CALL iom_rstput( kt, nitrst, numrow, 'ssu_m' , ssu_m, ldxios = lwxios ) ! sea surface mean fields |
---|
| 161 | CALL iom_rstput( kt, nitrst, numrow, 'ssv_m' , ssv_m, ldxios = lwxios ) |
---|
| 162 | CALL iom_rstput( kt, nitrst, numrow, 'sst_m' , sst_m, ldxios = lwxios ) |
---|
| 163 | CALL iom_rstput( kt, nitrst, numrow, 'sss_m' , sss_m, ldxios = lwxios ) |
---|
| 164 | CALL iom_rstput( kt, nitrst, numrow, 'ssh_m' , ssh_m, ldxios = lwxios ) |
---|
| 165 | CALL iom_rstput( kt, nitrst, numrow, 'e3t_m' , e3t_m, ldxios = lwxios ) |
---|
| 166 | CALL iom_rstput( kt, nitrst, numrow, 'frq_m' , frq_m, ldxios = lwxios ) |
---|
[888] | 167 | ! |
---|
[9367] | 168 | IF( lwxios ) CALL iom_swap( cxios_context ) |
---|
[888] | 169 | ENDIF |
---|
| 170 | ! |
---|
| 171 | ENDIF |
---|
| 172 | ! |
---|
[5407] | 173 | IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN ! Mean value at each nn_fsbc time-step ! |
---|
| 174 | CALL iom_put( 'ssu_m', ssu_m ) |
---|
| 175 | CALL iom_put( 'ssv_m', ssv_m ) |
---|
| 176 | CALL iom_put( 'sst_m', sst_m ) |
---|
| 177 | CALL iom_put( 'sss_m', sss_m ) |
---|
| 178 | CALL iom_put( 'ssh_m', ssh_m ) |
---|
[6140] | 179 | CALL iom_put( 'e3t_m', e3t_m ) |
---|
[5407] | 180 | CALL iom_put( 'frq_m', frq_m ) |
---|
| 181 | ENDIF |
---|
| 182 | ! |
---|
[888] | 183 | END SUBROUTINE sbc_ssm |
---|
| 184 | |
---|
[6140] | 185 | |
---|
[3607] | 186 | SUBROUTINE sbc_ssm_init |
---|
| 187 | !!---------------------------------------------------------------------- |
---|
| 188 | !! *** ROUTINE sbc_ssm_init *** |
---|
| 189 | !! |
---|
| 190 | !! ** Purpose : Initialisation of the sbc data |
---|
| 191 | !! |
---|
| 192 | !! ** Action : - read parameters |
---|
| 193 | !!---------------------------------------------------------------------- |
---|
[6140] | 194 | REAL(wp) :: zcoef, zf_sbc ! local scalar |
---|
[3607] | 195 | !!---------------------------------------------------------------------- |
---|
[6140] | 196 | ! |
---|
[3607] | 197 | IF( nn_fsbc == 1 ) THEN |
---|
| 198 | ! |
---|
| 199 | IF(lwp) WRITE(numout,*) |
---|
[7646] | 200 | IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields, nn_fsbc=1 : instantaneous values' |
---|
| 201 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~ ' |
---|
[3607] | 202 | ! |
---|
| 203 | ELSE |
---|
| 204 | ! |
---|
| 205 | IF(lwp) WRITE(numout,*) |
---|
[7646] | 206 | IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields' |
---|
| 207 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~ ' |
---|
[3607] | 208 | ! |
---|
| 209 | IF( ln_rstart .AND. iom_varid( numror, 'nn_fsbc', ldstop = .FALSE. ) > 0 ) THEN |
---|
| 210 | l_ssm_mean = .TRUE. |
---|
[9367] | 211 | CALL iom_get( numror , 'nn_fsbc', zf_sbc, ldxios = lrxios ) ! sbc frequency of previous run |
---|
| 212 | CALL iom_get( numror, jpdom_autoglo, 'ssu_m' , ssu_m, ldxios = lrxios ) ! sea surface mean velocity (U-point) |
---|
| 213 | CALL iom_get( numror, jpdom_autoglo, 'ssv_m' , ssv_m, ldxios = lrxios ) ! " " velocity (V-point) |
---|
| 214 | CALL iom_get( numror, jpdom_autoglo, 'sst_m' , sst_m, ldxios = lrxios ) ! " " temperature (T-point) |
---|
| 215 | CALL iom_get( numror, jpdom_autoglo, 'sss_m' , sss_m, ldxios = lrxios ) ! " " salinity (T-point) |
---|
| 216 | CALL iom_get( numror, jpdom_autoglo, 'ssh_m' , ssh_m, ldxios = lrxios ) ! " " height (T-point) |
---|
| 217 | CALL iom_get( numror, jpdom_autoglo, 'e3t_m' , e3t_m, ldxios = lrxios ) ! 1st level thickness (T-point) |
---|
[5407] | 218 | ! fraction of solar net radiation absorbed in 1st T level |
---|
| 219 | IF( iom_varid( numror, 'frq_m', ldstop = .FALSE. ) > 0 ) THEN |
---|
[9367] | 220 | CALL iom_get( numror, jpdom_autoglo, 'frq_m' , frq_m, ldxios = lrxios ) |
---|
[5407] | 221 | ELSE |
---|
[7753] | 222 | frq_m(:,:) = 1._wp ! default definition |
---|
[5407] | 223 | ENDIF |
---|
[3607] | 224 | ! |
---|
| 225 | IF( zf_sbc /= REAL( nn_fsbc, wp ) ) THEN ! nn_fsbc has changed between 2 runs |
---|
[7646] | 226 | IF(lwp) WRITE(numout,*) ' restart with a change in the frequency of mean from ', zf_sbc, ' to ', nn_fsbc |
---|
[3607] | 227 | zcoef = REAL( nn_fsbc - 1, wp ) / zf_sbc |
---|
[7753] | 228 | ssu_m(:,:) = zcoef * ssu_m(:,:) |
---|
| 229 | ssv_m(:,:) = zcoef * ssv_m(:,:) |
---|
| 230 | sst_m(:,:) = zcoef * sst_m(:,:) |
---|
| 231 | sss_m(:,:) = zcoef * sss_m(:,:) |
---|
| 232 | ssh_m(:,:) = zcoef * ssh_m(:,:) |
---|
| 233 | e3t_m(:,:) = zcoef * e3t_m(:,:) |
---|
| 234 | frq_m(:,:) = zcoef * frq_m(:,:) |
---|
[3607] | 235 | ELSE |
---|
[7646] | 236 | IF(lwp) WRITE(numout,*) ' mean fields read in the ocean restart file' |
---|
[3607] | 237 | ENDIF |
---|
| 238 | ENDIF |
---|
| 239 | ENDIF |
---|
| 240 | ! |
---|
[9019] | 241 | IF( .NOT.l_ssm_mean ) THEN ! default initialisation. needed by iceistate |
---|
[5407] | 242 | ! |
---|
[7646] | 243 | IF(lwp) WRITE(numout,*) ' default initialisation of ss._m arrays' |
---|
[7753] | 244 | ssu_m(:,:) = ub(:,:,1) |
---|
| 245 | ssv_m(:,:) = vb(:,:,1) |
---|
[6489] | 246 | IF( l_useCT ) THEN ; sst_m(:,:) = eos_pt_from_ct( tsn(:,:,1,jp_tem), tsn(:,:,1,jp_sal) ) |
---|
[7646] | 247 | ELSE ; sst_m(:,:) = tsn(:,:,1,jp_tem) |
---|
[5407] | 248 | ENDIF |
---|
[7753] | 249 | sss_m(:,:) = tsn (:,:,1,jp_sal) |
---|
| 250 | ssh_m(:,:) = sshn (:,:) |
---|
| 251 | e3t_m(:,:) = e3t_n(:,:,1) |
---|
| 252 | frq_m(:,:) = 1._wp |
---|
[5407] | 253 | ! |
---|
| 254 | ENDIF |
---|
| 255 | ! |
---|
[10425] | 256 | IF( .NOT. ln_traqsr ) fraqsr_1lev(:,:) = 1._wp ! default definition: qsr 100% in the fisrt level |
---|
| 257 | ! |
---|
[9367] | 258 | IF( lwxios.AND.nn_fsbc > 1 ) THEN |
---|
| 259 | CALL iom_set_rstw_var_active('nn_fsbc') |
---|
| 260 | CALL iom_set_rstw_var_active('ssu_m') |
---|
| 261 | CALL iom_set_rstw_var_active('ssv_m') |
---|
| 262 | CALL iom_set_rstw_var_active('sst_m') |
---|
| 263 | CALL iom_set_rstw_var_active('sss_m') |
---|
| 264 | CALL iom_set_rstw_var_active('ssh_m') |
---|
| 265 | CALL iom_set_rstw_var_active('e3t_m') |
---|
| 266 | CALL iom_set_rstw_var_active('frq_m') |
---|
| 267 | ENDIF |
---|
| 268 | |
---|
[3607] | 269 | END SUBROUTINE sbc_ssm_init |
---|
| 270 | |
---|
[888] | 271 | !!====================================================================== |
---|
| 272 | END MODULE sbcssm |
---|