-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathadvance_windm_edsclrm_module.F90
2605 lines (2201 loc) · 108 KB
/
advance_windm_edsclrm_module.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
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
module advance_windm_edsclrm_module
implicit none
private ! Set Default Scope
public :: advance_windm_edsclrm
private :: windm_edsclrm_solve, &
compute_uv_tndcy, &
windm_edsclrm_lhs, &
windm_edsclrm_rhs
! Private named constants to avoid string comparisons
integer, parameter, private :: &
windm_edsclrm_um = 1, & ! Named constant to handle um solves
windm_edsclrm_vm = 2, & ! Named constant to handle vm solves
windm_edsclrm_scalar = 3, & ! Named constant to handle scalar solves
clip_upwp = 10, & ! Named constant for upwp clipping
! NOTE: This must be the same as the clip_upwp
! declared in clip_explicit!
clip_vpwp = 11 ! Named constant for vpwp clipping
! NOTE: This must be the same as the clip_vpwp
! declared in clip_explicit!
contains
!=============================================================================
subroutine advance_windm_edsclrm( nz, ngrdcol, gr, dt, &
wm_zt, Km_zm, Kmh_zm, &
ug, vg, um_ref, vm_ref, &
wp2, up2, vp2, um_forcing, vm_forcing, &
edsclrm_forcing, &
rho_ds_zm, invrs_rho_ds_zt, &
fcor, l_implemented, &
nu_vert_res_dep, &
tridiag_solve_method, &
l_predict_upwp_vpwp, &
l_upwind_xm_ma, &
l_uv_nudge, &
l_tke_aniso, &
l_lmm_stepping, &
l_linearize_pbl_winds, &
order_xp2_xpyp, order_wp2_wp3, order_windm, &
stats_metadata, &
stats_zt, stats_zm, stats_sfc, &
um, vm, edsclrm, &
upwp, vpwp, wpedsclrp, &
um_pert, vm_pert, upwp_pert, vpwp_pert )
! Description:
! Solves for both mean horizontal wind components, um and vm, and for the
! eddy-scalars (passive scalars that don't use the high-order closure).
! Uses the LAPACK tridiagonal solver subroutine with 2 + # of scalar(s)
! back substitutions (since the left hand side matrix is the same for all
! input variables).
! References:
! Eqn. 8 & 9 on p. 3545 of
! ``A PDF-Based Model for Boundary Layer Clouds. Part I:
! Method and Model Description'' Golaz, et al. (2002)
! JAS, Vol. 59, pp. 3540--3551.
!-----------------------------------------------------------------------
use grid_class, only: &
grid, & ! Type
zm2zt
use parameters_model, only: &
ts_nudge, & ! Variable(s)
edsclr_dim
use parameters_tunable, only: &
nu_vertical_res_dep ! Type(s)
use clubb_precision, only: &
core_rknd ! Variable(s)
use stats_type_utilities, only: &
stat_begin_update, & ! Subroutines
stat_end_update, &
stat_update_var
use stats_variables, only: &
stats_metadata_type
use clip_explicit, only: &
clip_covar ! Procedure(s)
use error_code, only: &
clubb_at_least_debug_level, & ! Procedure
err_code, & ! Error Indicator
clubb_fatal_error ! Constant
use constants_clubb, only: &
one_half, & ! Constant(s)
zero, &
fstderr, &
eps
use sponge_layer_damping, only: &
uv_sponge_damp_settings, &
uv_sponge_damp_profile, &
sponge_damp_xm ! Procedure(s)
use stats_type, only: stats ! Type
use diffusion, only: &
diffusion_zt_lhs ! Procedure(s)
use mean_adv, only: &
term_ma_zt_lhs ! Procedures
use model_flags, only: &
l_upwind_Kh_dp_term
use advance_helper_module, only: &
calc_xpwp
implicit none
! ------------------------ Input Variables ------------------------
integer, intent(in) :: &
nz, &
ngrdcol
type (grid), target, intent(in) :: &
gr
real( kind = core_rknd ), intent(in) :: &
dt ! Model timestep [s]
real( kind = core_rknd ), dimension(ngrdcol,nz), intent(in) :: &
wm_zt, & ! w wind component on thermodynamic levels [m/s]
Km_zm, & ! Eddy diffusivity of winds on momentum levs. [m^2/s]
Kmh_zm, & ! Eddy diffusivity of themo on momentum levs. [m^s/s]
ug, & ! u (west-to-east) geostrophic wind comp. [m/s]
vg, & ! v (south-to-north) geostrophic wind comp. [m/s]
um_ref, & ! Reference u wind component for nudging [m/s]
vm_ref, & ! Reference v wind component for nudging [m/s]
wp2, & ! w'^2 (momentum levels) [m^2/s^2]
up2, & ! u'^2 (momentum levels) [m^2/s^2]
vp2, & ! v'^2 (momentum levels) [m^2/s^2]
um_forcing, & ! u forcing [m/s/s]
vm_forcing, & ! v forcing [m/s/s]
rho_ds_zm, & ! Dry, static density on momentum levels [kg/m^3]
invrs_rho_ds_zt ! Inv. dry, static density at thermo. levels [m^3/kg]
real( kind = core_rknd ), dimension(ngrdcol,nz,edsclr_dim), intent(in) :: &
edsclrm_forcing ! Eddy scalar large-scale forcing [{units vary}/s]
real( kind = core_rknd ), dimension(ngrdcol), intent(in) :: &
fcor ! Coriolis parameter [s^-1]
logical, intent(in) :: &
l_implemented ! Flag for CLUBB being implemented in a larger model.
type(nu_vertical_res_dep), intent(in) :: &
nu_vert_res_dep ! Vertical resolution dependent nu values
integer, intent(in) :: &
tridiag_solve_method ! Specifier for method to solve tridiagonal systems
logical, intent(in) :: &
l_predict_upwp_vpwp, & ! Flag to predict <u'w'> and <v'w'> along with <u> and <v> alongside
! the advancement of <rt>, <w'rt'>, <thl>, <wpthlp>, <sclr>, and
! <w'sclr'> in subroutine advance_xm_wpxp. Otherwise, <u'w'> and
! <v'w'> are still approximated by eddy diffusivity when <u> and <v>
! are advanced in subroutine advance_windm_edsclrm.
l_upwind_xm_ma, & ! This flag determines whether we want to use an upwind differencing
! approximation rather than a centered differencing for turbulent or
! mean advection terms. It affects rtm, thlm, sclrm, um and vm.
l_uv_nudge, & ! For wind speed nudging
l_tke_aniso, & ! For anisotropic turbulent kinetic energy, i.e. TKE = 1/2
! (u'^2 + v'^2 + w'^2)
l_lmm_stepping, & ! Apply Linear Multistep Method (LMM) Stepping
l_linearize_pbl_winds ! Flag (used by E3SM) to linearize PBL winds
integer, intent(in) :: &
order_xp2_xpyp, &
order_wp2_wp3, &
order_windm
type (stats_metadata_type), intent(in) :: &
stats_metadata
! ------------------------ Input/Output Variables ------------------------
type (stats), dimension(ngrdcol), target, intent(inout) :: &
stats_zt, &
stats_zm, &
stats_sfc
real( kind = core_rknd ), dimension(ngrdcol,nz), intent(inout) :: &
um, & ! Mean u (west-to-east) wind component [m/s]
vm, & ! Mean v (south-to-north) wind component [m/s]
upwp, & ! <u'w'> (momentum levels) [m^2/s^2]
vpwp ! <v'w'> (momentum levels) [m^2/s^2]
! Input/Output Variable for eddy-scalars
real( kind = core_rknd ), dimension(ngrdcol,nz,edsclr_dim), intent(inout) :: &
edsclrm ! Mean eddy scalar quantity [units vary]
! Output Variable for eddy-scalars
real( kind = core_rknd ), dimension(ngrdcol,nz,edsclr_dim), intent(inout) :: &
wpedsclrp ! w'edsclr' (momentum levels) [m/s {units vary}]
! Variables used to track perturbed version of winds.
real( kind = core_rknd ), dimension(ngrdcol,nz), intent(inout) :: &
um_pert, & ! perturbed <u> [m/s]
vm_pert, & ! perturbed <v> [m/s]
upwp_pert, & ! perturbed <u'w'> [m^2/s^2]
vpwp_pert ! perturbed <v'w'> [m^2/s^2]
! ------------------------ Local Variables ------------------------
real( kind = core_rknd ), dimension(ngrdcol,nz) :: &
um_old, & ! Saved value of mean u (west-to-east) wind component [m/s]
vm_old ! Saved value of Mean v (south-to-north) wind component [m/s]
real( kind = core_rknd ), dimension(ngrdcol,nz,edsclr_dim) :: &
edsclrm_old ! Saved value of mean eddy scalar quantity [units vary]
real( kind = core_rknd ), dimension(ngrdcol,nz) :: &
um_tndcy, & ! u wind component tendency [m/s^2]
vm_tndcy ! v wind component tendency [m/s^2]
real( kind = core_rknd ), dimension(ngrdcol,nz) :: &
upwp_chnge, & ! Net change of u'w' due to clipping [m^2/s^2]
vpwp_chnge ! Net change of v'w' due to clipping [m^2/s^2]
real( kind = core_rknd ), dimension(3,ngrdcol,nz) :: &
lhs ! The implicit part of the tridiagonal matrix [units vary]
real( kind = core_rknd ), dimension(ngrdcol,nz,max(2,edsclr_dim)) :: &
rhs, &! The explicit part of the tridiagonal matrix [units vary]
solution ! The solution to the tridiagonal matrix [units vary]
real( kind = core_rknd ), dimension(ngrdcol,nz) :: &
wind_speed, & ! wind speed; sqrt(u^2 + v^2) [m/s]
wind_speed_pert ! perturbed wind speed; sprt(u^2 + v^2) [m/s]
real( kind = core_rknd ), dimension(ngrdcol) :: &
u_star_sqd, & ! Surface friction velocity, u_star, squared [m/s]
u_star_sqd_pert ! perturbed u_star, squared [m/s]
logical :: &
l_imp_sfc_momentum_flux ! Flag for implicit momentum surface fluxes.
integer :: nrhs ! Number of right hand side terms
integer :: i, k, edsclr, j ! Array index
logical :: l_first_clip_ts, l_last_clip_ts ! flags for clip_covar
real( kind = core_rknd ), dimension(ngrdcol) :: &
nu_zero
real( kind = core_rknd ), dimension(3,ngrdcol,nz) :: &
lhs_diff, & ! LHS diffustion terms
lhs_ma_zt ! LHS mean advection terms
real( kind = core_rknd ), dimension(ngrdcol,nz) :: &
Km_zt, & ! Eddy diffusivity of winds on momentum levs. [m^2/s]
Kmh_zt, & ! Eddy diffusivity of themo on momentum levs. [m^s/s]
Km_zm_p_nu10, & ! Km_zm plus nu_vert_res_dep%nu10
xpwp ! x'w' for arbitrary x
integer, parameter :: &
kp1_tdiag = 1, & ! Thermodynamic superdiagonal index.
k_tdiag = 2, & ! Thermodynamic main diagonal index.
km1_tdiag = 3 ! Thermodynamic subdiagonal index.
! Whether perturbed winds are being solved.
logical :: l_perturbed_wind
! ------------------------ Begin Code ------------------------
!$acc enter data create( um_old, vm_old, um_tndcy, vm_tndcy, &
!$acc upwp_chnge, vpwp_chnge, lhs, rhs, solution, wind_speed, &
!$acc wind_speed_pert, u_star_sqd, u_star_sqd_pert, &
!$acc nu_zero, lhs_diff, lhs_ma_zt, Km_zt, Kmh_zt, &
!$acc Km_zm_p_nu10, xpwp )
!$acc enter data if( edsclr_dim > 0) create( edsclrm_old )
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
nu_zero(i) = zero
end do
!$acc end parallel loop
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
Km_zm_p_nu10(i,k) = Km_zm(i,k) + nu_vert_res_dep%nu10(i)
end do
end do
!$acc end parallel loop
l_perturbed_wind = ( .not. l_predict_upwp_vpwp ) .and. l_linearize_pbl_winds
if ( .not. l_implemented ) then
call term_ma_zt_lhs( nz, ngrdcol, wm_zt, gr%weights_zt2zm, & ! intent(in)
gr%invrs_dzt, gr%invrs_dzm, & ! intent(in)
l_upwind_xm_ma, & ! intent(in)
lhs_ma_zt ) ! intent(out)
else
!$acc parallel loop gang vector collapse(3) default(present)
do k = 1, nz
do i = 1, ngrdcol
do j = 1, 3
lhs_ma_zt(j,i,k) = zero
end do
end do
end do
!$acc end parallel loop
end if
if ( .not. l_predict_upwp_vpwp ) then
Km_zt(:,:) = zm2zt( nz, ngrdcol, gr, Km_zm(:,:) )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
Km_zt(i,k) = max( Km_zt(i,k), zero )
end do
end do
!$acc end parallel loop
! Calculate diffusion terms
call diffusion_zt_lhs( nz, ngrdcol, gr, Km_zm, Km_zt, nu_vert_res_dep%nu10, & ! In
invrs_rho_ds_zt, rho_ds_zm, & ! In
lhs_diff ) ! Out
! The lower boundary condition needs to be applied here at level 2.
if ( .not. l_upwind_Kh_dp_term ) then
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
! Thermodynamic superdiagonal: [ x xm(k+1,<t+1>) ]
lhs_diff(kp1_tdiag,i,2) = - gr%invrs_dzt(i,2) * invrs_rho_ds_zt(i,2) &
* ( Km_zm(i,2) + nu_vert_res_dep%nu10(i) ) &
* rho_ds_zm(i,2) * gr%invrs_dzm(i,2)
! Thermodynamic main diagonal: [ x xm(k,<t+1>) ]
lhs_diff(k_tdiag,i,2) = + gr%invrs_dzt(i,2) * invrs_rho_ds_zt(i,2) &
* ( Km_zm(i,2) + nu_vert_res_dep%nu10(i) ) &
* rho_ds_zm(i,2) * gr%invrs_dzm(i,2)
! Thermodynamic subdiagonal: [ x xm(k-1,<t+1>) ]
lhs_diff(km1_tdiag,i,2) = zero
end do
!$acc end parallel loop
else
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
! Thermodynamic superdiagonal: [ x xm(k+1,<t+1>) ]
lhs_diff(kp1_tdiag,i,2) = - gr%invrs_dzt(i,2) &
* ( Km_zt(i,2) + nu_vert_res_dep%nu10(i) ) &
* gr%invrs_dzm(i,2)
! Thermodynamic main diagonal: [ x xm(k,<t+1>) ]
lhs_diff(k_tdiag,i,2) = + gr%invrs_dzt(i,2) &
* ( Km_zt(i,2) + nu_vert_res_dep%nu10(i) ) &
* gr%invrs_dzm(i,2)
! Thermodynamic subdiagonal: [ x xm(k-1,<t+1>) ]
lhs_diff(km1_tdiag,i,2) = zero
end do
!$acc end parallel loop
end if
if ( l_lmm_stepping ) then
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
um_old(i,k) = um(i,k)
vm_old(i,k) = vm(i,k)
end do
end do
!$acc end parallel loop
end if ! l_lmm_stepping
!----------------------------------------------------------------
! Prepare tridiagonal system for horizontal winds, um and vm
!----------------------------------------------------------------
! Compute Coriolis, geostrophic, and other prescribed wind forcings for um.
call compute_uv_tndcy( nz, ngrdcol, windm_edsclrm_um, & ! intent(in)
fcor, vm, vg, & ! intent(in)
um_forcing, l_implemented, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
um_tndcy ) ! intent(out)
! Compute Coriolis, geostrophic, and other prescribed wind forcings for vm.
call compute_uv_tndcy( nz, ngrdcol, windm_edsclrm_vm, & ! intent(in)
fcor, um, ug, & ! intent(in)
vm_forcing, l_implemented, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
vm_tndcy ) ! intent(out)
! Momentum surface fluxes, u'w'|_sfc and v'w'|_sfc, are applied through
! an implicit method, such that:
! x'w'|_sfc = - ( u_star(t)^2 / wind_speed(t) ) * xm(t+1).
l_imp_sfc_momentum_flux = .true.
! Compute wind speed (use threshold "eps" to prevent divide-by-zero
! error).
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
wind_speed(i,k) = max( sqrt( um(i,k)**2 + vm(i,k)**2 ), eps )
end do
end do
!$acc end parallel loop
! Compute u_star_sqd according to the definition of u_star.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
u_star_sqd(i) = sqrt( upwp(i,1)**2 + vpwp(i,1)**2 )
end do
!$acc end parallel loop
! Compute the explicit portion of the um equation.
! Build the right-hand side vector.
call windm_edsclrm_rhs( nz, ngrdcol, gr, windm_edsclrm_um, dt, & ! intent(in)
lhs_diff, um, um_tndcy, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_imp_sfc_momentum_flux, upwp(:,1), & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
rhs(:,:,windm_edsclrm_um) ) ! intent(out)
! Compute the explicit portion of the vm equation.
! Build the right-hand side vector.
call windm_edsclrm_rhs( nz, ngrdcol, gr, windm_edsclrm_vm, dt, & ! intent(in)
lhs_diff, vm, vm_tndcy, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_imp_sfc_momentum_flux, vpwp(:,1), & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
rhs(:,:,windm_edsclrm_vm) ) ! intent(out)
! Store momentum flux (explicit component)
! The surface flux, x'w'(1) = x'w'|_sfc, is set elsewhere in the model.
! upwp(1) = upwp_sfc
! vpwp(1) = vpwp_sfc
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, um, &
xpwp )
! Solve for x'w' at all intermediate model levels.
! A Crank-Nicholson timestep is used.
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
upwp(i,k) = -one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, vm, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
vpwp(i,k) = -one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
! A zero-flux boundary condition at the top of the model, d(xm)/dz = 0,
! means that x'w' at the top model level is 0,
! since x'w' = - K_zm * d(xm)/dz.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
upwp(i,nz) = zero
vpwp(i,nz) = zero
end do
!$acc end parallel loop
! Compute the implicit portion of the um and vm equations.
! Build the left-hand side matrix.
call windm_edsclrm_lhs( nz, ngrdcol, gr, dt, & ! intent(in)
lhs_ma_zt, lhs_diff, & ! intent(in)
wind_speed, u_star_sqd, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_implemented, l_imp_sfc_momentum_flux, & ! intent(in)
lhs ) ! intent(out)
! Decompose and back substitute for um and vm
nrhs = 2
call windm_edsclrm_solve( nz, ngrdcol, gr, nrhs, stats_metadata%iwindm_matrix_condt_num, & ! intent(in)
tridiag_solve_method, & ! intent(in)
stats_metadata, & ! intent(in)
stats_sfc, & ! intent(inout)
lhs, rhs, & ! intent(inout)
solution ) ! intent(out)
! Check for singular matrices and bad LAPACK arguments
if ( clubb_at_least_debug_level( 0 ) ) then
if ( err_code == clubb_fatal_error ) then
write(fstderr,*) "Fatal error solving for um/vm"
return
end if
end if
!----------------------------------------------------------------
! Update zonal (west-to-east) component of mean wind, um
!----------------------------------------------------------------
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
um(i,k) = solution(i,k,windm_edsclrm_um)
end do
end do
!$acc end parallel loop
!----------------------------------------------------------------
! Update meridional (south-to-north) component of mean wind, vm
!----------------------------------------------------------------
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
vm(i,k) = solution(i,k,windm_edsclrm_vm)
end do
end do
!$acc end parallel loop
if ( stats_metadata%l_stats_samp ) then
!$acc update host( um, lhs_diff, lhs_ma_zt, invrs_rho_ds_zt, u_star_sqd, &
!$acc rho_ds_zm, wind_speed, vm )
do i = 1, ngrdcol
! Implicit contributions to um and vm
call windm_edsclrm_implicit_stats( nz, windm_edsclrm_um, um(i,:), & ! intent(in)
gr%invrs_dzt(i,:), & ! intent(in)
lhs_diff(:,i,:), lhs_ma_zt(:,i,:), & ! intent(in)
invrs_rho_ds_zt(i,:), u_star_sqd(i), & ! intent(in)
rho_ds_zm(i,:), wind_speed(i,:), & ! intent(in)
l_imp_sfc_momentum_flux, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt(i) ) ! intent(inout)
call windm_edsclrm_implicit_stats( nz, windm_edsclrm_vm, vm(i,:), & ! intent(in)
gr%invrs_dzt(i,:), & ! intent(in)
lhs_diff(:,i,:), lhs_ma_zt(:,i,:), & ! intent(in)
invrs_rho_ds_zt(i,:), u_star_sqd(i), & ! intent(in)
rho_ds_zm(i,:), wind_speed(i,:), & ! intent(in)
l_imp_sfc_momentum_flux, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if ! stats_metadata%l_stats_samp
! The values of um(1) and vm(1) are located below the model surface and
! do not affect the rest of the model. The values of um(1) or vm(1) are
! simply set to the values of um(2) and vm(2), respectively, after the
! equation matrices has been solved. Even though um and vm would sharply
! decrease to a value of 0 at the surface, this is done to avoid
! confusion on plots of the vertical profiles of um and vm.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
um(i,1) = um(i,2)
vm(i,1) = vm(i,2)
end do
!$acc end parallel loop
if ( l_lmm_stepping ) then
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
um(i,k) = one_half * ( um_old(i,k) + um(i,k) )
vm(i,k) = one_half * ( vm_old(i,k) + vm(i,k) )
end do
end do
!$acc end parallel loop
endif ! l_lmm_stepping ) then
if ( uv_sponge_damp_settings%l_sponge_damping ) then
!$acc update host( um, vm, um_ref, vm_ref )
! _sponge_damp_settings and _sponge_damp_profile could potentially vary
! from column to column, but there is no column index in those variables.
! Thus this code is potentially unsafe when implemented in a host model,
! which is indicated by l_implemented = T
if ( l_implemented ) then
write(fstderr,*) "l_sponge_damping = T and l_implemented = T &
-- this is likely unsafe and considered fatal"
err_code = clubb_fatal_error
return
end if
if ( stats_metadata%l_stats_samp ) then
do i = 1, ngrdcol
call stat_begin_update( nz, stats_metadata%ium_sdmp, um(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
call stat_begin_update( nz, stats_metadata%ivm_sdmp, vm(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if
do i = 1, ngrdcol
um(i,1:nz) = sponge_damp_xm( nz, dt, gr%zt(i,:), gr%zm(i,:), &
um_ref(i,1:nz), um(i,1:nz), uv_sponge_damp_profile )
end do
do i = 1, ngrdcol
vm(i,1:nz) = sponge_damp_xm( nz, dt, gr%zt(i,:), gr%zm(i,:), &
vm_ref(i,1:nz), vm(i,1:nz), uv_sponge_damp_profile )
end do
if ( stats_metadata%l_stats_samp ) then
do i = 1, ngrdcol
call stat_end_update( nz, stats_metadata%ium_sdmp, um(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
call stat_end_update( nz, stats_metadata%ivm_sdmp, vm(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if
!$acc update device( um, vm )
end if ! uv_sponge_damp_settings%l_sponge_damping
! Second part of momentum (implicit component)
! Solve for x'w' at all intermediate model levels.
! A Crank-Nicholson timestep is used.
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, um, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
upwp(i,k) = upwp(i,k) - one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, vm, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
vpwp(i,k) = vpwp(i,k) - one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
! Adjust um and vm if nudging is turned on.
if ( l_uv_nudge ) then
! Reflect nudging in budget
if ( stats_metadata%l_stats_samp ) then
!$acc update host( um, vm )
do i = 1, ngrdcol
call stat_begin_update( nz, stats_metadata%ium_ndg, um(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
call stat_begin_update( nz, stats_metadata%ivm_ndg, vm(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
um(i,k) = um(i,k) - ( ( um(i,k) - um_ref(i,k) ) * (dt/ts_nudge) )
vm(i,k) = vm(i,k) - ( ( vm(i,k) - vm_ref(i,k) ) * (dt/ts_nudge) )
end do
end do
!$acc end parallel loop
if ( stats_metadata%l_stats_samp ) then
!$acc update host( um, vm )
do i = 1, ngrdcol
call stat_end_update( nz, stats_metadata%ium_ndg, um(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
call stat_end_update( nz, stats_metadata%ivm_ndg, vm(i,:) / dt, & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if
end if ! l_uv_nudge
if ( stats_metadata%l_stats_samp ) then
!$acc update host( um_ref, vm_ref )
do i = 1, ngrdcol
call stat_update_var( stats_metadata%ium_ref, um_ref(i,:), & ! intent(in)
stats_zt(i) ) ! intent(inout)
call stat_update_var( stats_metadata%ivm_ref, vm_ref(i,:), & ! intent(in)
stats_zt(i) ) ! intent(inout)
end do
end if
if ( order_windm < order_wp2_wp3 &
.and. order_windm < order_xp2_xpyp ) then
l_first_clip_ts = .true.
l_last_clip_ts = .false.
elseif ( order_windm > order_wp2_wp3 &
.and. order_windm > order_xp2_xpyp ) then
l_first_clip_ts = .false.
l_last_clip_ts = .true.
else
l_first_clip_ts = .false.
l_last_clip_ts = .false.
endif
if ( l_tke_aniso ) then
! Clipping for u'w'
!
! Clipping u'w' at each vertical level, based on the
! correlation of u and w at each vertical level, such that:
! corr_(u,w) = u'w' / [ sqrt(u'^2) * sqrt(w'^2) ];
! -1 <= corr_(u,w) <= 1.
!
! Since u'^2, w'^2, and u'w' are each advanced in different
! subroutines from each other in advance_clubb_core, clipping for u'w'
! has to be done three times during each timestep (once after each
! variable has been updated).
! This is the third instance of u'w' clipping.
!l_first_clip_ts = .false.
!l_last_clip_ts = .true.
call clip_covar( nz, ngrdcol, gr, clip_upwp, l_first_clip_ts, & ! intent(in)
l_last_clip_ts, dt, wp2, up2, & ! intent(in)
l_predict_upwp_vpwp, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zm, & ! intent(inout)
upwp, upwp_chnge ) ! intent(inout)
! Clipping for v'w'
!
! Clipping v'w' at each vertical level, based on the
! correlation of v and w at each vertical level, such that:
! corr_(v,w) = v'w' / [ sqrt(v'^2) * sqrt(w'^2) ];
! -1 <= corr_(v,w) <= 1.
!
! Since v'^2, w'^2, and v'w' are each advanced in different
! subroutines from each other in advance_clubb_core, clipping for v'w'
! has to be done three times during each timestep (once after each
! variable has been updated).
! This is the third instance of v'w' clipping.
!l_first_clip_ts = .false.
!l_last_clip_ts = .true.
call clip_covar( nz, ngrdcol, gr, clip_vpwp, l_first_clip_ts, & ! intent(in)
l_last_clip_ts, dt, wp2, vp2, & ! intent(in)
l_predict_upwp_vpwp, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zm, & ! intent(inout)
vpwp, vpwp_chnge ) ! intent(inout)
else
! intent(in) this case, it is assumed that
! u'^2 == v'^2 == w'^2, and the variables `up2' and `vp2' do not
! interact with any other variables.
!l_first_clip_ts = .false.
!l_last_clip_ts = .true.
call clip_covar( nz, ngrdcol, gr, clip_upwp, l_first_clip_ts, & ! intent(in)
l_last_clip_ts, dt, wp2, wp2, & ! intent(in)
l_predict_upwp_vpwp, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zm, & ! intent(inout)
upwp, upwp_chnge ) ! intent(inout)
call clip_covar( nz, ngrdcol, gr, clip_vpwp, l_first_clip_ts, & ! intent(in)
l_last_clip_ts, dt, wp2, wp2, & ! intent(in)
l_predict_upwp_vpwp, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zm, & ! intent(inout)
vpwp, vpwp_chnge ) ! intent(inout)
endif ! l_tke_aniso
endif ! .not. l_predict_upwp_vpwp
if ( l_perturbed_wind ) then
!----------------------------------------------------------------
! Prepare tridiagonal system for horizontal winds, um and vm
!----------------------------------------------------------------
! Momentum surface fluxes, u'w'|_sfc and v'w'|_sfc, are applied through
! an implicit method, such that:
! x'w'|_sfc = - ( u_star(t)^2 / wind_speed(t) ) * xm(t+1).
l_imp_sfc_momentum_flux = .true.
! Compute wind speed (use threshold "eps" to prevent divide-by-zero
! error).
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
wind_speed_pert(i,k) = max( sqrt( (um_pert(i,k))**2 + (vm_pert(i,k))**2 ), eps )
end do
end do
!$acc end parallel loop
! Compute u_star_sqd according to the definition of u_star.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
u_star_sqd_pert(i) = sqrt( upwp_pert(i,1)**2 + vpwp_pert(i,1)**2 )
end do
!$acc end parallel loop
! Compute the explicit portion of the um equation.
! Build the right-hand side vector.
call windm_edsclrm_rhs( nz, ngrdcol, gr, windm_edsclrm_um, dt, & ! intent(in)
lhs_diff, um_pert, um_tndcy, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_imp_sfc_momentum_flux, upwp_pert(:,1), & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
rhs(:,:,windm_edsclrm_um) ) ! intent(out)
! Compute the explicit portion of the vm equation.
! Build the right-hand side vector.
call windm_edsclrm_rhs( nz, ngrdcol, gr, windm_edsclrm_vm, dt, & ! intent(in)
lhs_diff, vm_pert, vm_tndcy, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_imp_sfc_momentum_flux, vpwp_pert(:,1), & ! intent(in)
stats_metadata, & ! intent(in)
stats_zt, & ! intent(inout)
rhs(:,:,windm_edsclrm_vm) ) ! intent(out)
! Store momentum flux (explicit component)
! The surface flux, x'w'(1) = x'w'|_sfc, is set elsewhere in the model.
! upwp(1) = upwp_sfc
! vpwp(1) = vpwp_sfc
! Solve for x'w' at all intermediate model levels.
! A Crank-Nicholson timestep is used.
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, um_pert, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
upwp_pert(i,k) = -one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, vm_pert, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
vpwp_pert(i,k) = -one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
! A zero-flux boundary condition at the top of the model, d(xm)/dz = 0,
! means that x'w' at the top model level is 0,
! since x'w' = - K_zm * d(xm)/dz.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
upwp_pert(i,nz) = zero
vpwp_pert(i,nz) = zero
end do
!$acc end parallel loop
! Compute the implicit portion of the um and vm equations.
! Build the left-hand side matrix.
call windm_edsclrm_lhs( nz, ngrdcol, gr, dt, & ! intent(in)
lhs_ma_zt, lhs_diff, & ! intent(in)
wind_speed_pert, u_star_sqd_pert, & ! intent(in)
rho_ds_zm, invrs_rho_ds_zt, & ! intent(in)
l_implemented, l_imp_sfc_momentum_flux, & ! intent(in)
lhs ) ! intent(out)
! Decompose and back substitute for um and vm
nrhs = 2
call windm_edsclrm_solve( nz, ngrdcol, gr, nrhs, stats_metadata%iwindm_matrix_condt_num, & ! intent(in)
tridiag_solve_method, & ! intent(in)
stats_metadata, & ! intent(in)
stats_sfc, & ! intent(in)
lhs, rhs, & ! intent(inout)
solution ) ! intent(out)
! Check for singular matrices and bad LAPACK arguments
if ( clubb_at_least_debug_level( 0 ) ) then
if ( err_code == clubb_fatal_error ) then
write(fstderr,*) "Fatal error solving for um_pert/vm_pert"
return
endif
endif
!----------------------------------------------------------------
! Update zonal (west-to-east) component of mean wind, um
!----------------------------------------------------------------
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
um_pert(i,k) = solution(i,k,windm_edsclrm_um)
end do
end do
!$acc end parallel loop
!----------------------------------------------------------------
! Update meridional (south-to-north) component of mean wind, vm
!----------------------------------------------------------------
!$acc parallel loop gang vector collapse(2) default(present)
do k = 1, nz
do i = 1, ngrdcol
vm_pert(i,k) = solution(i,k,windm_edsclrm_vm)
end do
end do
!$acc end parallel loop
! The values of um(1) and vm(1) are located below the model surface and
! do not affect the rest of the model. The values of um(1) or vm(1) are
! simply set to the values of um(2) and vm(2), respectively, after the
! equation matrices has been solved. Even though um and vm would sharply
! decrease to a value of 0 at the surface, this is done to avoid
! confusion on plots of the vertical profiles of um and vm.
!$acc parallel loop gang vector default(present)
do i = 1, ngrdcol
um_pert(i,1) = um_pert(i,2)
vm_pert(i,1) = vm_pert(i,2)
end do
!$acc end parallel loop
! Second part of momentum (implicit component)
! Solve for x'w' at all intermediate model levels.
! A Crank-Nicholson timestep is used.
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, um_pert, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
upwp_pert(i,k) = upwp_pert(i,k) - one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
call calc_xpwp( nz, ngrdcol, gr, &
Km_zm_p_nu10, vm_pert, &
xpwp )
!$acc parallel loop gang vector collapse(2) default(present)
do k = 2, nz-1
do i = 1, ngrdcol
vpwp_pert(i,k) = vpwp_pert(i,k) - one_half * xpwp(i,k)
end do
end do
!$acc end parallel loop
if ( l_tke_aniso ) then
! Clipping for u'w'
!
! Clipping u'w' at each vertical level, based on the
! correlation of u and w at each vertical level, such that:
! corr_(u,w) = u'w' / [ sqrt(u'^2) * sqrt(w'^2) ];
! -1 <= corr_(u,w) <= 1.
!
! Since u'^2, w'^2, and u'w' are each advanced in different
! subroutines from each other in advance_clubb_core, clipping for u'w'
! has to be done three times during each timestep (once after each
! variable has been updated).
! This is the third instance of u'w' clipping.
l_first_clip_ts = .false.
l_last_clip_ts = .true.
call clip_covar( nz, ngrdcol, gr, clip_upwp, l_first_clip_ts, & ! intent(in)
l_last_clip_ts, dt, wp2, up2, & ! intent(in)
l_predict_upwp_vpwp, & ! intent(in)
stats_metadata, & ! intent(in)
stats_zm, & ! intent(inout)
upwp_pert, upwp_chnge ) ! intent(inout)
! Clipping for v'w'
!
! Clipping v'w' at each vertical level, based on the
! correlation of v and w at each vertical level, such that:
! corr_(v,w) = v'w' / [ sqrt(v'^2) * sqrt(w'^2) ];
! -1 <= corr_(v,w) <= 1.
!
! Since v'^2, w'^2, and v'w' are each advanced in different
! subroutines from each other in advance_clubb_core, clipping for v'w'