[888] | 1 | MODULE sbcmod |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE sbcmod *** |
---|
| 4 | !! Surface module : provide to the ocean its surface boundary condition |
---|
| 5 | !!====================================================================== |
---|
| 6 | !! History : 9.0 ! 06-07 (G. Madec) Original code |
---|
| 7 | !!---------------------------------------------------------------------- |
---|
| 8 | |
---|
| 9 | !!---------------------------------------------------------------------- |
---|
| 10 | !! sbc_init : read namsbc namelist |
---|
| 11 | !! sbc : surface ocean momentum, heat and freshwater |
---|
| 12 | !! boundary conditions |
---|
| 13 | !!---------------------------------------------------------------------- |
---|
| 14 | USE oce ! ocean dynamics and tracers |
---|
| 15 | USE dom_oce ! ocean space and time domain |
---|
| 16 | USE daymod ! calendar |
---|
| 17 | USE phycst ! physical constants |
---|
| 18 | USE ocfzpt ! ocean freezing point |
---|
| 19 | |
---|
| 20 | USE ice_oce ! sea-ice model : LIM |
---|
| 21 | USE sbc_oce ! Surface boundary condition: ocean fields |
---|
| 22 | USE sbcssm ! surface boundary condition: sea-surface mean variables |
---|
| 23 | USE sbcana ! surface boundary condition: analytical formulation |
---|
| 24 | USE sbcflx ! surface boundary condition: flux formulation |
---|
| 25 | USE sbcblk_clio ! surface boundary condition: bulk formulation : CLIO |
---|
| 26 | USE sbcblk_core ! surface boundary condition: bulk formulation : CORE |
---|
| 27 | USE sbcice_if ! surface boundary condition: ice-if sea-ice model |
---|
| 28 | USE sbcice_lim ! surface boundary condition: LIM 3.0 sea-ice model |
---|
| 29 | USE sbcice_lim_2 ! surface boundary condition: LIM 2.0 sea-ice model |
---|
| 30 | USE sbccpl ! surface boundary condition: coupled florulation |
---|
| 31 | USE sbcssr ! surface boundary condition: sea surface restoring |
---|
| 32 | USE sbcrnf ! surface boundary condition: runoffs |
---|
| 33 | USE sbcfwb ! surface boundary condition: freshwater budget |
---|
| 34 | USE closea ! closed sea |
---|
| 35 | |
---|
| 36 | USE prtctl ! Print control (prt_ctl routine) |
---|
| 37 | USE restart ! ocean restart |
---|
| 38 | USE iom |
---|
| 39 | USE in_out_manager ! I/O manager |
---|
| 40 | |
---|
| 41 | IMPLICIT NONE |
---|
| 42 | PRIVATE |
---|
| 43 | |
---|
| 44 | PUBLIC sbc ! routine called by step.F90 |
---|
| 45 | |
---|
| 46 | !! * namsbc namelist (public variables) |
---|
| 47 | LOGICAL , PUBLIC :: ln_ana = .FALSE. !: analytical boundary condition flag |
---|
| 48 | LOGICAL , PUBLIC :: ln_flx = .FALSE. !: flux formulation |
---|
| 49 | LOGICAL , PUBLIC :: ln_blk_clio = .FALSE. !: CLIO bulk formulation |
---|
| 50 | LOGICAL , PUBLIC :: ln_blk_core = .FALSE. !: CORE bulk formulation |
---|
[991] | 51 | LOGICAL , PUBLIC :: ln_cpl = .FALSE. !: coupled formulation (overwritten by key_oasis3/4 ) |
---|
[888] | 52 | LOGICAL , PUBLIC :: ln_dm2dc = .FALSE. !: Daily mean to Diurnal Cycle short wave (qsr) |
---|
| 53 | LOGICAL , PUBLIC :: ln_rnf = .FALSE. !: runoffs / runoff mouths |
---|
| 54 | LOGICAL , PUBLIC :: ln_ssr = .FALSE. !: Sea Surface restoring on SST and/or SSS |
---|
| 55 | INTEGER , PUBLIC :: nn_ice = 0 !: flag on ice in the surface boundary condition (=0/1/2) |
---|
| 56 | INTEGER , PUBLIC :: nn_fwb = 0 !: type of FreshWater Budget control (=0/1/2) |
---|
[990] | 57 | INTEGER :: nn_ico_cpl = 0 !: ice-ocean coupling indicator |
---|
| 58 | ! ! = 0 LIM-3 old case |
---|
| 59 | ! ! = 1 stresses computed using now ocean velocity |
---|
| 60 | ! ! = 2 combination of 0 and 1 cases |
---|
[888] | 61 | |
---|
| 62 | INTEGER :: nsbc ! type of surface boundary condition (deduced from namsbc informations) |
---|
| 63 | INTEGER :: nice ! type of ice in the surface boundary condition (deduced from namsbc informations) |
---|
| 64 | |
---|
| 65 | !! * Substitutions |
---|
| 66 | # include "domzgr_substitute.h90" |
---|
| 67 | !!---------------------------------------------------------------------- |
---|
| 68 | !! OPA 9.0 , LOCEAN-IPSL (2006) |
---|
| 69 | !! $Id: $ |
---|
| 70 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
---|
| 71 | !!---------------------------------------------------------------------- |
---|
| 72 | |
---|
| 73 | CONTAINS |
---|
| 74 | |
---|
| 75 | SUBROUTINE sbc_init |
---|
| 76 | !!--------------------------------------------------------------------- |
---|
| 77 | !! *** ROUTINE sbc_init *** |
---|
| 78 | !! |
---|
| 79 | !! ** Purpose : Initialisation of the ocean surface boundary computation |
---|
| 80 | !! |
---|
| 81 | !! ** Method : Read the namsbc namelist and set derived parameters |
---|
| 82 | !! |
---|
| 83 | !! ** Action : - read namsbc parameters |
---|
| 84 | !! - nsbc: type of sbc |
---|
| 85 | !!---------------------------------------------------------------------- |
---|
| 86 | INTEGER :: icpt ! temporary integer |
---|
| 87 | !!---------------------------------------------------------------------- |
---|
[990] | 88 | NAMELIST/namsbc/ nn_fsbc, ln_ana, ln_flx, ln_blk_clio, ln_blk_core, ln_cpl, & |
---|
| 89 | & nn_ice , ln_dm2dc, ln_rnf, ln_ssr, nn_fwb, nn_ico_cpl |
---|
[888] | 90 | |
---|
| 91 | IF(lwp) THEN |
---|
| 92 | WRITE(numout,*) |
---|
| 93 | WRITE(numout,*) 'sbc_init : surface boundary condition setting' |
---|
| 94 | WRITE(numout,*) '~~~~~~~~ ' |
---|
| 95 | ENDIF |
---|
| 96 | |
---|
| 97 | REWIND ( numnam ) ! Read Namelist namsbc |
---|
| 98 | READ ( numnam, namsbc ) |
---|
| 99 | |
---|
| 100 | ! overwrite namelist parameter using CPP key information |
---|
| 101 | !!gmhere no overwrite, test all option via namelist change: require more incore memory |
---|
| 102 | !!gm IF( lk_sbc_cpl ) THEN ; ln_cpl = .TRUE. ; ELSE ; ln_cpl = .FALSE. ; ENDIF |
---|
| 103 | IF( lk_lim2 ) nn_ice = 2 |
---|
| 104 | IF( lk_lim3 ) nn_ice = 3 |
---|
| 105 | IF( cp_cfg == 'gyre' ) THEN |
---|
| 106 | ln_ana = .TRUE. |
---|
| 107 | nn_ice = 0 |
---|
| 108 | ENDIF |
---|
| 109 | |
---|
| 110 | ! Control print |
---|
| 111 | IF(lwp) THEN |
---|
| 112 | WRITE(numout,*) ' Namelist namsbc (overwritten using CPP key defined)' |
---|
| 113 | WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc |
---|
| 114 | WRITE(numout,*) ' Type of sbc : ' |
---|
| 115 | WRITE(numout,*) ' analytical formulation ln_ana = ', ln_ana |
---|
| 116 | WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx |
---|
| 117 | WRITE(numout,*) ' CLIO bulk formulation ln_blk_clio = ', ln_blk_clio |
---|
| 118 | WRITE(numout,*) ' CLIO bulk formulation ln_blk_core = ', ln_blk_core |
---|
| 119 | WRITE(numout,*) ' coupled formulation (T if key_sbc_cpl) ln_cpl = ', ln_cpl |
---|
| 120 | WRITE(numout,*) ' Misc. options of sbc : ' |
---|
| 121 | WRITE(numout,*) ' ice management in the sbc (=0/1/2) nn_ice = ', nn_ice |
---|
[990] | 122 | WRITE(numout,*) ' ice-ocean stress computation (=0/1/2) nn_ico_cpl = ', nn_ico_cpl |
---|
[888] | 123 | WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc |
---|
| 124 | WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf |
---|
| 125 | WRITE(numout,*) ' Sea Surface Restoring on SST and/or SSS ln_ssr = ', ln_ssr |
---|
| 126 | WRITE(numout,*) ' FreshWater Budget control (=0/1/2) nn_fwb = ', nn_fwb |
---|
| 127 | WRITE(numout,*) ' closed sea (=0/1) (set in namdom) nclosea = ', nclosea |
---|
| 128 | ENDIF |
---|
| 129 | |
---|
| 130 | ! Check consistancy !!gm mixture of real and integer : coding to be changed.... |
---|
| 131 | |
---|
| 132 | IF( .NOT. ln_rnf ) nn_runoff = 0 ! no runoff, or runoff mouths |
---|
| 133 | |
---|
| 134 | IF( nn_ice == 2 ) THEN |
---|
| 135 | IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN |
---|
| 136 | WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')' |
---|
| 137 | CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' ) |
---|
| 138 | ENDIF |
---|
| 139 | IF( MOD( nstock, nn_fsbc) /= 0 ) THEN |
---|
| 140 | WRITE(ctmp1,*) 'nstock (' , nstock , ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')' |
---|
| 141 | CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' ) |
---|
| 142 | ENDIF |
---|
| 143 | ENDIF |
---|
| 144 | |
---|
| 145 | IF( MOD( rday, nn_fsbc*rdt ) /= 0 ) CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' ) |
---|
| 146 | |
---|
| 147 | IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core ) ) & |
---|
| 148 | & CALL ctl_stop( 'sbc_init: sea-ice model requires a bulk formulation' ) |
---|
| 149 | |
---|
| 150 | ! Choice of the Surface Boudary Condition (set nsbc) |
---|
| 151 | icpt = 0 |
---|
| 152 | IF( ln_ana ) THEN ; nsbc = 1 ; icpt = icpt + 1 ; ENDIF ! analytical formulation |
---|
| 153 | IF( ln_flx ) THEN ; nsbc = 2 ; icpt = icpt + 1 ; ENDIF ! flux formulation |
---|
| 154 | IF( ln_blk_clio ) THEN ; nsbc = 3 ; icpt = icpt + 1 ; ENDIF ! CLIO bulk formulation |
---|
| 155 | IF( ln_blk_core ) THEN ; nsbc = 4 ; icpt = icpt + 1 ; ENDIF ! CORE bulk formulation |
---|
| 156 | IF( ln_cpl ) THEN ; nsbc = 5 ; icpt = icpt + 1 ; ENDIF ! Coupled formulation |
---|
| 157 | IF( cp_cfg == 'gyre') THEN ; nsbc = 0 ; ENDIF ! GYRE analytical formulation |
---|
| 158 | IF( lk_esopa ) nsbc = -1 ! esopa test, ALL formulations |
---|
| 159 | |
---|
| 160 | IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN |
---|
| 161 | WRITE(numout,*) |
---|
| 162 | WRITE(numout,*) ' E R R O R in setting the sbc, one and only one namelist/CPP key option ' |
---|
| 163 | WRITE(numout,*) ' must be choosen. You choose ', icpt, ' option(s)' |
---|
| 164 | WRITE(numout,*) ' We stop' |
---|
| 165 | nstop = nstop + 1 |
---|
| 166 | ENDIF |
---|
| 167 | IF(lwp) THEN |
---|
| 168 | WRITE(numout,*) |
---|
| 169 | IF( nsbc == -1 ) WRITE(numout,*) ' ESOPA test All surface boundary conditions' |
---|
| 170 | IF( nsbc == 0 ) WRITE(numout,*) ' GYRE analytical formulation' |
---|
| 171 | IF( nsbc == 1 ) WRITE(numout,*) ' analytical formulation' |
---|
| 172 | IF( nsbc == 2 ) WRITE(numout,*) ' flux formulation' |
---|
| 173 | IF( nsbc == 3 ) WRITE(numout,*) ' CLIO bulk formulation' |
---|
| 174 | IF( nsbc == 4 ) WRITE(numout,*) ' CORE bulk formulation' |
---|
| 175 | IF( nsbc == 5 ) WRITE(numout,*) ' coupled formulation' |
---|
| 176 | ENDIF |
---|
| 177 | ! |
---|
| 178 | END SUBROUTINE sbc_init |
---|
| 179 | |
---|
| 180 | |
---|
| 181 | SUBROUTINE sbc( kt ) |
---|
| 182 | !!--------------------------------------------------------------------- |
---|
| 183 | !! *** ROUTINE sbc *** |
---|
| 184 | !! |
---|
| 185 | !! ** Purpose : provide at each time-step the ocean surface boundary |
---|
| 186 | !! condition (momentum, heat and freshwater fluxes) |
---|
| 187 | !! |
---|
| 188 | !! ** Method : blah blah to be written ????????? |
---|
| 189 | !! CAUTION : never mask the surface stress field (tke sbc) |
---|
| 190 | !! |
---|
| 191 | !! ** Action : - set the ocean surface boundary condition, i.e. |
---|
| 192 | !! utau, vtau, qns, qsr, emp, emps, qrp, erp |
---|
| 193 | !!---------------------------------------------------------------------- |
---|
| 194 | INTEGER, INTENT(in) :: kt ! ocean time step |
---|
| 195 | !!--------------------------------------------------------------------- |
---|
| 196 | |
---|
| 197 | IF( kt == nit000 ) CALL sbc_init ! Read namsbc namelist : surface module |
---|
| 198 | |
---|
| 199 | ! ocean to sbc mean sea surface variables (ss._m) |
---|
| 200 | ! --------------------------------------- |
---|
| 201 | CALL sbc_ssm( kt ) ! sea surface mean currents (at U- and V-points), |
---|
| 202 | ! ! temperature and salinity (at T-point) over nf_sbc time-step |
---|
| 203 | ! ! (i.e. sst_m, sss_m, ssu_m, ssv_m) |
---|
| 204 | |
---|
| 205 | !!gm add a flag on nn_fsbc frequency ????? except the diurnal cycle! |
---|
| 206 | !! IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN |
---|
| 207 | |
---|
| 208 | |
---|
| 209 | ! sbc formulation |
---|
| 210 | ! --------------- |
---|
| 211 | |
---|
| 212 | SELECT CASE( nsbc ) ! Compute ocean surface boundary condition |
---|
| 213 | ! ! (i.e. utau,vtau, qns, qsr, emp, emps) |
---|
| 214 | CASE( 0 ) ; CALL sbc_gyre ( kt ) ! analytical formulation : GYRE configuration |
---|
| 215 | CASE( 1 ) ; CALL sbc_ana ( kt ) ! analytical formulation : uniform sbc |
---|
| 216 | CASE( 2 ) ; CALL sbc_flx ( kt ) ! flux formulation |
---|
| 217 | CASE( 3 ) ; CALL sbc_blk_clio( kt ) ! bulk formulation : CLIO for the ocean |
---|
| 218 | CASE( 4 ) ; CALL sbc_blk_core( kt ) ! bulk formulation : CORE for the ocean |
---|
| 219 | CASE( 5 ) ; CALL sbc_cpl ( kt ) ! coupled formulation |
---|
| 220 | CASE( -1 ) |
---|
| 221 | ; CALL sbc_ana ( kt ) ! ESOPA, test ALL the formulations |
---|
| 222 | ; CALL sbc_gyre ( kt ) |
---|
| 223 | ; CALL sbc_flx ( kt ) |
---|
| 224 | ; CALL sbc_blk_clio( kt ) |
---|
| 225 | ; CALL sbc_blk_core( kt ) |
---|
| 226 | ; CALL sbc_cpl ( kt ) |
---|
| 227 | END SELECT |
---|
| 228 | |
---|
| 229 | ! Misc. Options |
---|
| 230 | ! ------------- |
---|
| 231 | |
---|
| 232 | !!gm IF( ln_dm2dc ) CALL sbc_dcy( kt ) ! Daily mean qsr distributed over the Diurnal Cycle |
---|
| 233 | |
---|
| 234 | SELECT CASE( nn_ice ) ! Update sbc over ice-covered areas |
---|
[990] | 235 | CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model) |
---|
| 236 | ! ! (update heat and freshwater fluxes) |
---|
| 237 | CASE( 2 ) ; CALL sbc_ice_lim_2( kt, nsbc ) ! LIM 2.0 ice model |
---|
| 238 | ! ! (update heat and freshwater fluxes) |
---|
| 239 | CASE( 3 ) ; CALL sbc_ice_lim ( kt, nsbc, nn_ico_cpl) ! LIM 3.0 ice model |
---|
| 240 | END SELECT ! (update all fluxes using bulk + LIM) |
---|
[888] | 241 | |
---|
| 242 | IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term |
---|
| 243 | |
---|
| 244 | IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes |
---|
| 245 | |
---|
| 246 | IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget |
---|
| 247 | |
---|
| 248 | IF( nclosea == 1 ) CALL sbc_clo( kt ) ! treatment of closed sea in the model domain |
---|
| 249 | ! ! (update freshwater fluxes) |
---|
| 250 | ! |
---|
| 251 | IF(ln_ctl) THEN ! print mean trends (used for debugging) |
---|
| 252 | CALL prt_ctl(tab2d_1=emp , clinfo1=' emp - : ', mask1=tmask, ovlap=1) |
---|
| 253 | CALL prt_ctl(tab2d_1=emps , clinfo1=' emps - : ', mask1=tmask, ovlap=1) |
---|
| 254 | CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask, ovlap=1) |
---|
| 255 | CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask, ovlap=1) |
---|
| 256 | CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask : ', mask1=tmask, ovlap=1, kdim=jpk) |
---|
| 257 | CALL prt_ctl(tab3d_1=tn , clinfo1=' sst - : ', mask1=tmask, ovlap=1, kdim=1) |
---|
| 258 | CALL prt_ctl(tab3d_1=sn , clinfo1=' sss - : ', mask1=tmask, ovlap=1, kdim=1) |
---|
| 259 | CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, & |
---|
| 260 | tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask, ovlap=1) |
---|
| 261 | ENDIF |
---|
| 262 | |
---|
| 263 | !!gm |
---|
| 264 | !! ENDIF |
---|
| 265 | !!gm |
---|
| 266 | ! |
---|
| 267 | END SUBROUTINE sbc |
---|
| 268 | |
---|
| 269 | !!====================================================================== |
---|
| 270 | END MODULE sbcmod |
---|