-
Notifications
You must be signed in to change notification settings - Fork 237
/
vert_turb_driver_mod.F90
537 lines (423 loc) · 19.4 KB
/
vert_turb_driver_mod.F90
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
47
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
133
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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
module vert_turb_driver_mod
!-----------------------------------------------------------------------
!
! driver for compuing vertical diffusion coefficients
!
! choose either:
! 1) mellor-yamada 2.5 (with tke)
! 2) non-local K scheme
!
!-----------------------------------------------------------------------
!---------------- modules ---------------------
use my25_turb_mod, only: my25_turb_init, my25_turb_end, &
my25_turb, tke_surf, tke
use diffusivity_mod, only: diffusivity, molecular_diff
use shallow_conv_mod, only: shallow_conv_init, shallow_conv
!use diag_manager_mod, only: register_diag_field, send_data
!use time_manager_mod, only: time_type, get_time, operator(-)
use gcm_params_mod, only: gcm_LEN_MBUF, gcm_SQZ_R, gcm_stdMsgUnit
use constants_mod, only: rdgas, rvgas, kappa
!use fms_mod, only: error_mesg, open_namelist_file, file_exist, &
! check_nml_error, mpp_root_pe, &
! mpp_pe, close_file, FATAL, stdlog, &
! write_version_number
implicit none
private
!---------------- interfaces ---------------------
public vert_turb_driver_init, vert_turb_driver_end, vert_turb_driver
!-----------------------------------------------------------------------
!--------------------- version number ----------------------------------
character(len=128) :: version = '$Id: vert_turb_driver_mod.F90,v 1.2 2017/08/11 20:48:51 jmc Exp $'
character(len=128) :: tag = '$Name: $'
!-----------------------------------------------------------------------
real, parameter :: p00 = 1000.0E2
real, parameter :: p00inv = 1./p00
real, parameter :: d622 = rdgas/rvgas
real, parameter :: d378 = 1.-d622
real, parameter :: d608 = d378/d622
!---------------- private data -------------------
logical :: do_init = .true.
real :: gust_zi = 1000. ! constant for computed gustiness (meters)
!-----------------------------------------------------------------------
!-------------------- namelist -----------------------------------------
logical :: do_shallow_conv = .false.
logical :: do_mellor_yamada = .true.
logical :: use_tau = .true.
logical :: do_molecular_diffusion = .false.
character(len=24) :: gust_scheme = 'constant' ! valid schemes are:
! => 'constant'
! => 'beljaars'
real :: constant_gust = 1.0
namelist /vert_turb_driver_nml/ do_shallow_conv, do_mellor_yamada, &
gust_scheme, constant_gust, use_tau, &
do_molecular_diffusion
!-------------------- diagnostics fields -------------------------------
integer :: id_tke, id_lscale, id_lscale_0, id_z_pbl, id_gust, &
id_diff_t, id_diff_m, id_diff_sc, id_z_full, id_z_half,&
id_uwnd, id_vwnd
real :: missing_value = -999.
character(len=9) :: mod_name = 'vert_turb'
!-----------------------------------------------------------------------
contains
!#######################################################################
subroutine vert_turb_driver (is, js, Time, Time_next, dt, frac_land, &
p_half, p_full, z_half, z_full, &
u_star, b_star, rough, &
uu, vv, tt, qq, &
diff_t, diff_m, gust, &
myThid, mask, kbot )
! u, v, t, q, um, vm, tm, qm, &
! udt, vdt, tdt, qdt, &
!-----------------------------------------------------------------------
integer, intent(in) :: is, js
!type(time_type), intent(in) :: Time, Time_next
real, intent(in) :: Time, Time_next
real, intent(in) :: dt
real, intent(in), dimension(:,:) :: frac_land, &
u_star, b_star, rough
real, intent(in), dimension(:,:,:) :: p_half, p_full, &
z_half, z_full, &
uu, vv, tt, qq
! u, v, t, q, um, vm, tm, qm, &
! udt, vdt, tdt, qdt
real, intent(out), dimension(:,:,:) :: diff_t, diff_m
real, intent(out), dimension(:,:) :: gust
integer, intent(in) :: myThid
real, intent(in),optional, dimension(:,:,:) :: mask
integer, intent(in),optional, dimension(:,:) :: kbot
!-----------------------------------------------------------------------
real , dimension(size(tt,1),size(tt,2),size(tt,3)) :: ape, thv
!logical, dimension(size(tt,1),size(tt,2),size(tt,3)+1) :: lmask
!real , dimension(size(tt,1),size(tt,2),size(tt,3)+1) :: diag3
real , dimension(size(tt,1),size(tt,2),size(tt,3)+1) :: el
real , dimension(size(tt,1),size(tt,2)) :: el0, z_pbl
real , dimension(size(diff_t,1),size(diff_t,2), &
size(diff_t,3)) :: diff_sc
!real , dimension(size(t,1),size(t,2),size(t,3)) :: tt, qq, uu, vv
real :: dt_tke
integer :: ie, je, nlev, sec, day
logical :: used
!-----------------------------------------------------------------------
!----------------------- vertical turbulence ---------------------------
!-----------------------------------------------------------------------
if (do_init) CALL PRINT_ERROR( &
'vert_turb_driver in vert_turb_driver_mod'// &
'initialization has not been called', myThid )
! if (do_init) call error_mesg &
! ('vert_turb_driver in vert_turb_driver_mod', &
! 'initialization has not been called', FATAL)
nlev = size(p_full,3)
ie = is + size(p_full,1) - 1
je = js + size(p_full,2) - 1
!-----------------------------------------------------------------------
!---- set up state variable used by this module ----
! if (use_tau) then
! !-- variables at time tau
! uu = u
! vv = v
! tt = t
! qq = q
! else
! !-- variables at time tau+1
! uu = um + dt*udt
! vv = vm + dt*vdt
! tt = tm + dt*tdt
! qq = qm + dt*qdt
! endif
!-----------------------------------------------------------------------
!---------------------------
if (do_mellor_yamada) then
!---------------------------
! ----- time step for prognostic tke calculation -----
! call get_time (Time_next-Time, sec, day)
! dt_tke = real(sec+day*86400)
dt_tke = dt
! ----- virtual temp ----------
ape(:,:,:)=(p_full(:,:,:)*p00inv)**(-kappa)
thv(:,:,:)=tt(:,:,:)*(qq(:,:,:)*d608+1.0)*ape(:,:,:)
if (present(mask)) where (mask < 0.5) thv = 200.
! --------------------- update tke-----------------------------------
! ---- compute surface tke --------
! ---- compute tke, master length scale (el0), -------------
! ---- length scale (el), and vert mix coeffs (diff_t,diff_m) ----
call tke_surf (u_star, tke(is:ie,js:je,:), kbot=kbot)
if ( id_z_pbl > 0 ) then
!------ compute pbl depth from k_profile if diagnostic needed -----
call my25_turb (dt_tke, frac_land, p_half, p_full, thv, uu, vv, &
z_half, z_full, rough, tke(is:ie,js:je,:), &
el0, el, diff_m, diff_t, &
mask=mask, kbot=kbot, &
ustar=u_star,bstar=b_star,h=z_pbl)
else
call my25_turb (dt_tke, frac_land, p_half, p_full, thv, uu, vv, &
z_half, z_full, rough, tke(is:ie,js:je,:), &
el0, el, diff_m, diff_t, &
mask=mask, kbot=kbot)
end if
!---------------------------
else
!--------------------------------------------------------------------
!----------- compute molecular diffusion, if desired ---------------
if (do_molecular_diffusion) then
call molecular_diff (tt, p_half, diff_m, diff_t, myThid )
else
diff_m = 0.0
diff_t = 0.0
endif
!---------------------------
!------------------- non-local K scheme --------------
call diffusivity ( tt, qq, uu, vv, p_full, p_half, z_full, z_half, &
u_star, b_star, z_pbl, diff_m, diff_t, myThid, &
kbot = kbot)
!---------------------------
endif
!-----------------------------------------------------------------------
!------------------ shallow convection ???? ----------------------------
if (do_shallow_conv) then
call shallow_conv (tt, qq, p_full, p_half, diff_sc, kbot)
diff_t = diff_t + diff_sc
endif
!-----------------------------------------------------------------------
!------------- define gustiness ------------
if ( trim(gust_scheme) == 'constant' ) then
gust = constant_gust
else if ( trim(gust_scheme) == 'beljaars' ) then
! --- from Beljaars (1994) and Beljaars and Viterbo (1999) ---
where (b_star > 0.)
gust = (u_star*b_star*gust_zi)**(1./3.)
elsewhere
gust = 0.
endwhere
endif
!-----------------------------------------------------------------------
!------------------------ diagnostics section --------------------------
if (do_mellor_yamada) then
! --- set up local mask for fields with surface data ---
if ( present(mask) ) then
! lmask(:,:,1) = .true.
! lmask(:,:,2:nlev+1) = mask(:,:,1:nlev) > 0.5
else
! lmask = .true.
endif
!------- tke --------------------------------
if ( id_tke > 0 ) then
! used = send_data ( id_tke, tke(is:ie,js:je,:), Time_next, &
! is, js, 1, mask=lmask )
endif
!------- length scale (at half levels) ------
if ( id_lscale > 0 ) then
! used = send_data ( id_lscale, el, Time_next, is, js, 1, &
! mask=lmask )
endif
!------- master length scale -------
if ( id_lscale_0 > 0 ) then
! used = send_data ( id_lscale_0, el0, Time_next, is, js )
endif
end if
!------- boundary layer depth -------
if ( id_z_pbl > 0 ) then
! used = send_data ( id_z_pbl, z_pbl, Time_next, is, js )
endif
!------- gustiness -------
if ( id_gust > 0 ) then
! used = send_data ( id_gust, gust, Time_next, is, js )
endif
!------- output diffusion coefficients ---------
if ( id_diff_t > 0 .or. id_diff_m > 0 .or. id_diff_sc > 0 ) then
! --- set up local mask for fields without surface data ---
if (present(mask)) then
! lmask(:,:,1:nlev) = mask(:,:,1:nlev) > 0.5
! lmask(:,:,nlev+1) = .false.
else
! lmask(:,:,1:nlev) = .true.
! lmask(:,:,nlev+1) = .false.
endif
! -- dummy data at surface --
! diag3(:,:,nlev+1)=0.0
endif
!------- diffusion coefficient for heat/moisture -------
if ( id_diff_t > 0 ) then
! diag3(:,:,1:nlev) = diff_t(:,:,1:nlev)
! used = send_data ( id_diff_t, diag3, Time_next, is, js, 1, mask=lmask )
endif
!------- diffusion coefficient for momentum -------
if ( id_diff_m > 0 ) then
! diag3(:,:,1:nlev) = diff_m(:,:,1:nlev)
! used = send_data ( id_diff_m, diag3, Time_next, is, js, 1, mask=lmask )
endif
!------- diffusion coefficient for shallow conv -------
if (do_shallow_conv) then
if ( id_diff_sc > 0 ) then
! diag3(:,:,1:nlev) = diff_sc(:,:,1:nlev)
! used = send_data ( id_diff_sc, diag3, Time_next, is, js, 1, mask=lmask)
endif
endif
!--- geopotential height relative to the surface on full and half levels ----
if ( id_z_half > 0 ) then
!--- set up local mask for fields with surface data ---
if ( present(mask) ) then
! lmask(:,:,1) = .true.
! lmask(:,:,2:nlev+1) = mask(:,:,1:nlev) > 0.5
else
! lmask = .true.
endif
! used = send_data ( id_z_half, z_half, Time_next, is, js, 1, mask=lmask )
endif
if ( id_z_full > 0 ) then
! used = send_data ( id_z_full, z_full, Time_next, is, js, 1, rmask=mask)
endif
!--- zonal and meridional wind on mass grid -------
if ( id_uwnd > 0 ) then
! used = send_data ( id_uwnd, uu, Time_next, is, js, 1, rmask=mask)
endif
if ( id_vwnd > 0 ) then
! used = send_data ( id_vwnd, vv, Time_next, is, js, 1, rmask=mask)
endif
!-----------------------------------------------------------------------
end subroutine vert_turb_driver
!#######################################################################
subroutine vert_turb_driver_init (id, jd, kd, axes, Time, myThid)
!-----------------------------------------------------------------------
integer, intent(in) :: id, jd, kd, axes(4)
! type(time_type), intent(in) :: Time
real, intent(in) :: Time
integer, intent(in) :: myThid
!-----------------------------------------------------------------------
integer, dimension(3) :: full = (/1,2,3/), half = (/1,2,4/)
integer :: ierr, unit, io
integer :: iUnit
CHARACTER*(gcm_LEN_MBUF) :: msgBuf
if (.not.do_init) CALL PRINT_ERROR( &
'vert_turb_driver_init in vert_turb_driver_mod'// &
'attempting to call initialization twice', myThid )
! if (.not.do_init) &
! call error_mesg &
! ('vert_turb_driver_init in vert_turb_driver_mod', &
! 'attempting to call initialization twice', FATAL)
!-----------------------------------------------------------------------
!--------------- read namelist ------------------
! _BARRIER
! _BEGIN_MASTER(myThid)
CALL BARRIER(myThid)
IF ( myThid.EQ.1 ) THEN
WRITE(msgBuf,'(A)') 'VERT_TURB_DRIVER_INIT: opening data.atm_gray'
CALL PRINT_MESSAGE( msgBuf, gcm_stdMsgUnit, gcm_SQZ_R, myThid )
CALL OPEN_COPY_DATA_FILE( &
'data.atm_gray', 'VERT_TURB_DRIVER_INIT', &
iUnit, &
myThid )
! Read parameters from open data file
READ(UNIT=iUnit,NML=vert_turb_driver_nml)
WRITE(msgBuf,'(A)') &
'VERT_TURB_DRIVER_INIT: finished reading data.atm_gray'
CALL PRINT_MESSAGE( msgBuf, gcm_stdMsgUnit, gcm_SQZ_R, myThid )
! Close the open data file
#ifdef SINGLE_DISK_IO
CLOSE(iUnit)
#else
CLOSE(iUnit,STATUS='DELETE')
#endif /* SINGLE_DISK_IO */
! if (file_exist('input.nml')) then
! unit = open_namelist_file ()
! ierr=1; do while (ierr /= 0)
! read (unit, nml=vert_turb_driver_nml, iostat=io, end=10)
! ierr = check_nml_error (io, 'vert_turb_driver_nml')
! enddo
! 10 call close_file (unit)
! endif
!---------- output namelist --------------------------------------------
! call write_version_number(version, tag)
! if ( mpp_pe() == mpp_root_pe() ) write (stdlog(), nml=vert_turb_driver_nml)
! --- check namelist option ---
if ( trim(gust_scheme) /= 'constant' .and. &
trim(gust_scheme) /= 'beljaars' ) CALL PRINT_ERROR( &
'vert_turb_driver_mod'//'invalid value for namelist'// &
' variable GUST_SCHEME', myThid )
! trim(gust_scheme) /= 'beljaars' ) call error_mesg &
! ('vert_turb_driver_mod', 'invalid value for namelist &
! &variable GUST_SCHEME', FATAL)
if (do_molecular_diffusion .and. do_mellor_yamada) CALL PRINT_ERROR( &
'vert_turb_driver_mod'//' cannot activate'// &
' molecular diffusion with mellor_yamada', myThid )
! if (do_molecular_diffusion .and. do_mellor_yamada) &
! call error_mesg ( 'vert_turb_driver_mod', 'cannot activate &
! &molecular diffusion with mellor_yamada', FATAL)
!-----------------------------------------------------------------------
if (do_mellor_yamada) call my25_turb_init (id, jd, kd)
if (do_shallow_conv) call shallow_conv_init (kd)
!-----------------------------------------------------------------------
!----- initialize diagnostic fields -----
id_tke = 0
id_lscale = 0
id_lscale_0 = 0
id_z_pbl = 0
id_gust = 0
id_diff_t = 0
id_diff_m = 0
id_diff_sc = 0
id_z_full = 0
id_z_half = 0
id_uwnd = 0
id_vwnd = 0
! id_uwnd = register_diag_field ( mod_name, 'uwnd', axes(full), Time, &
! 'zonal wind on mass grid', 'meters/second' , &
!missing_value=missing_value )
! id_vwnd = register_diag_field ( mod_name, 'vwnd', axes(full), Time, &
! 'meridional wind on mass grid', 'meters/second' , &
!missing_value=missing_value )
! id_z_full = &
! register_diag_field ( mod_name, 'z_full', axes(full), Time, &
! 'geopotential height relative to surface at full levels', &
! 'meters' , missing_value=missing_value )
! id_z_half = &
! register_diag_field ( mod_name, 'z_half', axes(half), Time, &
! 'geopotential height relative to surface at half levels', &
! 'meters' , missing_value=missing_value )
if (do_mellor_yamada) then
! id_tke = &
! register_diag_field ( mod_name, 'tke', axes(half), Time, &
! 'turbulent kinetic energy', 'm2/s2' , &
! missing_value=missing_value )
! id_lscale = &
! register_diag_field ( mod_name, 'lscale', axes(half), Time, &
! 'turbulent length scale', 'm' , &
! missing_value=missing_value )
! id_lscale_0 = &
! register_diag_field ( mod_name, 'lscale_0', axes(1:2), Time, &
! 'master length scale', 'm' )
endif
! id_z_pbl = &
! register_diag_field ( mod_name, 'z_pbl', axes(1:2), Time, &
! 'depth of planetary boundary layer', 'm' )
! id_gust = &
! register_diag_field ( mod_name, 'gust', axes(1:2), Time, &
! 'wind gustiness in surface layer', 'm/s' )
! id_diff_t = &
! register_diag_field ( mod_name, 'diff_t', axes(half), Time, &
! 'vert diff coeff for temp', 'm2/s' , &
! missing_value=missing_value )
! id_diff_m = &
! register_diag_field ( mod_name, 'diff_m', axes(half), Time, &
! 'vert diff coeff for momentum', 'm2/s' , &
! missing_value=missing_value )
if (do_shallow_conv) then
! id_diff_sc = &
! register_diag_field ( mod_name, 'diff_sc', axes(half), Time, &
! 'vert diff coeff for shallow conv', 'm2/s' , &
! missing_value=missing_value )
endif
!-----------------------------------------------------------------------
do_init=.false.
ENDIF
CALL BARRIER(myThid)
!-----------------------------------------------------------------------
end subroutine vert_turb_driver_init
!#######################################################################
subroutine vert_turb_driver_end(myThid)
integer, intent(in) :: myThid
!-----------------------------------------------------------------------
if (do_mellor_yamada) call my25_turb_end
!-----------------------------------------------------------------------
end subroutine vert_turb_driver_end
!#######################################################################
end module vert_turb_driver_mod