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