[11395] | 1 | MODULE isftbl |
---|
[11403] | 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE isftbl *** |
---|
| 4 | !! isftbl module : compute properties of top boundary layer |
---|
| 5 | !!====================================================================== |
---|
| 6 | !! History : 4.1 ! 2019-09 (P. Mathiot) original code |
---|
| 7 | !!---------------------------------------------------------------------- |
---|
[11395] | 8 | |
---|
[11403] | 9 | !!---------------------------------------------------------------------- |
---|
| 10 | !! isftbl : routine to compute : |
---|
| 11 | !! - geometry of the ice shelf tbl (isf_tbl_lvl, isftbl_ktop, isftbl_kbot) |
---|
| 12 | !! (top and bottom level, thickness and fraction of deepest level affected) |
---|
| 13 | !! - tbl averaged properties (isf_tbl, isf_tbl_avg) |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
[11395] | 15 | |
---|
[12077] | 16 | USE isf_oce ! ice shelf variables |
---|
[11852] | 17 | |
---|
[11876] | 18 | USE dom_oce ! vertical scale factor and depth |
---|
[11395] | 19 | |
---|
[11403] | 20 | IMPLICIT NONE |
---|
[11395] | 21 | |
---|
[11403] | 22 | PRIVATE |
---|
[11395] | 23 | |
---|
[11541] | 24 | PUBLIC isf_tbl, isf_tbl_avg, isf_tbl_lvl, isf_tbl_ktop, isf_tbl_kbot |
---|
[12340] | 25 | !! * Substitutions |
---|
| 26 | # include "do_loop_substitute.h90" |
---|
[13237] | 27 | # include "domzgr_substitute.h90" |
---|
[11403] | 28 | |
---|
[11395] | 29 | CONTAINS |
---|
| 30 | |
---|
[12068] | 31 | SUBROUTINE isf_tbl( Kmm, pvarin, pvarout, cd_ptin, ktop, phtbl, kbot, pfrac ) |
---|
[11403] | 32 | !!-------------------------------------------------------------------- |
---|
| 33 | !! *** SUBROUTINE isf_tbl *** |
---|
[11395] | 34 | !! |
---|
| 35 | !! ** Purpose : compute mean T/S/U/V in the boundary layer at T- point |
---|
| 36 | !! |
---|
[11541] | 37 | !! ** Method : Average properties over a specific thickness |
---|
| 38 | !! |
---|
| 39 | !! ** Reference : inspired from : Losch, Modeling ice shelf cavities in a z coordinate ocean general circulation model |
---|
| 40 | !! https://doi.org/10.1029/2007JC004368 , 2008 |
---|
| 41 | !! |
---|
[11395] | 42 | !!-------------------------- OUT ------------------------------------- |
---|
[11403] | 43 | REAL(wp), DIMENSION(jpi,jpj) , INTENT( out) :: pvarout ! 2d average of pvarin |
---|
[11395] | 44 | !!-------------------------- IN ------------------------------------- |
---|
[12068] | 45 | INTEGER , INTENT(in ) :: Kmm ! ocean time level index |
---|
[11403] | 46 | CHARACTER(len=1) , INTENT(in ) :: cd_ptin ! point of variable in/out |
---|
| 47 | REAL(wp), DIMENSION(jpi,jpj,jpk) , INTENT(in ) :: pvarin ! 3d variable to average over the tbl |
---|
[11495] | 48 | INTEGER, DIMENSION(jpi,jpj) , INTENT(in ) :: ktop ! top level |
---|
| 49 | REAL(wp), DIMENSION(jpi,jpj) , INTENT(in ) :: phtbl ! tbl thickness |
---|
[11403] | 50 | !!-------------------------- IN OPTIONAL ----------------------------- |
---|
[11495] | 51 | INTEGER, DIMENSION(jpi,jpj), OPTIONAL, INTENT(in ) :: kbot ! bottom level |
---|
| 52 | REAL(wp), DIMENSION(jpi,jpj), OPTIONAL, INTENT(in ) :: pfrac ! fraction of bottom cell affected by tbl |
---|
[11395] | 53 | !!-------------------------------------------------------------------- |
---|
[11844] | 54 | INTEGER :: ji, jj ! loop index |
---|
| 55 | INTEGER , DIMENSION(jpi,jpj) :: ikbot ! bottom level of the tbl |
---|
| 56 | REAL(wp), DIMENSION(jpi,jpj) :: zvarout ! 2d average of pvarin |
---|
| 57 | REAL(wp), DIMENSION(jpi,jpj) :: zhtbl ! thickness of the tbl |
---|
| 58 | REAL(wp), DIMENSION(jpi,jpj) :: zfrac ! thickness of the tbl |
---|
[13237] | 59 | INTEGER :: jk ! loop index |
---|
| 60 | REAL(wp), DIMENSION(jpi,jpj,jpk) :: ze3t,ze3u,ze3v ! e3 |
---|
[11403] | 61 | !!-------------------------------------------------------------------- |
---|
[11395] | 62 | ! |
---|
| 63 | SELECT CASE ( cd_ptin ) |
---|
| 64 | CASE ( 'U' ) |
---|
| 65 | ! |
---|
[11495] | 66 | ! copy phtbl (phtbl is INTENT in as we don't want to change it) |
---|
| 67 | zhtbl = phtbl |
---|
[11395] | 68 | ! |
---|
[13237] | 69 | DO jk = 1, jpk |
---|
| 70 | ze3u(:,:,jk) = e3u(:,:,jk,Kmm) |
---|
| 71 | END DO |
---|
[11495] | 72 | ! compute tbl lvl and thickness |
---|
[13237] | 73 | CALL isf_tbl_lvl( hu(:,:,Kmm), ze3u, ktop, ikbot, zhtbl, zfrac ) |
---|
[11495] | 74 | ! |
---|
[11395] | 75 | ! compute tbl property at U point |
---|
[13237] | 76 | CALL isf_tbl_avg( miku, ikbot, zhtbl, zfrac, ze3u, pvarin, zvarout ) |
---|
[11395] | 77 | ! |
---|
| 78 | ! compute tbl property at T point |
---|
[11844] | 79 | pvarout(1,:) = 0._wp |
---|
[13899] | 80 | DO_2D( 1, 1, 0, 1 ) |
---|
[12340] | 81 | pvarout(ji,jj) = 0.5_wp * (zvarout(ji,jj) + zvarout(ji-1,jj)) |
---|
| 82 | END_2D |
---|
[11844] | 83 | ! lbclnk not needed as a final communication is done after the computation of fwf |
---|
[11395] | 84 | ! |
---|
| 85 | CASE ( 'V' ) |
---|
| 86 | ! |
---|
[11495] | 87 | ! copy phtbl (phtbl is INTENT in as we don't want to change it) |
---|
| 88 | zhtbl = phtbl |
---|
[11395] | 89 | ! |
---|
[13237] | 90 | DO jk = 1, jpk |
---|
| 91 | ze3v(:,:,jk) = e3v(:,:,jk,Kmm) |
---|
| 92 | END DO |
---|
[11495] | 93 | ! compute tbl lvl and thickness |
---|
[13237] | 94 | CALL isf_tbl_lvl( hv(:,:,Kmm), ze3v, ktop, ikbot, zhtbl, zfrac ) |
---|
[11495] | 95 | ! |
---|
[11395] | 96 | ! compute tbl property at V point |
---|
[13237] | 97 | CALL isf_tbl_avg( mikv, ikbot, zhtbl, zfrac, ze3v, pvarin, zvarout ) |
---|
[11395] | 98 | ! |
---|
| 99 | ! pvarout is an averaging of wet point |
---|
[11844] | 100 | pvarout(:,1) = 0._wp |
---|
[13899] | 101 | DO_2D( 0, 1, 1, 1 ) |
---|
[12340] | 102 | pvarout(ji,jj) = 0.5_wp * (zvarout(ji,jj) + zvarout(ji,jj-1)) |
---|
| 103 | END_2D |
---|
[11844] | 104 | ! lbclnk not needed as a final communication is done after the computation of fwf |
---|
[11395] | 105 | ! |
---|
| 106 | CASE ( 'T' ) |
---|
| 107 | ! |
---|
| 108 | ! compute tbl property at T point |
---|
[13237] | 109 | DO jk = 1, jpk |
---|
| 110 | ze3t(:,:,jk) = e3t(:,:,jk,Kmm) |
---|
| 111 | END DO |
---|
| 112 | CALL isf_tbl_avg( ktop, kbot, phtbl, pfrac, ze3t, pvarin, pvarout ) |
---|
[11395] | 113 | ! |
---|
| 114 | END SELECT |
---|
| 115 | ! |
---|
| 116 | END SUBROUTINE isf_tbl |
---|
| 117 | |
---|
| 118 | SUBROUTINE isf_tbl_avg( ktop, kbot, phtbl, pfrac, pe3, pvarin, pvarout ) |
---|
[11403] | 119 | !!-------------------------------------------------------------------- |
---|
[11541] | 120 | !! *** ROUTINE isf_tbl_avg *** |
---|
[11395] | 121 | !! |
---|
| 122 | !! ** Purpose : compute mean property in the boundary layer |
---|
| 123 | !! |
---|
[11403] | 124 | !! ** Method : Depth average is made between the top level ktop and the bottom level kbot |
---|
| 125 | !! over a thickness phtbl. The bottom level is partially counted (pfrac). |
---|
| 126 | !! |
---|
[11395] | 127 | !!-------------------------- OUT ------------------------------------- |
---|
[11403] | 128 | REAL(wp), DIMENSION(jpi,jpj) , INTENT( out) :: pvarout ! tbl property averaged over phtbl between level ktop and kbot |
---|
[11395] | 129 | !!-------------------------- IN ------------------------------------- |
---|
[11403] | 130 | INTEGER, DIMENSION(jpi,jpj) , INTENT(in ) :: ktop, kbot ! top and bottom level of the top boundary layer |
---|
| 131 | REAL(wp), DIMENSION(jpi,jpj) , INTENT(in ) :: phtbl, pfrac ! fraction of bottom level to be affected by the tbl |
---|
| 132 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pe3 ! vertical scale factor |
---|
| 133 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pvarin ! tbl property to average between ktop, kbot over phtbl |
---|
| 134 | !!-------------------------------------------------------------------- |
---|
[11395] | 135 | INTEGER :: ji,jj,jk ! loop indices |
---|
| 136 | INTEGER :: ikt, ikb ! top and bottom levels |
---|
[11403] | 137 | !!-------------------------------------------------------------------- |
---|
[11395] | 138 | ! |
---|
| 139 | ! compute tbl top.bottom level and thickness |
---|
[13899] | 140 | DO_2D( 1, 1, 1, 1 ) |
---|
[12340] | 141 | ! |
---|
| 142 | ! tbl top/bottom indices initialisation |
---|
| 143 | ikt = ktop(ji,jj) ; ikb = kbot(ji,jj) |
---|
| 144 | ! |
---|
| 145 | ! level fully include in the ice shelf boundary layer |
---|
| 146 | pvarout(ji,jj) = SUM( pvarin(ji,jj,ikt:ikb-1) * pe3(ji,jj,ikt:ikb-1) ) / phtbl(ji,jj) |
---|
| 147 | ! |
---|
| 148 | ! level partially include in ice shelf boundary layer |
---|
| 149 | pvarout(ji,jj) = pvarout(ji,jj) + pvarin(ji,jj,ikb) * pe3(ji,jj,ikb) / phtbl(ji,jj) * pfrac(ji,jj) |
---|
| 150 | ! |
---|
| 151 | END_2D |
---|
[11395] | 152 | |
---|
| 153 | END SUBROUTINE isf_tbl_avg |
---|
| 154 | |
---|
| 155 | SUBROUTINE isf_tbl_lvl( phw, pe3, ktop, kbot, phtbl, pfrac ) |
---|
[11403] | 156 | !!-------------------------------------------------------------------- |
---|
[11395] | 157 | !! *** ROUTINE isf_tbl_lvl *** |
---|
| 158 | !! |
---|
[11541] | 159 | !! ** Purpose : - compute bottom level off the top boundary layer |
---|
[11395] | 160 | !! - thickness of the top boundary layer |
---|
[11541] | 161 | !! - fraction of the bottom level affected by the tbl |
---|
[11395] | 162 | !! |
---|
[11495] | 163 | !!-------------------------- OUT -------------------------------------- |
---|
[11403] | 164 | INTEGER, DIMENSION(jpi,jpj) , INTENT( out) :: kbot ! bottom level of the top boundary layer |
---|
[11495] | 165 | REAL(wp), DIMENSION(jpi,jpj) , INTENT( out) :: pfrac ! fraction of bottom level in the tbl |
---|
| 166 | !!-------------------------- IN -------------------------------------- |
---|
[11403] | 167 | INTEGER, DIMENSION(jpi,jpj) , INTENT(in ) :: ktop ! top level of the top boundary layer |
---|
| 168 | REAL(wp), DIMENSION(jpi,jpj) , INTENT(in ) :: phw ! water column thickness |
---|
| 169 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pe3 ! vertical scale factor |
---|
[11495] | 170 | !!-------------------------- INOUT ------------------------------------ |
---|
| 171 | REAL(wp), DIMENSION(jpi,jpj) , INTENT(inout) :: phtbl ! top boundary layer thickness |
---|
[11395] | 172 | !!--------------------------------------------------------------------- |
---|
| 173 | INTEGER :: ji,jj,jk |
---|
| 174 | INTEGER :: ikt, ikb |
---|
| 175 | !!--------------------------------------------------------------------- |
---|
| 176 | ! |
---|
| 177 | ! get htbl |
---|
[13899] | 178 | DO_2D( 1, 1, 1, 1 ) |
---|
[12340] | 179 | ! |
---|
| 180 | ! tbl top/bottom indices initialisation |
---|
| 181 | ikt = ktop(ji,jj) |
---|
| 182 | ! |
---|
| 183 | ! limit the tbl to water thickness. |
---|
| 184 | phtbl(ji,jj) = MIN( phtbl(ji,jj), phw(ji,jj) ) |
---|
| 185 | ! |
---|
| 186 | ! thickness of boundary layer must be at least the top level thickness |
---|
| 187 | phtbl(ji,jj) = MAX( phtbl(ji,jj), pe3(ji,jj,ikt) ) |
---|
| 188 | ! |
---|
| 189 | END_2D |
---|
[11395] | 190 | ! |
---|
| 191 | ! get ktbl |
---|
[11541] | 192 | CALL isf_tbl_kbot(ktop, phtbl, pe3, kbot) |
---|
[11395] | 193 | ! |
---|
| 194 | ! get pfrac |
---|
[13899] | 195 | DO_2D( 1, 1, 1, 1 ) |
---|
[12340] | 196 | ! |
---|
| 197 | ! tbl top/bottom indices initialisation |
---|
| 198 | ikt = ktop(ji,jj) ; ikb = kbot(ji,jj) |
---|
| 199 | ! |
---|
| 200 | ! proportion of the bottom cell included in ice shelf boundary layer |
---|
| 201 | pfrac(ji,jj) = ( phtbl(ji,jj) - SUM( pe3(ji,jj,ikt:ikb-1) ) ) / pe3(ji,jj,ikb) |
---|
| 202 | ! |
---|
| 203 | END_2D |
---|
[11395] | 204 | ! |
---|
| 205 | END SUBROUTINE isf_tbl_lvl |
---|
| 206 | ! |
---|
[11541] | 207 | SUBROUTINE isf_tbl_kbot(ktop, phtbl, pe3, kbot) |
---|
[11403] | 208 | !!-------------------------------------------------------------------- |
---|
[11541] | 209 | !! *** ROUTINE isf_tbl_bot *** |
---|
[11403] | 210 | !! |
---|
| 211 | !! ** Purpose : compute bottom level of the isf top boundary layer |
---|
| 212 | !! |
---|
[11395] | 213 | !!-------------------------- OUT ------------------------------------- |
---|
[11403] | 214 | INTEGER, DIMENSION(jpi,jpj) , INTENT( out) :: kbot ! bottom level of the top boundary layer |
---|
[11395] | 215 | !!-------------------------- IN ------------------------------------- |
---|
[11403] | 216 | REAL(wp), DIMENSION(jpi,jpj) , INTENT(in ) :: phtbl ! top boundary layer thickness |
---|
| 217 | INTEGER, DIMENSION(jpi,jpj) , INTENT(in ) :: ktop ! top level of the top boundary layer |
---|
| 218 | REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pe3 ! vertical scale factor |
---|
| 219 | !!-------------------------------------------------------------------- |
---|
[11395] | 220 | INTEGER :: ji, jj |
---|
| 221 | INTEGER :: ikt, ikb |
---|
[11403] | 222 | !!-------------------------------------------------------------------- |
---|
[11395] | 223 | ! |
---|
| 224 | ! phtbl need to be bounded by water column thickness before |
---|
[11494] | 225 | ! test: if htbl = water column thickness, should return mbathy |
---|
[13237] | 226 | ! test: if htbl = 0 should return ktop (phtbl cap to pe3t(ji,jj,1)) |
---|
[11403] | 227 | ! |
---|
[11395] | 228 | ! get ktbl |
---|
[13899] | 229 | DO_2D( 1, 1, 1, 1 ) |
---|
[12340] | 230 | ! |
---|
| 231 | ! determine the deepest level influenced by the boundary layer |
---|
| 232 | ikt = ktop(ji,jj) |
---|
| 233 | ikb = ikt |
---|
| 234 | DO WHILE ( SUM(pe3(ji,jj,ikt:ikb-1)) < phtbl(ji,jj ) ) ; ikb = ikb + 1 ; END DO |
---|
| 235 | kbot(ji,jj) = ikb - 1 |
---|
| 236 | ! |
---|
| 237 | END_2D |
---|
[11395] | 238 | ! |
---|
[11541] | 239 | END SUBROUTINE isf_tbl_kbot |
---|
[11395] | 240 | ! |
---|
[11541] | 241 | SUBROUTINE isf_tbl_ktop(pdep, ktop) |
---|
[11403] | 242 | !!-------------------------------------------------------------------- |
---|
[11541] | 243 | !! *** ROUTINE isf_tbl_top *** |
---|
[11395] | 244 | !! |
---|
| 245 | !! ** Purpose : compute top level of the isf top boundary layer in case of an ice shelf parametrisation |
---|
| 246 | !! |
---|
| 247 | !!-------------------------- OUT ------------------------------------- |
---|
[11403] | 248 | INTEGER, DIMENSION(jpi,jpj), INTENT( out) :: ktop ! top level affected by the ice shelf parametrisation |
---|
[11395] | 249 | !!-------------------------- IN ------------------------------------- |
---|
[11876] | 250 | REAL(wp), DIMENSION(jpi,jpj), INTENT(inout) :: pdep ! top depth of the parametrisation influence |
---|
[11403] | 251 | !!-------------------------------------------------------------------- |
---|
[11395] | 252 | INTEGER :: ji,jj |
---|
| 253 | INTEGER :: ikt |
---|
[11403] | 254 | !!-------------------------------------------------------------------- |
---|
| 255 | ! |
---|
[11876] | 256 | ! if we need to recompute the top level at every time stepcompute top level (z*, z~) |
---|
[12068] | 257 | ! in case of weak ht variation we can assume the top level of htbl to be constant |
---|
[11876] | 258 | ! => only done using gdepw_0 |
---|
[11395] | 259 | ! be sure pdep is already correctly bounded |
---|
| 260 | ! test: this routine run on isfdraft should return mikt |
---|
| 261 | ! test: this routine run with pdep = 0 should return 1 |
---|
[11403] | 262 | ! |
---|
[13899] | 263 | DO_2D( 1, 1, 1, 1 ) |
---|
[12340] | 264 | ! comput ktop |
---|
| 265 | ikt = 2 |
---|
| 266 | DO WHILE ( gdepw_0(ji,jj,ikt) <= pdep(ji,jj ) ) ; ikt = ikt + 1 ; END DO |
---|
| 267 | ktop(ji,jj) = ikt - 1 |
---|
| 268 | ! |
---|
| 269 | ! update pdep |
---|
| 270 | pdep(ji,jj) = gdepw_0(ji,jj,ktop(ji,jj)) |
---|
| 271 | END_2D |
---|
[11395] | 272 | ! |
---|
[11541] | 273 | END SUBROUTINE isf_tbl_ktop |
---|
[11395] | 274 | |
---|
| 275 | END MODULE isftbl |
---|