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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
|
! Copyright (C) 2006 Imperial College London and others.
!
! Please see the AUTHORS file in the main source directory for a full list
! of copyright holders.
!
! Prof. C Pain
! Applied Modelling and Computation Group
! Department of Earth Science and Engineering
! Imperial College London
!
! amcgsoftware@imperial.ac.uk
!
! This library is free software; you can redistribute it and/or
! modify it under the terms of the GNU Lesser General Public
! License as published by the Free Software Foundation,
! version 2.1 of the License.
!
! This library is distributed in the hope that it will be useful,
! but WITHOUT ANY WARRANTY; without even the implied warranty of
! MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
! Lesser General Public License for more details.
!
! You should have received a copy of the GNU Lesser General Public
! License along with this library; if not, write to the Free Software
! Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
! USA
#include "fdebug.h"
module momentum_cg
use fields
use state_module
use spud
use fldebug
use sparse_tools
use boundary_conditions
use boundary_conditions_from_options
use solvers
use petsc_solve_state_module
use sparse_tools_petsc
use sparse_matrices_fields
use field_options
use halos
use global_parameters, only: FIELD_NAME_LEN, OPTION_PATH_LEN, timestep
use elements
use transform_elements, only: transform_to_physical
use coriolis_module
use vector_tools
use fetools
use upwind_stabilisation
use les_viscosity_module
use smoothing_module
use metric_tools
use field_derivatives
use state_fields_module
use state_matrices_module
use sparsity_patterns_meshes
use fefields
use rotated_boundary_conditions
use Coordinates
use multiphase_module
use edge_length_module
implicit none
private
public :: construct_momentum_cg, correct_masslumped_velocity, &
correct_velocity_cg, assemble_masslumped_poisson_rhs, &
add_kmk_matrix, add_kmk_rhs, assemble_kmk_matrix, &
deallocate_cg_mass, assemble_poisson_rhs,deim
! are we lumping the mass, absorption or source
logical :: lump_mass, lump_absorption, lump_source
! is the pressure correction included in the absorption term?
! if so, lump_absorption gets set equal to lump_mass
logical :: pressure_corrected_absorption
! do we have isotropic viscosity?
logical :: isotropic_viscosity
! do we have diagonal viscosity?
logical :: diagonal_viscosity
! are we using the stress form of the viscosity terms?
logical :: stress_form
logical :: partial_stress_form
! do we want to integrate the continuity matrix by parts?
logical :: integrate_continuity_by_parts
! exclude the advection or mass terms from the equation
logical :: exclude_advection, exclude_mass
! integrate the advection term by parts
logical :: integrate_advection_by_parts
! do we need the inverse lumped mass to assemble a lumped cmc preconditioner
logical :: cmc_lump_mass
! use the sub mesh to lump the mass
logical :: vel_lump_on_submesh, cmc_lump_on_submesh, abs_lump_on_submesh
! integrate the surface tension by parts
logical :: integrate_surfacetension_by_parts
! add viscous terms to inverse_masslump for low Re which is only used for pressure correction
logical :: low_re_p_correction_fix
! which terms do we have?
logical :: have_source
logical :: have_gravity
logical :: have_absorption
logical :: have_vertical_stabilization
logical :: have_implicit_buoyancy
logical :: have_vertical_velocity_relaxation
logical :: have_viscosity
logical :: have_surfacetension
logical :: have_coriolis
logical :: have_geostrophic_pressure
logical :: have_temperature_dependent_viscosity
logical :: have_les
logical :: have_surface_fs_stabilisation
logical :: les_second_order, les_fourth_order, wale, dynamic_les
logical :: on_sphere
logical :: move_mesh
! assemble mass or inverse lumped mass?
logical :: assemble_mass_matrix
logical :: assemble_inverse_masslump
! implicitness parameter, timestep, conservation parameter
real :: theta, dt, beta, gravity_magnitude
! Stabilisation schemes.
integer :: stabilisation_scheme
integer, parameter :: STABILISATION_NONE=0
integer, parameter :: STABILISATION_STREAMLINE_UPWIND=1, &
& STABILISATION_SUPG=2
integer :: nu_bar_scheme
real :: nu_bar_scale = 1.0
! LES coefficients and options
real :: smagorinsky_coefficient
logical :: have_lilly, have_eddy_visc, backscatter
logical :: have_strain, have_filtered_strain, have_filter_width
! Temperature dependent viscosity coefficients:
real :: reference_viscosity
real :: activation_energy
! wetting and drying switch
logical :: have_wd_abs
! scale factor for the absorption
real :: vvr_sf
! scale factor for the free surface stabilisation
real :: fs_sf
! min vertical density gradient for implicit buoyancy
real :: ib_min_grad
! Are we running a multi-phase flow simulation?
logical :: multiphase
logical :: deim
logical :: reduced_model
contains
subroutine construct_momentum_cg(u, p, density, x, &
big_m, rhs, ct_m, ct_rhs, mass, inverse_masslump, visc_inverse_masslump, &
state, assemble_ct_matrix_here, include_pressure_and_continuity_bcs)
!!< Assembles the momentum matrix and rhs for the LinearMomentum,
!!< Boussinesq and Drainage equation types such that
!!< big_m*u = rhs + ct_m*p
!!<
!!< This subroutine is intended to replace assnav and all new code added to it
!!< should be in new format and be compatible with both 2 and 3 dimensions.
!!<
!!< For clarity big_m is assumed to always be a dim x dim block_csr_matrix even
!!< when velocities aren't coupled
! velocity and coordinate
type(vector_field), intent(inout) :: u, x
! pressure and density
type(scalar_field), intent(inout) :: p, density
! the lhs matrix
type(petsc_csr_matrix), intent(inout) :: big_m
! the mass matrix
! NOTE: see the logical assemble_mass below to see when this is actually assembled
type(petsc_csr_matrix), intent(inout) :: mass
! the lumped mass matrix (may vary per component as absorption could be included)
! NOTE: see the logical assemble_inverse_masslump below to see when this is actually assembled
type(vector_field), intent(inout) :: inverse_masslump, visc_inverse_masslump
! NOTE: you have to call deallocate_cg_mass after you're done
! with mass and inverse_masslump
! the pressure gradient matrix (might be null if assemble_ct_matrix_here=.false.)
type(block_csr_matrix), pointer :: ct_m
! the pressure gradient rhs
type(scalar_field), intent(inout) :: ct_rhs
! the rhs
type(vector_field), intent(inout) :: rhs
! bucket full of fields
type(state_type), intent(inout) :: state
! do we need to assemble the pressure gradient/divergence matrix ct_m
! this is not necessarily the same as assemble_ct_m in Momentum_equation.F90
! if we have a cv pressure it is assembled elsewhere
logical, intent(in) :: assemble_ct_matrix_here
! whether include the pressure bc integrals on the rhs of the momentum
! equation (containing the prescribed value of the dirichlet bc)
! and add dirichlet bcs for the continuity equation to ct_rhs
logical, intent(in):: include_pressure_and_continuity_bcs
type(scalar_field), pointer :: buoyancy
type(scalar_field), pointer :: gp
type(vector_field), pointer :: gravity
type(vector_field), pointer :: oldu, nu, ug, source, absorption
type(tensor_field), pointer :: viscosity
type(tensor_field), pointer :: surfacetension
type(vector_field), pointer :: x_old, x_new
! dummy fields in case state doesn't contain the above fields
type(scalar_field), pointer :: dummyscalar
type(vector_field), pointer :: dummyvector
type(tensor_field), pointer :: dummytensor
! single component of lumped mass
type(scalar_field) :: masslump_component
! sparsity for mass matrices
type(csr_sparsity), pointer :: u_sparsity
! bc arrays
type(vector_field) :: velocity_bc
type(scalar_field) :: pressure_bc
integer, dimension(:,:), allocatable :: velocity_bc_type, velocity_bc_number
integer, dimension(:), allocatable :: pressure_bc_type
! fields for the assembly of absorption when
! lumping on the submesh
type(vector_field) :: abslump
type(scalar_field) :: absdensity, abslump_component, abs_component
! for all LES models:
character(len=OPTION_PATH_LEN) :: les_option_path
! For 4th order:
type(tensor_field):: grad_u
! For Germano Dynamic LES:
type(vector_field), pointer :: tnu
type(tensor_field), pointer :: leonard
real :: alpha
! for temperature dependent viscosity :
type(scalar_field), pointer :: temperature
integer :: stat, dim, ele, sele
! Fields for vertical velocity relaxation
type(scalar_field), pointer :: dtt, dtb
type(scalar_field) :: depth
integer :: node
!! Wetting and drying
type(vector_field) :: Abs_wd
type(scalar_field), pointer :: wettingdrying_alpha
type(scalar_field) :: alpha_u_field
real, dimension(u%dim) :: abs_wd_const
! Volume fraction fields for multi-phase flow simulation
type(scalar_field), pointer :: vfrac
type(scalar_field) :: nvfrac ! Non-linear version
ewrite(1,*) 'Entering construct_momentum_cg'
reduced_model= have_option("/reduced_model/execute_reduced_model")
assert(continuity(u)>=0)
nu=>extract_vector_field(state, "NonlinearVelocity")
oldu=>extract_vector_field(state, "OldVelocity")
allocate(dummyscalar)
call allocate(dummyscalar, u%mesh, "DummyScalar", field_type=FIELD_TYPE_CONSTANT)
call zero(dummyscalar)
dummyscalar%option_path=""
allocate(dummyvector)
call allocate(dummyvector, u%dim, u%mesh, "DummyVector", field_type=FIELD_TYPE_CONSTANT)
call zero(dummyvector)
dummyvector%option_path=""
allocate(dummytensor)
call allocate(dummytensor, u%mesh, "DummyTensor", field_type=FIELD_TYPE_CONSTANT)
call zero(dummytensor)
dummytensor%option_path=""
source=>extract_vector_field(state, "VelocitySource", stat)
have_source = stat == 0
if(.not. have_source) source=>dummyvector
ewrite_minmax(source)
absorption=>extract_vector_field(state, "VelocityAbsorption", stat)
have_absorption = stat == 0
if(.not. have_absorption) absorption=>dummyvector
ewrite_minmax(absorption)
have_wd_abs=have_option("/mesh_adaptivity/mesh_movement/free_surface/wetting_and_drying/dry_absorption")
! Absorption term in dry zones for wetting and drying
if (have_wd_abs) then
call allocate(abs_wd, u%dim, u%mesh, "VelocityAbsorption_WettingDrying", FIELD_TYPE_CONSTANT)
call get_option("/mesh_adaptivity/mesh_movement/free_surface/wetting_and_drying/dry_absorption", abs_wd_const)
call set(abs_wd, abs_wd_const)
end if
! Check if we have either implicit absorption term
have_vertical_stabilization=have_option(trim(u%option_path)//"/prognostic/vertical_stabilization/vertical_velocity_relaxation").or. &
have_option(trim(u%option_path)//"/prognostic/vertical_stabilization/implicit_buoyancy")
! If we have vertical velocity relaxation set then grab the required fields
! sigma = n_z*g*dt*_rho_o/depth
have_vertical_velocity_relaxation=have_option(trim(u%option_path)//"/prognostic/vertical_stabilization/vertical_velocity_relaxation")
if (have_vertical_velocity_relaxation) then
call get_option(trim(u%option_path)//"/prognostic/vertical_stabilization/vertical_velocity_relaxation/scale_factor", vvr_sf)
ewrite(2,*) "vertical velocity relaxation scale_factor= ", vvr_sf
dtt => extract_scalar_field(state, "DistanceToTop")
dtb => extract_scalar_field(state, "DistanceToBottom")
call allocate(depth, dtt%mesh, "Depth")
do node=1,node_count(dtt)
call set(depth, node, node_val(dtt, node)+node_val(dtb, node))
end do
endif
! Implicit buoyancy (theta*g*dt*drho/dr)
have_implicit_buoyancy=have_option(trim(u%option_path)//"/prognostic/vertical_stabilization/implicit_buoyancy")
if (have_implicit_buoyancy) then
call get_option(trim(u%option_path)//"/prognostic/vertical_stabilization/implicit_buoyancy/min_gradient", &
ib_min_grad, default=0.0)
end if
call get_option("/physical_parameters/gravity/magnitude", gravity_magnitude, &
stat=stat)
have_gravity = stat == 0
if(have_gravity) then
buoyancy=>extract_scalar_field(state, "VelocityBuoyancyDensity")
gravity=>extract_vector_field(state, "GravityDirection", stat)
else
buoyancy=>dummyscalar
gravity=>dummyvector
gravity_magnitude = 0.0
end if
ewrite_minmax(buoyancy)
viscosity=>extract_tensor_field(state, "Viscosity", stat)
have_viscosity = stat == 0
if(.not. have_viscosity) then
viscosity=>dummytensor
else
ewrite_minmax(viscosity)
end if
surfacetension=>extract_tensor_field(state, "VelocitySurfaceTension", stat)
have_surfacetension = stat == 0
if(.not. have_surfacetension) then
surfacetension=>dummytensor
else
ewrite_minmax(surfacetension)
end if
have_coriolis = have_option("/physical_parameters/coriolis")
have_les = have_option(trim(u%option_path)//"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/les_model")
if (have_les) then
les_option_path=(trim(u%option_path)//"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/les_model")
les_second_order=have_option(trim(les_option_path)//"/second_order")
les_fourth_order=have_option(trim(les_option_path)//"/fourth_order")
wale=have_option(trim(les_option_path)//"/wale")
dynamic_les=have_option(trim(les_option_path)//"/dynamic_les")
if (les_second_order) then
call get_option(trim(les_option_path)//"/second_order/smagorinsky_coefficient", &
smagorinsky_coefficient)
have_eddy_visc = have_option(trim(les_option_path)//"/second_order/tensor_field::EddyViscosity")
if(have_eddy_visc) then
! Initialise the eddy viscosity field. Calling this subroutine works because
! you can't have 2 different types of LES model for the same material phase.
call les_init_diagnostic_tensor_fields(state, have_eddy_visc, .false., .false., .false.)
end if
else
have_eddy_visc=.false.
end if
if (les_fourth_order) then
call get_option(trim(les_option_path)//"/fourth_order/smagorinsky_coefficient", &
smagorinsky_coefficient)
call allocate( grad_u, u%mesh, "VelocityGradient")
call differentiate_field_lumped( nu, x, grad_u)
end if
if (wale) then
call get_option(trim(les_option_path)//"/wale/smagorinsky_coefficient", &
smagorinsky_coefficient)
end if
if(dynamic_les) then
! Are we using the Lilly (1991) modification?
have_lilly = have_option(trim(les_option_path)//"/dynamic_les/enable_lilly")
! Whether or not to allow backscatter (negative eddy viscosity)
backscatter = have_option(trim(les_option_path)//"/dynamic_les/enable_backscatter")
! Initialise optional diagnostic fields
have_eddy_visc = have_option(trim(les_option_path)//"/dynamic_les/tensor_field::EddyViscosity")
have_strain = have_option(trim(les_option_path)//"/dynamic_les/tensor_field::StrainRate")
have_filtered_strain = have_option(trim(les_option_path)//"/dynamic_les/tensor_field::FilteredStrainRate")
have_filter_width = have_option(trim(les_option_path)//"/dynamic_les/tensor_field::FilterWidth")
call les_init_diagnostic_tensor_fields(state, have_eddy_visc, have_strain, have_filtered_strain, have_filter_width)
! Initialise necessary local fields.
ewrite(2,*) "Initialising compulsory dynamic LES fields"
if(have_option(trim(les_option_path)//"/dynamic_les/vector_field::FilteredVelocity")) then
tnu => extract_vector_field(state, "FilteredVelocity")
else
allocate(tnu)
call allocate(tnu, u%dim, u%mesh, "FilteredVelocity")
end if
call zero(tnu)
allocate(leonard)
call allocate(leonard, u%mesh, "LeonardTensor")
call zero(leonard)
! Get (test filter)/(mesh filter) size ratio alpha. Default value is 2.
call get_option(trim(les_option_path)//"/dynamic_les/alpha", alpha, default=2.0)
! Calculate test-filtered velocity field and Leonard tensor field.
ewrite(2,*) "Calculating test-filtered velocity and Leonard tensor"
call leonard_tensor(nu, x, tnu, leonard, alpha, les_option_path)
ewrite_minmax(leonard)
else
have_lilly=.false.; have_eddy_visc=.false.; backscatter=.false.
have_strain=.false.; have_filtered_strain=.false.; have_filter_width=.false.
end if
else
les_second_order=.false.; les_fourth_order=.false.; wale=.false.; dynamic_les=.false.
tnu => dummyvector; leonard => dummytensor
end if
have_temperature_dependent_viscosity = have_option(trim(u%option_path)//"/prognostic"//&
&"/spatial_discretisation/continuous_galerkin/temperature_dependent_viscosity")
if (have_temperature_dependent_viscosity) then
call get_option(trim(u%option_path)//"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/temperature_dependent_viscosity/reference_viscosity", &
&reference_viscosity)
call get_option(trim(u%option_path)//"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/temperature_dependent_viscosity/activation_energy", &
activation_energy)
! Extract temperature field from state:
temperature => extract_scalar_field(state,"Temperature")
else
temperature => dummyscalar
end if
have_geostrophic_pressure = has_scalar_field(state, "GeostrophicPressure")
if(have_geostrophic_pressure) then
gp => extract_scalar_field(state, "GeostrophicPressure")
ewrite_minmax(gp)
else
gp => dummyscalar
end if
on_sphere = have_option('/geometry/spherical_earth/')
call get_option("/timestepping/timestep", dt)
call get_option(trim(u%option_path)//"/prognostic/temporal_discretisation/theta", &
theta)
call get_option(trim(u%option_path)//"/prognostic/spatial_discretisation/&
&conservative_advection", beta)
lump_mass=have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/mass_terms/lump_mass_matrix")
lump_absorption=have_option(trim(u%option_path)//&
&"/prognostic/vector_field::Absorption"//&
&"/lump_absorption")
abs_lump_on_submesh = have_option(trim(u%option_path)//&
&"/prognostic/vector_field::Absorption"//&
&"/lump_absorption/use_submesh")
pressure_corrected_absorption=have_option(trim(u%option_path)//&
&"/prognostic/vector_field::Absorption"//&
&"/include_pressure_correction") .or. (have_vertical_stabilization)
if (pressure_corrected_absorption) then
! as we add the absorption into the mass matrix
! lump_absorption needs to match lump_mass
lump_absorption = lump_mass
end if
lump_source=have_option(trim(u%option_path)//&
&"/prognostic/vector_field::Source"//&
&"/lump_source")
if(have_viscosity) then
isotropic_viscosity = have_viscosity .and. &
& isotropic_field(viscosity)
diagonal_viscosity = have_viscosity .and. &
& diagonal_field(viscosity)
stress_form=have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation/continuous_galerkin"//&
&"/stress_terms/stress_form")
partial_stress_form=have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation/continuous_galerkin"//&
&"/stress_terms/partial_stress_form")
else
isotropic_viscosity = .false.
diagonal_viscosity = .false.
stress_form = .false.
partial_stress_form = .false.
end if
integrate_continuity_by_parts=have_option(trim(p%option_path)//&
&"/prognostic/spatial_discretisation/continuous_galerkin"//&
&"/integrate_continuity_by_parts")
low_re_p_correction_fix=have_option(trim(p%option_path)//&
&"/prognostic/spatial_discretisation/continuous_galerkin"//&
&"/low_re_p_correction_fix")
integrate_advection_by_parts = have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/advection_terms/integrate_advection_by_parts")
exclude_advection = have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/advection_terms/exclude_advection_terms")
exclude_mass = have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/mass_terms/exclude_mass_terms")
vel_lump_on_submesh = have_option(trim(u%option_path)//&
&"/prognostic/spatial_discretisation"//&
&"/continuous_galerkin/mass_terms"//&
&"/lump_mass_matrix/use_submesh")
if (pressure_corrected_absorption) then
! as we add the absorption into the mass matrix
! the meshes need to be the same
abs_lump_on_submesh = vel_lump_on_submesh
end if
cmc_lump_mass = have_option(trim(p%option_path)//&
&"/prognostic/scheme"//&
&"/use_projection_method/full_schur_complement"//&
&"/preconditioner_matrix::LumpedSchurComplement")
cmc_lump_on_submesh = have_option(trim(p%option_path)//&
&"/prognostic/scheme"//&
&"/use_projection_method/full_schur_complement"//&
&"/preconditioner_matrix[0]/lump_on_submesh")
assemble_inverse_masslump = lump_mass .or. cmc_lump_mass
assemble_mass_matrix = have_option(trim(p%option_path)//&
&"/prognostic/scheme/use_projection_method"//&
&"/full_schur_complement/inner_matrix::FullMassMatrix")
if(have_option(trim(u%option_path)//"/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind")) then
stabilisation_scheme = STABILISATION_STREAMLINE_UPWIND
call get_upwind_options(trim(u%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind", &
& nu_bar_scheme, nu_bar_scale)
else if(have_option(trim(u%option_path)//"/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind_petrov_galerkin")) then
stabilisation_scheme = STABILISATION_SUPG
call get_upwind_options(trim(u%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind_petrov_galerkin", &
& nu_bar_scheme, nu_bar_scale)
else
stabilisation_scheme = STABILISATION_NONE
end if
integrate_surfacetension_by_parts = have_option(trim(u%option_path)//&
&"/prognostic/tensor_field::SurfaceTension"//&
&"/diagnostic/integrate_by_parts")
! Are we running a multi-phase simulation?
if(option_count("/material_phase/vector_field::Velocity/prognostic") > 1) then
multiphase = .true.
vfrac => extract_scalar_field(state, "PhaseVolumeFraction")
call allocate(nvfrac, vfrac%mesh, "NonlinearPhaseVolumeFraction")
call zero(nvfrac)
call get_nonlinear_volume_fraction(state, nvfrac)
ewrite_minmax(nvfrac)
else
multiphase = .false.
nullify(vfrac)
end if
if (assemble_inverse_masslump) then
! construct the inverse of the lumped mass matrix
call allocate( inverse_masslump, u%dim, u%mesh, "InverseLumpedMass")
call zero(inverse_masslump)
end if
if (assemble_mass_matrix) then
! construct mass matrix instead
u_sparsity => get_csr_sparsity_firstorder(state, u%mesh, u%mesh)
call allocate( mass, u_sparsity, (/ u%dim, u%dim /), &
diagonal=.true., name="MassMatrix")
call zero( mass )
end if
move_mesh = (have_option("/mesh_adaptivity/mesh_movement").and.(.not.exclude_mass))
if(move_mesh) then
ewrite(2,*) 'Moving mesh'
x_old => extract_vector_field(state, "OldCoordinate")
x_new => extract_vector_field(state, "IteratedCoordinate")
ug=>extract_vector_field(state, "GridVelocity")
else
ewrite(2,*) 'Not moving mesh'
end if
if (on_sphere.and.pressure_corrected_absorption) then
ewrite(-1,*) 'WARNING:: Absorption in spherical geometry cannot currently'
ewrite(-1,*) ' be included in the pressure correction. This option'
ewrite(-1,*) ' will be ignored.'
end if
if (have_wd_abs .and. on_sphere) then
FLExit("The wetting and drying absorption term does currently not work on the sphere.")
end if
if (have_wd_abs .and. .not. has_scalar_field(state, "WettingDryingAlpha")) then
FLExit("The wetting and drying absorption needs the diagnostic field WettingDryingAlpha activated.")
end if
if (have_wd_abs) then
! The alpha fields lives on the pressure mesh, but we need it on the velocity, so let's remap it.
wettingdrying_alpha => extract_scalar_field(state, "WettingDryingAlpha")
call allocate(alpha_u_field, u%mesh, "alpha_u")
call remap_field(wettingdrying_alpha, alpha_u_field)
end if
! For Low Reynolds number fix
if (low_re_p_correction_fix) then
! construct the inverse of the lumped mass matrix
call allocate( visc_inverse_masslump, u%dim, u%mesh, "ViscousInverseLumpedMass")
call zero(visc_inverse_masslump)
end if
! ----- Volume integrals over elements -------------
element_loop: do ele=1, element_count(u)
call construct_momentum_element_cg(state, ele, big_m, rhs, ct_m, mass, inverse_masslump, visc_inverse_masslump, &
x, x_old, x_new, u, oldu, nu, ug, &
density, p, &
source, absorption, buoyancy, gravity, &
viscosity, grad_u, &
tnu, leonard, alpha, &
gp, surfacetension, &
assemble_ct_matrix_here, on_sphere, depth, &
alpha_u_field, abs_wd, temperature, nvfrac)
end do element_loop
if (have_wd_abs) then
! the remapped field is not needed anymore.
call deallocate(alpha_u_field)
call deallocate(Abs_wd)
end if
! ----- Surface integrals over boundaries -----------
if((integrate_advection_by_parts.and.(.not.exclude_advection)).or.&
(integrate_continuity_by_parts)) then
allocate(velocity_bc_type(u%dim, surface_element_count(u)))
allocate(velocity_bc_number(u%dim, surface_element_count(u)))
call get_entire_boundary_condition(u, &
& (/ &
"weakdirichlet ", &
"no_normal_flow ", &
"internal ", &
"free_surface " &
& /), velocity_bc, velocity_bc_type, velocity_bc_number)
allocate(pressure_bc_type(surface_element_count(p)))
call get_entire_boundary_condition(p, &
& (/ &
"weakdirichlet", &
"dirichlet " /), &
pressure_bc, pressure_bc_type)
! Check if we want free surface stabilisation (in development!)
have_surface_fs_stabilisation=have_fs_stab(u)
if (have_surface_fs_stabilisation) then
fs_sf=get_surface_stab_scale_factor(u)
end if
surface_element_loop: do sele=1, surface_element_count(u)
! if no_normal flow and no other condition in the tangential directions, or if periodic
! but not if there's a pressure bc
if(((velocity_bc_type(1,sele)==2 .and. sum(velocity_bc_type(:,sele))==2) &
.or. any(velocity_bc_type(:,sele)==3)) &
.and. pressure_bc_type(sele)==0) cycle
ele = face_ele(x, sele)
call construct_momentum_surface_element_cg(sele, big_m, rhs, ct_m, ct_rhs, &
inverse_masslump, x, u, nu, ug, density, p, gravity, &
velocity_bc, velocity_bc_type, &
pressure_bc, pressure_bc_type, &
assemble_ct_matrix_here, include_pressure_and_continuity_bcs, oldu, nvfrac)
end do surface_element_loop
call deallocate(velocity_bc)
deallocate(velocity_bc_type)
call deallocate(pressure_bc)
deallocate(pressure_bc_type)
end if
if(abs_lump_on_submesh) then
call allocate(abslump, inverse_masslump%dim, inverse_masslump%mesh, "LumpedAbsorption")
call allocate(absdensity, absorption%mesh, "AbsorptionComponentTimesDensity")
do dim = 1, inverse_masslump%dim
call remap_field(density, absdensity)
abs_component = extract_scalar_field(absorption, dim)
call scale(absdensity, abs_component)
abslump_component = extract_scalar_field(abslump, dim)
call compute_lumped_mass_on_submesh(state, abslump_component, density=absdensity)
end do
call deallocate(absdensity)
if(assemble_inverse_masslump.and.pressure_corrected_absorption) then
call addto(inverse_masslump, abslump, theta)
end if
call addto_diag(big_m, abslump, dt*theta)
call scale(abslump, oldu)
call addto(rhs, abslump, -1.0)
call deallocate(abslump)
end if
if (assemble_inverse_masslump) then
if(vel_lump_on_submesh .or. cmc_lump_on_submesh) then
if(move_mesh) then
FLExit("Can't move the mesh and lump on the submesh yet.")
end if
! we still have to make the lumped mass if this is true
masslump_component=extract_scalar_field(inverse_masslump, 1)
if(multiphase) then
call compute_lumped_mass_on_submesh(state, masslump_component, density=density, vfrac=nvfrac)
else
call compute_lumped_mass_on_submesh(state, masslump_component, density=density)
end if
! copy over to other components
do dim = 2, inverse_masslump%dim
call set(inverse_masslump, dim, masslump_component)
end do
if(vel_lump_on_submesh) then
call addto_diag(big_m, masslump_component)
end if
end if
if (low_re_p_correction_fix .and. timestep/=1) then
ewrite(2,*) "****************************************"
ewrite(2,*) "Using low_re_p_correction_fix"
ewrite(2,*) "In Momentum_CG, construct_momentum_cg"
! Add viscous terms (stored in visc_inverse_masslump)
! to inverse_masslump (and store it in visc_inverse_masslump):
ewrite(2,*) "The viscous_terms are:"
ewrite_minmax(visc_inverse_masslump)
! Add the viscous terms to the lumped mass matrix
call addto(visc_inverse_masslump, inverse_masslump)
ewrite(2,*) "For comparison only:"
ewrite(2,*) "The orig inverse_masslump is:"
ewrite_minmax(inverse_masslump)
ewrite(2,*) "The new visc_inverse_masslump is:"
ewrite_minmax(visc_inverse_masslump)
! invert the visc_inverse_masslump:
call invert(visc_inverse_masslump)
! apply boundary conditions (zeroing out strong dirichl. rows)
call apply_dirichlet_conditions_inverse_mass(visc_inverse_masslump, u)
ewrite(2,*) "Inverted new visc_inverse_masslump and boundary conditions is:"
ewrite_minmax(visc_inverse_masslump)
! Now invert the original inverse_masslump, apply dirichlet conditions:
! if(.not.reduced_model) then
call invert(inverse_masslump)
call apply_dirichlet_conditions_inverse_mass(inverse_masslump, u)
ewrite_minmax(inverse_masslump)
ewrite(2,*) "****************************************"
! endif
else
! thus far we have just assembled the lumped mass in inverse_masslump
! now invert it:
! if(.not.reduced_model) then
call invert(inverse_masslump)
! apply boundary conditions (zeroing out strong dirichl. rows)
call apply_dirichlet_conditions_inverse_mass(inverse_masslump, u)
ewrite_minmax(inverse_masslump)
! endif
endif
end if
if (assemble_mass_matrix) then
call apply_dirichlet_conditions(matrix=mass, field=u)
end if
ewrite_minmax(rhs)
if (les_fourth_order) then
call deallocate(grad_u)
end if
if (dynamic_les) then
if(.not. have_option(trim(les_option_path)//"/dynamic_les/vector_field::FilteredVelocity")) then
call deallocate(tnu); deallocate(tnu)
end if
call deallocate(leonard); deallocate(leonard)
end if
call deallocate(dummytensor)
deallocate(dummytensor)
call deallocate(dummyvector)
deallocate(dummyvector)
call deallocate(dummyscalar)
deallocate(dummyscalar)
if(multiphase) then
call deallocate(nvfrac)
end if
contains
logical function have_fs_stab(u)
type(vector_field), intent(in) :: u
character(len=OPTION_PATH_LEN) :: type
character(len=OPTION_PATH_LEN) :: option_path
integer :: n
have_fs_stab=.false.
do n=1,get_boundary_condition_count(u)
call get_boundary_condition(u, n, type=type, option_path=option_path)
if (have_option(trim(option_path)//"/type::free_surface/surface_stabilisation")) then
have_fs_stab=.true.
return
end if
end do
end function have_fs_stab
function get_surface_stab_scale_factor(u) result(scale_factor)
type(vector_field), intent(in) :: u
character(len=OPTION_PATH_LEN) :: type
character(len=OPTION_PATH_LEN) :: option_path
integer :: n
real :: scale_factor
do n=1,get_boundary_condition_count(u)
call get_boundary_condition(u, n, type=type, option_path=option_path)
if (have_option(trim(option_path)//"/type::free_surface/surface_stabilisation")) then
call get_option(trim(option_path)//"/type::free_surface/surface_stabilisation/scale_factor", scale_factor)
end if
end do
end function get_surface_stab_scale_factor
end subroutine construct_momentum_cg
subroutine construct_momentum_surface_element_cg(sele, big_m, rhs, ct_m, ct_rhs, &
masslump, x, u, nu, ug, density, p, gravity, &
velocity_bc, velocity_bc_type, &
pressure_bc, pressure_bc_type, &
assemble_ct_matrix_here, include_pressure_and_continuity_bcs,&
oldu, nvfrac)
integer, intent(in) :: sele
type(petsc_csr_matrix), intent(inout) :: big_m
type(vector_field), intent(inout) :: rhs
type(block_csr_matrix), pointer :: ct_m
type(scalar_field), intent(inout) :: ct_rhs
type(vector_field), intent(inout) :: masslump
type(vector_field), intent(in) :: x, oldu
type(vector_field), intent(in) :: u, nu
type(vector_field), pointer :: ug
type(scalar_field), intent(in) :: density, p
type(vector_field), pointer, intent(in) :: gravity
type(vector_field), intent(in) :: velocity_bc
integer, dimension(:,:), intent(in) :: velocity_bc_type
type(scalar_field), intent(in) :: pressure_bc
integer, dimension(:), intent(in) :: pressure_bc_type
logical, intent(in) :: assemble_ct_matrix_here, include_pressure_and_continuity_bcs
! Volume fraction field
type(scalar_field), intent(in) :: nvfrac
! local
integer :: dim, dim2, i
integer, dimension(face_loc(u, sele)) :: u_nodes_bdy
integer, dimension(face_loc(p, sele)) :: p_nodes_bdy
type(element_type), pointer :: u_shape, p_shape
real, dimension(face_ngi(u, sele)) :: detwei_bdy
real, dimension(u%dim, face_ngi(u, sele)) :: normal_bdy, upwards_gi
real, dimension(u%dim, face_loc(p, sele), face_loc(u, sele)) :: ct_mat_bdy
real, dimension(u%dim, face_loc(u, sele), face_loc(u, sele)) :: fs_surfacestab
real, dimension(u%dim, u%dim, face_loc(u, sele), face_loc(u, sele)) :: fs_surfacestab_sphere
real, dimension(u%dim, u%dim, face_ngi(u, sele)) :: fs_stab_gi_sphere
real, dimension(u%dim, face_loc(u, sele)) :: lumped_fs_surfacestab
real, dimension(face_loc(u, sele), face_loc(u, sele)) :: adv_mat_bdy
real, dimension(u%dim, face_ngi(u, sele)) :: relu_gi
real, dimension(face_ngi(u, sele)) :: density_gi
real, dimension(u%dim, face_loc(u, sele)) :: oldu_val
real, dimension(u%dim, face_ngi(u, sele)) :: ndotk_k
u_shape=> face_shape(u, sele)
p_shape=> face_shape(p, sele)
u_nodes_bdy = face_global_nodes(u, sele)
p_nodes_bdy = face_global_nodes(p, sele)
oldu_val = face_val(oldu, sele)
call transform_facet_to_physical(X, sele, &
detwei_f=detwei_bdy, normal=normal_bdy)
! Note that with SUPG the surface element test function is not modified
! first the advection (dirichlet) bcs:
! if no no_normal_flow or free_surface
if (velocity_bc_type(1,sele)/=2) then
if(integrate_advection_by_parts.and.(.not.exclude_advection)) then
relu_gi = face_val_at_quad(nu, sele)
if(move_mesh) then
relu_gi = relu_gi - face_val_at_quad(ug, sele)
end if
if(multiphase) then
adv_mat_bdy = shape_shape(u_shape, u_shape, &
detwei_bdy*sum(relu_gi*normal_bdy,1)*&
face_val_at_quad(density, sele)*face_val_at_quad(nvfrac, sele))
else
adv_mat_bdy = shape_shape(u_shape, u_shape, &
detwei_bdy*sum(relu_gi*normal_bdy,1)*&
face_val_at_quad(density, sele))
end if
do dim = 1, u%dim
if(velocity_bc_type(dim, sele)==1 .and. .not. reduced_model) then
call addto(rhs, dim, u_nodes_bdy, -matmul(adv_mat_bdy, &
ele_val(velocity_bc, dim, sele)))
else
call addto(big_m, dim, dim, u_nodes_bdy, u_nodes_bdy, &
dt*theta*adv_mat_bdy)
call addto(rhs, dim, u_nodes_bdy, -matmul(adv_mat_bdy, face_val(oldu, dim, sele)))
end if
end do
end if
end if
! now do surface integrals for divergence/pressure gradient matrix
if(integrate_continuity_by_parts.and. (assemble_ct_matrix_here .or. include_pressure_and_continuity_bcs)) then
if (velocity_bc_type(1,sele)/=2 .and. velocity_bc_type(1,sele)/=4) then
if(multiphase) then
ct_mat_bdy = shape_shape_vector(p_shape, u_shape, detwei_bdy*face_val_at_quad(nvfrac, sele), normal_bdy)
else
ct_mat_bdy = shape_shape_vector(p_shape, u_shape, detwei_bdy, normal_bdy)
end if
do dim = 1, u%dim
if(include_pressure_and_continuity_bcs .and. velocity_bc_type(dim, sele)==1 )then
call addto(ct_rhs, p_nodes_bdy, &
-matmul(ct_mat_bdy(dim,:,:), ele_val(velocity_bc, dim, sele)))
else if (assemble_ct_matrix_here) then
call addto(ct_m, 1, dim, p_nodes_bdy, u_nodes_bdy, ct_mat_bdy(dim,:,:))
end if
if(pressure_bc_type(sele)>0) then
! for both weak and strong pressure dirichlet bcs:
! /
! add -| N_i M_j \vec n p_j, where p_j are the prescribed bc values
! /
call addto(rhs, dim, u_nodes_bdy, -matmul( ele_val(pressure_bc, sele), &
ct_mat_bdy(dim,:,:) ))
end if
end do
end if
end if
! Add free surface stabilisation.
if (velocity_bc_type(1,sele)==4 .and. have_surface_fs_stabilisation) then
if (on_sphere) then
upwards_gi=-sphere_inward_normal_at_quad_face(x, sele)
else
upwards_gi=-face_val_at_quad(gravity, sele)
end if
if (on_sphere) then
ndotk_k=0.0
do i=1,face_ngi(u,sele)
ndotk_k(3,i)=fs_sf*dot_product(normal_bdy(:,i),upwards_gi(:,i))
end do
else
do i=1,face_ngi(u,sele)
ndotk_k(:,i)=fs_sf*dot_product(normal_bdy(:,i),upwards_gi(:,i))*upwards_gi(:,i)
end do
end if
! Rotate if on the sphere
if (on_sphere) then
fs_stab_gi_sphere=dt*gravity_magnitude*rotate_diagonal_to_sphere_face(x, sele, ndotk_k)
endif
density_gi=face_val_at_quad(density, sele)
if (on_sphere) then
fs_surfacestab_sphere = shape_shape_tensor(u_shape, u_shape, &
detwei_bdy*density_gi, fs_stab_gi_sphere)
else
fs_surfacestab = shape_shape_vector(u_shape, u_shape, &
detwei_bdy*density_gi, dt*gravity_magnitude*ndotk_k)
end if
if (on_sphere) then
do dim = 1, u%dim
do dim2 = 1, u%dim
call addto(big_m, dim, dim2, u_nodes_bdy, u_nodes_bdy, dt*theta*fs_surfacestab_sphere(dim,dim2,:,:))
end do
call addto(rhs, dim, u_nodes_bdy, -matmul(fs_surfacestab_sphere(dim,dim,:,:), oldu_val(dim,:)))
! off block diagonal absorption terms
do dim2 = 1, u%dim
if (dim==dim2) cycle ! The dim=dim2 terms were done above
call addto(rhs, dim, u_nodes_bdy, -matmul(fs_surfacestab_sphere(dim,dim2,:,:), oldu_val(dim2,:)))
end do
end do
else
if (lump_mass) then
lumped_fs_surfacestab = sum(fs_surfacestab, 3)
do dim = 1, u%dim
call addto_diag(big_m, dim, dim, u_nodes_bdy, dt*theta*lumped_fs_surfacestab(dim,:))
call addto(rhs, dim, u_nodes_bdy, -lumped_fs_surfacestab(dim,:)*oldu_val(dim,:))
end do
else if (.not.pressure_corrected_absorption) then
do dim = 1, u%dim
call addto(big_m, dim, dim, u_nodes_bdy, u_nodes_bdy, dt*theta*fs_surfacestab(dim,:,:))
call addto(rhs, dim, u_nodes_bdy, -matmul(fs_surfacestab(dim,:,:), oldu_val(dim,:)))
end do
else
ewrite(-1,*) "Free surface stabilisation requires that mass is lumped or that"
FLExit("absorption is not included in the pressure correction")
end if
if (pressure_corrected_absorption) then
if (assemble_inverse_masslump.and.(.not.(abs_lump_on_submesh))) then
call addto(masslump, u_nodes_bdy, dt*theta*lumped_fs_surfacestab)
else
FLExit("Error?")
end if
end if
end if
end if
end subroutine construct_momentum_surface_element_cg
subroutine construct_momentum_element_cg(state, ele, big_m, rhs, ct_m, &
mass, masslump, visc_masslump, &
x, x_old, x_new, u, oldu, nu, ug, &
density, p, &
source, absorption, buoyancy, gravity, &
viscosity, grad_u, &
tnu, leonard, alpha, &
gp, surfacetension, &
assemble_ct_matrix_here, on_sphere, depth, &
alpha_u_field, abs_wd, temperature, nvfrac)
!!< Assembles the local element matrix contributions and places them in big_m
!!< and rhs for the continuous galerkin momentum equations
! Needed for dynamic LES unfortunately
type(state_type), intent(inout) :: state
! current element
integer, intent(in) :: ele
type(petsc_csr_matrix), intent(inout) :: big_m
type(vector_field), intent(inout) :: rhs
type(block_csr_matrix), pointer :: ct_m
type(petsc_csr_matrix), intent(inout) :: mass
! above we supply inverse_masslump, but we start assembling the non-inverted
! lumped mass matrix in it:
type(vector_field), intent(inout) :: masslump
! low Re fix for pressure correction:
type(vector_field), intent(inout) :: visc_masslump
type(vector_field), intent(in) :: x, u, oldu, nu
type(vector_field), pointer :: x_old, x_new, ug
type(scalar_field), intent(in) :: density, p, buoyancy
type(vector_field), intent(in) :: source, absorption, gravity
type(tensor_field), intent(in) :: viscosity, grad_u
! Fields for Germano Dynamic LES Model
type(vector_field), intent(in) :: tnu
type(tensor_field), intent(in) :: leonard
real, intent(in) :: alpha
type(scalar_field), intent(in) :: gp
type(tensor_field), intent(in) :: surfacetension
logical, intent(in) :: assemble_ct_matrix_here, on_sphere
! Wetting and Drying
type(scalar_field), intent(in) :: depth
type(scalar_field), intent(in) :: alpha_u_field
type(vector_field), intent(in) :: abs_wd
! Temperature dependent viscosity:
type(scalar_field), intent(in) :: temperature
! Non-linear approximation of the volume fraction
type(scalar_field), intent(in) :: nvfrac
! Pointer to the nvfrac field's shape function
type(element_type), pointer :: nvfrac_shape
! Derivative of shape function for nvfrac field
real, dimension(:, :, :), allocatable :: dnvfrac_t
integer, dimension(:), pointer :: u_ele, p_ele
real, dimension(u%dim, ele_loc(u, ele)) :: oldu_val
type(element_type), pointer :: u_shape, p_shape
real, dimension(ele_ngi(u, ele)) :: detwei, detwei_old, detwei_new
real, dimension(u%dim, u%dim, ele_ngi(u,ele)) :: J_mat
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim) :: du_t
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim) :: dug_t
real, dimension(ele_loc(p, ele), ele_ngi(p, ele), u%dim) :: dp_t
real, dimension(u%dim, ele_ngi(u, ele)) :: relu_gi
real, dimension(u%dim, ele_loc(p, ele), ele_loc(u, ele)) :: grad_p_u_mat
! What we will be adding to the matrix and RHS - assemble these as we
! go, so that we only do the calculations we really need
real, dimension(u%dim, ele_loc(u, ele)) :: big_m_diag_addto, rhs_addto
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)) :: big_m_tensor_addto
logical, dimension(u%dim, u%dim) :: block_mask ! control whether the off diagonal entries are used
integer :: dim
type(element_type) :: test_function
if(move_mesh) then
! we've assumed the following in the declarations
! above so we better make sure they're true!
assert(ele_loc(ug, ele)==ele_loc(u,ele))
assert(ele_ngi(ug, ele)==ele_ngi(u,ele))
assert(ug%dim==u%dim)
end if
big_m_diag_addto = 0.0
big_m_tensor_addto = 0.0
rhs_addto = 0.0
! we always want things added to the diagonal blocks
! but we must check if we have_coriolis to add things to the others
if(have_coriolis.or.(have_viscosity.and.(stress_form.or.partial_stress_form))) then
block_mask = .true.
else
block_mask = .false.
do dim = 1, u%dim
block_mask(dim, dim) = .true.
end do
end if
u_ele=>ele_nodes(u, ele)
u_shape=>ele_shape(u, ele)
p_ele=>ele_nodes(p, ele)
p_shape=>ele_shape(p, ele)
oldu_val = ele_val(oldu, ele)
! Step 1: Transform
! transform the velocity derivatives into physical space
! (and get detwei)
if(stabilisation_scheme==STABILISATION_NONE) then
call transform_to_physical(X, ele, &
u_shape, dshape=du_t, detwei=detwei)
! J_mat = 0.0
else
call transform_to_physical(x, ele, &
u_shape, dshape=du_t, detwei=detwei, J=J_mat)
end if
if(assemble_ct_matrix_here .and.integrate_continuity_by_parts) then
! transform the pressure derivatives into physical space
call transform_to_physical(x, ele, &
p_shape, dshape=dp_t)
end if
if(move_mesh) then
call transform_to_physical(x_old, ele, detwei=detwei_old)
call transform_to_physical(x_new, ele, detwei=detwei_new)
if(.not.exclude_advection.and..not.integrate_advection_by_parts) then
call transform_to_physical(x, ele, &
ele_shape(ug, ele), dshape=dug_t)
end if
end if
if(multiphase) then
! If the PhaseVolumeFraction is on a different mesh to the Velocity,
! then allocate memory to hold the derivative of the nvfrac shape function
allocate(dnvfrac_t(ele_loc(nvfrac, ele), ele_ngi(nvfrac, ele), u%dim))
end if
! Step 2: Set up test function
select case(stabilisation_scheme)
case(STABILISATION_SUPG)
relu_gi = ele_val_at_quad(nu, ele)
if(move_mesh) then
relu_gi = relu_gi - ele_val_at_quad(ug, ele)
end if
if(have_viscosity) then
test_function = make_supg_shape(u_shape, du_t, relu_gi, j_mat, diff_q = ele_val_at_quad(viscosity, ele), &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
else
test_function = make_supg_shape(u_shape, du_t, relu_gi, j_mat, &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
end if
case default
test_function = u_shape
call incref(test_function)
end select
! Important note: the test function derivatives have not been modified -
! i.e. du_t is currently used everywhere. This is fine for P1, but is not
! consistent for P>1.
if(assemble_ct_matrix_here) then
if(integrate_continuity_by_parts) then
if(multiphase) then
grad_p_u_mat = -dshape_shape(dp_t, u_shape, detwei*ele_val_at_quad(nvfrac, ele))
else
grad_p_u_mat = -dshape_shape(dp_t, u_shape, detwei)
end if
else
if(multiphase) then
! Split up the divergence term div(vfrac*u) = vfrac*div(u) + u*grad(vfrac)
! If the field and nvfrac meshes are different, then we need to
! compute the derivatives of the nvfrac shape functions.
if(.not.(nvfrac%mesh == u%mesh)) then
nvfrac_shape => ele_shape(nvfrac%mesh, ele)
call transform_to_physical(x, ele, nvfrac_shape, dshape=dnvfrac_t)
else
dnvfrac_t = du_t
end if
grad_p_u_mat = shape_dshape(p_shape, du_t, detwei*ele_val_at_quad(nvfrac, ele)) + &
shape_shape_vector(p_shape, u_shape, detwei, ele_grad_at_quad(nvfrac, ele, dnvfrac_t))
else
grad_p_u_mat = shape_dshape(p_shape, du_t, detwei)
end if
end if
end if
! Step 3: Assemble contributions
! Mass terms
if(assemble_inverse_masslump .or. assemble_mass_matrix .or. &
(.not. exclude_mass)) then
call add_mass_element_cg(ele, test_function, u, oldu_val, density, nvfrac, detwei, detwei_old, detwei_new, big_m_diag_addto, big_m_tensor_addto, rhs_addto, mass, masslump)
end if
! Advection terms
if(.not. exclude_advection) then
call add_advection_element_cg(ele, test_function, u, oldu_val, nu, ug, density, viscosity, nvfrac, du_t, dug_t, dnvfrac_t, detwei, J_mat, big_m_tensor_addto, rhs_addto)
end if
! Source terms
if(have_source) then
call add_sources_element_cg(ele, test_function, u, density, source, detwei, rhs_addto)
end if
! Buoyancy terms
if(have_gravity) then
call add_buoyancy_element_cg(x, ele, test_function, u, buoyancy, gravity, nvfrac, on_sphere, detwei, rhs_addto)
end if
! Surface tension
if(have_surfacetension) then
call add_surfacetension_element_cg(ele, test_function, u, surfacetension, du_t, detwei, rhs_addto)
end if
! Absorption terms (sponges) and WettingDrying absorption
if (have_absorption .or. have_vertical_stabilization .or. have_wd_abs) then
call add_absorption_element_cg(x, ele, test_function, u, oldu_val, density, &
absorption, detwei, big_m_diag_addto, big_m_tensor_addto, rhs_addto, &
masslump, mass, depth, gravity, buoyancy, &
alpha_u_field, abs_wd)
end if
! Viscous terms
if(have_viscosity .or. have_les) then
call add_viscosity_element_cg(state, ele, test_function, u, oldu_val, nu, x, viscosity, grad_u, &
tnu, leonard, alpha, &
du_t, detwei, big_m_tensor_addto, rhs_addto, temperature, nvfrac)
end if
! Get only the viscous terms
if(low_re_p_correction_fix .and. assemble_inverse_masslump .and. (have_viscosity .or. have_les) .and. timestep/=1) then
call get_viscous_terms_element_cg(ele, u, nu, x, viscosity, &
du_t, detwei, visc_masslump)
end if
! Coriolis terms
if(have_coriolis) then
call add_coriolis_element_cg(ele, test_function, x, u, oldu_val, density, detwei, big_m_tensor_addto, rhs_addto)
end if
! Geostrophic pressure
if(have_geostrophic_pressure) then
call add_geostrophic_pressure_element_cg(ele, test_function, x, u, gp, detwei, rhs_addto)
end if
! Step 4: Insertion
! add lumped terms to the diagonal of the matrix
call add_diagonal_to_tensor(big_m_diag_addto, big_m_tensor_addto)
! add to the matrix
call addto(big_m, u_ele, u_ele, big_m_tensor_addto, block_mask=block_mask)
! add to the rhs
call addto(rhs, u_ele, rhs_addto)
if(assemble_ct_matrix_here) then
call addto(ct_m, p_ele, u_ele, spread(grad_p_u_mat, 1, 1))
end if
call deallocate(test_function)
if(multiphase) then
deallocate(dnvfrac_t)
end if
contains
subroutine add_diagonal_to_tensor(big_m_diag_addto, big_m_tensor_addto)
real, dimension(u%dim, ele_loc(u, ele)), intent(in) :: big_m_diag_addto
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
integer :: dim, loc
forall(dim = 1:size(big_m_diag_addto, 1), loc = 1:size(big_m_diag_addto, 2))
big_m_tensor_addto(dim, dim, loc, loc) = big_m_tensor_addto(dim, dim, loc, loc) + big_m_diag_addto(dim, loc)
end forall
end subroutine add_diagonal_to_tensor
end subroutine construct_momentum_element_cg
subroutine add_mass_element_cg(ele, test_function, u, oldu_val, density, nvfrac, detwei, detwei_old, detwei_new, big_m_diag_addto, big_m_tensor_addto, rhs_addto, mass, masslump)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
real, dimension(:,:), intent(in) :: oldu_val
type(scalar_field), intent(in) :: density
type(scalar_field), intent(in) :: nvfrac
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei, detwei_old, detwei_new
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: big_m_diag_addto
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
type(petsc_csr_matrix), intent(inout) :: mass
type(vector_field), intent(inout) :: masslump
integer :: dim
integer, dimension(:), pointer :: u_ele
logical:: compute_lumped_mass_here
real, dimension(ele_loc(u, ele)) :: mass_lump
real, dimension(ele_ngi(u, ele)) :: density_gi
real, dimension(ele_ngi(u, ele)) :: nvfrac_gi
real, dimension(ele_loc(u, ele), ele_loc(u, ele)) :: mass_mat
type(element_type), pointer :: u_shape
! In case we have to multiply detwei by various coefficients (e.g. the density values at the Gauss points),
! then place the result in here
real, dimension(ele_ngi(u, ele)) :: coefficient_detwei
u_shape => ele_shape(u, ele)
u_ele=>ele_nodes(u, ele)
density_gi=ele_val_at_quad(density, ele)
if(multiphase) then
nvfrac_gi = ele_val_at_quad(nvfrac, ele)
end if
! element mass matrix
! /
! | N_A N_B rho dV
! /
if(move_mesh) then
mass_mat = shape_shape(test_function, u_shape, density_gi*detwei_new)
else
coefficient_detwei = density_gi*detwei
if(multiphase) then
coefficient_detwei = coefficient_detwei*nvfrac_gi
end if
mass_mat = shape_shape(test_function, u_shape, coefficient_detwei)
end if
mass_lump = sum(mass_mat, 2)
! if we're lumping on the submesh, this is done later:
compute_lumped_mass_here=.not. (vel_lump_on_submesh .or. cmc_lump_on_submesh)
if(.not.exclude_mass) then
if(lump_mass) then
if (compute_lumped_mass_here) then
do dim = 1, u%dim
! if(.not.reduced_model) then
big_m_diag_addto(dim, :) = big_m_diag_addto(dim, :) + mass_lump
! endif
end do
end if
else
do dim = 1, u%dim
! if(.not.reduced_model) then
big_m_tensor_addto(dim, dim, :, :) = big_m_tensor_addto(dim, dim, :, :) + mass_mat
! endif
end do
end if
end if
if(assemble_inverse_masslump .and. compute_lumped_mass_here) then
! store the lumped mass as field, the same for each component
do dim = 1, u%dim
call addto(masslump, dim, u_ele, mass_lump)
end do
end if
if(assemble_mass_matrix) then
do dim=1, u%dim
call addto(mass, dim, dim, u_ele, u_ele, mass_mat)
end do
end if
if(move_mesh) then
! In the unaccelerated form we solve:
! /
! | N^{n+1} u^{n+1}/dt - N^{n} u^n/dt + ... = f
! /
! so in accelerated form:
! /
! | N^{n+1} du + (N^{n+1}- N^{n}) u^n/dt + ... = f
! /
! where du=(u^{n+1}-u^{n})/dt is the acceleration.
! Put the (N^{n+1}-N^{n}) u^n term on the rhs
mass_mat = shape_shape(test_function, u_shape, (detwei_new-detwei_old)*density_gi)
if(lump_mass) then
if(compute_lumped_mass_here) then
mass_lump = sum(mass_mat, 2)
do dim = 1, u%dim
rhs_addto(dim,:) = rhs_addto(dim,:) - mass_lump*oldu_val(dim,:)/dt
end do
end if
else
do dim = 1, u%dim
rhs_addto(dim,:) = rhs_addto(dim,:) - matmul(mass_mat, oldu_val(dim,:))/dt
end do
end if
end if
end subroutine add_mass_element_cg
subroutine add_advection_element_cg(ele, test_function, u, oldu_val, nu, ug, density, viscosity, nvfrac, du_t, dug_t, dnvfrac_t, detwei, J_mat, big_m_tensor_addto, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
real, dimension(:,:), intent(in) :: oldu_val
type(vector_field), intent(in) :: nu
type(vector_field), pointer :: ug
type(scalar_field), intent(in) :: density
type(tensor_field), intent(in) :: viscosity
type(scalar_field), intent(in) :: nvfrac
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim), intent(in) :: du_t
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim), intent(in) :: dug_t
real, dimension(:, :, :), intent(in) :: dnvfrac_t
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, u%dim, ele_ngi(u,ele)) :: J_mat
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
integer :: dim, i
real, dimension(ele_ngi(u, ele)) :: density_gi, div_relu_gi
real, dimension(ele_ngi(u, ele)) :: nvfrac_gi, relu_dot_grad_nvfrac_gi
real, dimension(u%dim, ele_ngi(u, ele)) :: grad_nvfrac_gi
real, dimension(ele_loc(u, ele), ele_loc(u, ele)) :: advection_mat
real, dimension(u%dim, ele_ngi(u, ele)) :: relu_gi
type(element_type), pointer :: u_shape
! In case we have to multiply detwei by various coefficients (e.g. the density values at the Gauss points),
! then place the result in here
real, dimension(ele_ngi(u, ele)) :: coefficient_detwei
u_shape=>ele_shape(u, ele)
density_gi=ele_val_at_quad(density, ele)
relu_gi = ele_val_at_quad(nu, ele)
if(move_mesh) then
relu_gi = relu_gi - ele_val_at_quad(ug, ele)
end if
div_relu_gi = ele_div_at_quad(nu, ele, du_t)
if(multiphase) then
nvfrac_gi = ele_val_at_quad(nvfrac, ele)
grad_nvfrac_gi = ele_grad_at_quad(nvfrac, ele, dnvfrac_t)
end if
if(integrate_advection_by_parts) then
! element advection matrix
! / /
! - | (grad N_A dot nu) N_B rho dV - (1. - beta) | N_A ( div nu ) N_B rho dV
! / /
if(multiphase) then
! element advection matrix
! / /
! - | (grad N_A dot nu) N_B rho vfrac dV - (1. - beta) | N_A ( div(nu vfrac) ) N_B rho dV
! / /
! We need to compute \int{N_A div(nu vfrac) N_B},
! so split up the div using the product rule and compute
! \int{N_A vfrac div(nu) N_B} + \int{N_A nu grad(vfrac) N_B}
do i = 1, ele_ngi(u, ele)
relu_dot_grad_nvfrac_gi(i) = dot_product(relu_gi(:,i), grad_nvfrac_gi(:,i))
end do
advection_mat = -dshape_dot_vector_shape(du_t, relu_gi, u_shape, detwei*density_gi*nvfrac_gi) &
-(1.-beta)*(shape_shape(test_function, u_shape, div_relu_gi*detwei*density_gi*nvfrac_gi) + &
shape_shape(test_function, u_shape, detwei*density_gi*relu_dot_grad_nvfrac_gi))
else
advection_mat = -dshape_dot_vector_shape(du_t, relu_gi, u_shape, detwei*density_gi) &
-(1.-beta)*shape_shape(test_function, u_shape, div_relu_gi*detwei*density_gi)
end if
else
! element advection matrix
! / /
! | N_A (nu dot grad N_B) rho dV + beta | N_A ( div nu ) N_B rho dV
! / /
coefficient_detwei = density_gi*detwei
if(multiphase) then
coefficient_detwei = coefficient_detwei*nvfrac_gi
end if
advection_mat = shape_vector_dot_dshape(test_function, relu_gi, du_t, coefficient_detwei) &
+beta*shape_shape(test_function, u_shape, div_relu_gi*detwei*density_gi)
if(move_mesh) then
advection_mat = advection_mat - shape_shape(test_function, u_shape, ele_div_at_quad(ug, ele, dug_t)*detwei*density_gi)
end if
end if
select case(stabilisation_scheme)
case(STABILISATION_STREAMLINE_UPWIND)
if(have_viscosity) then
advection_mat = advection_mat + &
& element_upwind_stabilisation(u_shape, du_t, relu_gi, J_mat, detwei, &
& diff_q = ele_val_at_quad(viscosity, ele), nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
else
advection_mat = advection_mat + &
& element_upwind_stabilisation(u_shape, du_t, relu_gi, J_mat, detwei, &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
end if
end select
do dim = 1, u%dim
big_m_tensor_addto(dim, dim, :, :) = big_m_tensor_addto(dim, dim, :, :) + dt*theta*advection_mat
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(advection_mat, oldu_val(dim,:))
end do
end subroutine add_advection_element_cg
subroutine add_sources_element_cg(ele, test_function, u, density, source, detwei, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
type(scalar_field), intent(in) :: density
type(vector_field), intent(in) :: source
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
integer :: dim
real, dimension(ele_ngi(u, ele)) :: density_gi
real, dimension(ele_loc(u, ele)) :: source_lump
real, dimension(ele_loc(u, ele), ele_loc(source, ele)) :: source_mat
density_gi=ele_val_at_quad(density, ele)
! element source matrix
! /
! | N_A N_B rho dV
! /
source_mat = shape_shape(test_function, ele_shape(source, ele), detwei*density_gi)
if(lump_source) then
assert(ele_loc(source, ele)==ele_loc(u, ele))
source_lump = sum(source_mat, 2)
do dim = 1, u%dim
! lumped source
rhs_addto(dim, :) = rhs_addto(dim, :) + source_lump*ele_val(source, dim, ele)
end do
else
do dim = 1, u%dim
rhs_addto(dim, :) = rhs_addto(dim, :) + matmul(source_mat, ele_val(source, dim, ele))
end do
end if
end subroutine add_sources_element_cg
subroutine add_buoyancy_element_cg(positions, ele, test_function, u, buoyancy, gravity, nvfrac, on_sphere, detwei, rhs_addto)
type(vector_field), intent(in) :: positions
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
type(scalar_field), intent(in) :: buoyancy
type(vector_field), intent(in) :: gravity
type(scalar_field), intent(in) :: nvfrac
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
logical, intent(in) :: on_sphere
real, dimension(ele_ngi(u, ele)) :: nvfrac_gi
real, dimension(ele_ngi(u, ele)) :: coefficient_detwei
if(multiphase) then
nvfrac_gi = ele_val_at_quad(nvfrac, ele)
end if
coefficient_detwei = gravity_magnitude*ele_val_at_quad(buoyancy, ele)*detwei
if(multiphase) then
coefficient_detwei = coefficient_detwei*nvfrac_gi
end if
if (on_sphere) then
! If we're on a spherical Earth evaluate the direction of the gravity vector
! exactly at quadrature points.
rhs_addto = rhs_addto + &
shape_vector_rhs(test_function, &
sphere_inward_normal_at_quad_ele(positions, ele), &
coefficient_detwei)
else
rhs_addto = rhs_addto + &
shape_vector_rhs(test_function, &
ele_val_at_quad(gravity, ele), &
coefficient_detwei)
endif
end subroutine add_buoyancy_element_cg
subroutine add_surfacetension_element_cg(ele, test_function, u, surfacetension, du_t, detwei, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
type(tensor_field), intent(in) :: surfacetension
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim), intent(in) :: du_t
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
real, dimension(u%dim, ele_ngi(u, ele)) :: dtensiondj
real, dimension(u%dim, u%dim, ele_ngi(u, ele)) :: tension
if(integrate_surfacetension_by_parts) then
tension = ele_val_at_quad(surfacetension, ele)
rhs_addto = rhs_addto - dshape_dot_tensor_rhs(du_t, tension, detwei)
else
dtensiondj = ele_div_at_quad_tensor(surfacetension, ele, du_t)
rhs_addto = rhs_addto + shape_vector_rhs(test_function,dtensiondj,detwei)
end if
end subroutine add_surfacetension_element_cg
subroutine add_absorption_element_cg(positions, ele, test_function, u, oldu_val, &
density, absorption, detwei, &
big_m_diag_addto, big_m_tensor_addto, rhs_addto, &
masslump, mass, depth, gravity, buoyancy, &
alpha_u_field, abs_wd)
type(vector_field), intent(in) :: positions
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u
real, dimension(:,:), intent(in) :: oldu_val
type(scalar_field), intent(in) :: density
type(vector_field), intent(in) :: absorption
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: big_m_diag_addto
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
type(vector_field), intent(inout) :: masslump
type(petsc_csr_matrix), intent(inout) :: mass
type(scalar_field), intent(in) :: depth
type(vector_field), intent(in) :: gravity
type(scalar_field), intent(in) :: buoyancy
! Wetting and drying parameters
type(scalar_field), intent(in) :: alpha_u_field
type(vector_field), intent(in) :: abs_wd
integer :: dim, dim2, i
real, dimension(ele_ngi(u, ele)) :: density_gi
real, dimension(u%dim, ele_loc(u, ele)) :: absorption_lump
real, dimension(u%dim, u%dim, ele_loc(u, ele)) :: absorption_lump_sphere
real, dimension(u%dim, ele_ngi(u, ele)) :: absorption_gi
real, dimension(u%dim, u%dim, ele_ngi(u, ele)) :: tensor_absorption_gi
real, dimension(u%dim, ele_loc(u, ele), ele_loc(u, ele)) :: absorption_mat
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)) :: absorption_mat_sphere
! Add vertical velocity relaxation to the absorption if present
real, dimension(u%dim,u%dim,ele_ngi(u,ele)) :: vvr_abs
real, dimension(u%dim,ele_ngi(u,ele)) :: vvr_abs_diag
real, dimension(ele_ngi(u,ele)) :: depth_at_quads
! Add implicit buoyancy to the absorption if present
real, dimension(u%dim,u%dim,ele_ngi(u,ele)) :: ib_abs
real, dimension(u%dim,ele_ngi(u,ele)) :: ib_abs_diag
real, dimension(ele_loc(u,ele),ele_ngi(u,ele),mesh_dim(u)) :: dt_rho
real, dimension(U%dim,ele_ngi(u,ele)) :: grav_at_quads
real, dimension(u%dim, ele_ngi(u,ele)) :: grad_rho
real, dimension(ele_ngi(u,ele)) :: drho_dz
real, dimension(ele_ngi(u,ele)) :: alpha_u_quad
density_gi=ele_val_at_quad(density, ele)
absorption_gi=0.0
tensor_absorption_gi=0.0
if (have_absorption) then
absorption_gi = ele_val_at_quad(absorption, ele)
end if
if (on_sphere.and.have_absorption) then ! Rotate the absorption
tensor_absorption_gi=rotate_diagonal_to_sphere_gi(positions, ele, absorption_gi)
end if
! If we have any vertical stabilizing absorption terms, calculate them now
if (have_vertical_stabilization) then
! zero the vertical stab absorptions
vvr_abs_diag=0.0
vvr_abs=0.0
ib_abs=0.0
ib_abs_diag=0.0
if (have_vertical_velocity_relaxation) then
assert(ele_ngi(u, ele)==ele_ngi(density, ele))
assert(ele_ngi(density,ele)==ele_ngi(depth,ele))
! Form the vertical velocity relaxation absorption term
if (on_sphere) then
assert(ele_ngi(u, ele)==ele_ngi(positions, ele))
else
assert(ele_ngi(u, ele)==ele_ngi(gravity, ele))
grav_at_quads=ele_val_at_quad(gravity, ele)
end if
depth_at_quads=ele_val_at_quad(depth, ele)
if (on_sphere) then
do i=1,ele_ngi(u,ele)
vvr_abs_diag(3,i)=-vvr_sf*gravity_magnitude*dt/depth_at_quads(i)
end do
vvr_abs=rotate_diagonal_to_sphere_gi(positions, ele, vvr_abs_diag)
else
do i=1,ele_ngi(u,ele)
vvr_abs_diag(:,i)=vvr_sf*gravity_magnitude*dt*grav_at_quads(:,i)/depth_at_quads(i)
end do
end if
end if
if (have_implicit_buoyancy) then
assert(ele_ngi(u, ele)==ele_ngi(buoyancy, ele))
call transform_to_physical(positions, ele, ele_shape(buoyancy,ele), dshape=dt_rho)
grad_rho=ele_grad_at_quad(buoyancy, ele, dt_rho)
! Calculate the gradient in the direction of gravity
if (on_sphere) then
grav_at_quads=sphere_inward_normal_at_quad_ele(positions, ele)
else
grav_at_quads=ele_val_at_quad(gravity, ele)
end if
do i=1,ele_ngi(U,ele)
drho_dz(i)=dot_product(grad_rho(:,i),grav_at_quads(:,i)) ! Divide this by rho_0 for non-Boussinesq?
if (drho_dz(i) < ib_min_grad) drho_dz(i)=ib_min_grad ! Default ib_min_grad=0.0
end do
! Form the implicit buoyancy absorption terms
if (on_sphere) then
do i=1,ele_ngi(U,ele)
ib_abs_diag(3,i)=-theta*dt*gravity_magnitude*drho_dz(i)
end do
ib_abs=rotate_diagonal_to_sphere_gi(positions, ele, ib_abs_diag)
else
do i=1,ele_ngi(U,ele)
ib_abs_diag(:,i)=theta*dt*gravity_magnitude*drho_dz(i)*grav_at_quads(:,i)
end do
end if
end if
! Add any vertical stabilization to the absorption term
if (on_sphere) then
tensor_absorption_gi=tensor_absorption_gi-vvr_abs-ib_abs
absorption_gi=absorption_gi-vvr_abs_diag-ib_abs_diag
else
absorption_gi=absorption_gi-vvr_abs_diag-ib_abs_diag
end if
end if
! element absorption matrix
! /
! | N_A N_B abs rho dV
! /
! If on the sphere then use 'tensor' absorption. Note that using tensor absorption means that, currently,
! the absorption cannot be used in the pressure correction.
if (on_sphere) then
absorption_mat_sphere = shape_shape_tensor(test_function, ele_shape(u, ele), detwei*density_gi, tensor_absorption_gi)
if(lump_absorption) then
if(.not.abs_lump_on_submesh) then
absorption_lump_sphere = sum(absorption_mat_sphere, 4)
do dim = 1, u%dim
do dim2 = 1, u%dim
do i = 1, ele_loc(u, ele)
big_m_tensor_addto(dim, dim2, i, i) = big_m_tensor_addto(dim, dim2, i, i) + &
& dt*theta*absorption_lump_sphere(dim,dim2,i)
end do
end do
rhs_addto(dim, :) = rhs_addto(dim, :) - absorption_lump_sphere(dim,dim,:)*oldu_val(dim,:)
! off block diagonal absorption terms
do dim2 = 1, u%dim
if (dim==dim2) cycle ! The dim=dim2 terms were done above
rhs_addto(dim, :) = rhs_addto(dim, :) - absorption_lump_sphere(dim,dim2,:)*oldu_val(dim2,:)
end do
end do
end if
else
do dim = 1, u%dim
do dim2 = 1, u%dim
big_m_tensor_addto(dim, dim2, :, :) = big_m_tensor_addto(dim, dim2, :, :) + &
& dt*theta*absorption_mat_sphere(dim,dim2,:,:)
end do
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(absorption_mat_sphere(dim,dim,:,:), oldu_val(dim,:))
! off block diagonal absorption terms
do dim2 = 1, u%dim
if (dim==dim2) cycle ! The dim=dim2 terms were done above
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(absorption_mat_sphere(dim,dim2,:,:), oldu_val(dim2,:))
end do
end do
absorption_lump_sphere = 0.0
end if
if (pressure_corrected_absorption) then
! ct_m and u will later be rotated in this case, thus use a 'vector' absorption at
! this stage.
absorption_mat = shape_shape_vector(test_function, ele_shape(u, ele), detwei*density_gi, absorption_gi)
absorption_lump = sum(absorption_mat, 3)
if (assemble_inverse_masslump.and.(.not.(abs_lump_on_submesh))) then
call addto(masslump, ele_nodes(u, ele), dt*theta*absorption_lump)
end if
if (assemble_mass_matrix) then
do dim = 1, u%dim
call addto(mass, dim, dim, ele_nodes(u, ele), ele_nodes(u,ele), &
dt*theta*absorption_mat(dim,:,:))
end do
end if
end if
else
absorption_mat = shape_shape_vector(test_function, ele_shape(u, ele), detwei*density_gi, absorption_gi)
if (have_wd_abs) then
alpha_u_quad=ele_val_at_quad(alpha_u_field, ele) !! Wetting and drying absorption becomes active when water level reaches d_0
absorption_mat = absorption_mat + &
& shape_shape_vector(test_function, ele_shape(u, ele), alpha_u_quad*detwei*density_gi, &
& ele_val_at_quad(abs_wd,ele))
end if
if(lump_absorption) then
if(.not.abs_lump_on_submesh) then
absorption_lump = sum(absorption_mat, 3)
do dim = 1, u%dim
big_m_diag_addto(dim, :) = big_m_diag_addto(dim, :) + dt*theta*absorption_lump(dim,:)
rhs_addto(dim, :) = rhs_addto(dim, :) - absorption_lump(dim,:)*oldu_val(dim,:)
end do
end if
else
do dim = 1, u%dim
big_m_tensor_addto(dim, dim, :, :) = big_m_tensor_addto(dim, dim, :, :) + &
& dt*theta*absorption_mat(dim,:,:)
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(absorption_mat(dim,:,:), oldu_val(dim,:))
end do
absorption_lump = 0.0
end if
if (pressure_corrected_absorption) then
if (assemble_inverse_masslump.and.(.not.(abs_lump_on_submesh))) then
call addto(masslump, ele_nodes(u, ele), dt*theta*absorption_lump)
end if
if (assemble_mass_matrix) then
do dim = 1, u%dim
call addto(mass, dim, dim, ele_nodes(u, ele), ele_nodes(u,ele), &
dt*theta*absorption_mat(dim,:,:))
end do
end if
end if
end if
end subroutine add_absorption_element_cg
subroutine add_viscosity_element_cg(state, ele, test_function, u, oldu_val, nu, x, viscosity, grad_u, &
tnu, leonard, alpha, &
du_t, detwei, big_m_tensor_addto, rhs_addto, temperature, nvfrac)
type(state_type), intent(inout) :: state
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: u, nu
real, dimension(:,:), intent(in) :: oldu_val
type(vector_field), intent(in) :: x
type(tensor_field), intent(in) :: viscosity
type(tensor_field), intent(in) :: grad_u
! Fields for Germano Dynamic LES Model
type(vector_field), intent(in) :: tnu
type(tensor_field), intent(in) :: leonard
real, intent(in) :: alpha
! Local quantities specific to Germano Dynamic LES Model
real :: numerator, denominator
real, dimension(x%dim, x%dim, ele_ngi(u,ele)) :: strain_gi, t_strain_gi
real, dimension(x%dim, x%dim, ele_ngi(u,ele)) :: mesh_size_gi, leonard_gi
real, dimension(ele_ngi(u, ele)) :: strain_mod, t_strain_mod
type(element_type) :: shape_nu
integer, dimension(:), pointer :: nodes_nu
! Temperature dependent viscosity:
type(scalar_field), intent(in) :: temperature
! Non-linear PhaseVolumeFraction
type(scalar_field), intent(in) :: nvfrac
integer :: dim, dimj, gi, iloc
real, dimension(u%dim, ele_loc(u, ele)) :: nu_ele
real, dimension(u%dim, u%dim, ele_ngi(u, ele)) :: viscosity_gi
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)) :: viscosity_mat
real, dimension(x%dim, x%dim, ele_ngi(u, ele)) :: les_tensor_gi
real, dimension(ele_ngi(u, ele)) :: les_coef_gi, wale_coef_gi
real, dimension(x%dim, ele_loc(u,ele), ele_loc(u,ele)) :: div_les_viscosity
real, dimension(x%dim, x%dim, ele_loc(u,ele)) :: grad_u_nodes
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim), intent(in) :: du_t
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
if (have_viscosity .AND. .not.(have_temperature_dependent_viscosity)) then
viscosity_gi = ele_val_at_quad(viscosity, ele)
else
! if we don't have viscosity but maybe LES
viscosity_gi = 0.0
end if
! Account for temperature dependence, if requested:
if(have_temperature_dependent_viscosity) then
viscosity_gi = 0.0
if(stress_form.or.partial_stress_form) then
do dim=1, u%dim
do dimj = 1, u%dim
viscosity_gi(dim,dimj,:) = reference_viscosity * &
exp(-activation_energy*(ele_val_at_quad(temperature,ele)))
end do
end do
end if
end if
! add in LES viscosity
if (have_les) then
nu_ele = ele_val(nu, ele)
! WALE model
if (wale) then
les_tensor_gi=length_scale_tensor(du_t, ele_shape(u, ele))
les_coef_gi=les_viscosity_strength(du_t, nu_ele)
wale_coef_gi=wale_viscosity_strength(du_t, nu_ele)
do gi=1, size(les_coef_gi)
les_tensor_gi(:,:,gi)=4.*les_tensor_gi(:,:,gi)* &
wale_coef_gi(gi)**3 * smagorinsky_coefficient**2 / &
max(les_coef_gi(gi)**5 + wale_coef_gi(gi)**2.5, 1.e-10)
end do
! 2nd order Smagorinsky model
else if(les_second_order) then
les_tensor_gi=length_scale_tensor(du_t, ele_shape(u, ele))
les_coef_gi=les_viscosity_strength(du_t, nu_ele)
do gi=1, size(les_coef_gi)
les_tensor_gi(:,:,gi)=4.*les_coef_gi(gi)*les_tensor_gi(:,:,gi)* &
smagorinsky_coefficient**2
end do
! Eddy viscosity tensor field. Calling this subroutine works because
! you can't have 2 different types of LES model for the same material phase.
if(have_eddy_visc) then
call les_set_diagnostic_tensor_fields(state, u, ele, detwei, &
les_tensor_gi, les_tensor_gi, les_tensor_gi, les_tensor_gi, &
have_eddy_visc, .false., .false., .false.)
end if
! 4th order Smagorinsky model
else if (les_fourth_order) then
les_tensor_gi=length_scale_tensor(du_t, ele_shape(u, ele))
les_coef_gi=les_viscosity_strength(du_t, nu_ele)
div_les_viscosity=dshape_dot_tensor_shape(du_t, les_tensor_gi, ele_shape(u, ele), detwei)
grad_u_nodes=ele_val(grad_u, ele)
do dim=1, u%dim
do iloc=1, ele_loc(u, ele)
rhs_addto(dim,iloc)=rhs_addto(dim,iloc)+ &
sum(div_les_viscosity(:,:,iloc)*grad_u_nodes(:,dim,:))
end do
end do
! Germano dynamic model
else if (dynamic_les) then
shape_nu = ele_shape(nu, ele)
nodes_nu => ele_nodes(nu, ele)
les_tensor_gi=0.0
! Get strain S1 for unfiltered velocity (dim,dim,ngi)
strain_gi = les_strain_rate(du_t, ele_val(nu, ele))
! Get strain S2 for test-filtered velocity (dim,dim,ngi)
t_strain_gi = les_strain_rate(du_t, ele_val(tnu, ele))
! Filter width G1 associated with mesh size (units length^2)
mesh_size_gi = length_scale_tensor(du_t, ele_shape(u, ele))
! Leonard tensor L at gi
leonard_gi =ele_val_at_quad(leonard, ele)
do gi=1, ele_ngi(nu, ele)
! Get strain modulus |S1| for unfiltered velocity (ngi)
strain_mod(gi) = sqrt( 2*sum(strain_gi(:,:,gi)*strain_gi(:,:,gi) ) )
! Get strain modulus |S2| for test-filtered velocity (ngi)
t_strain_mod(gi) = sqrt( 2*sum(t_strain_gi(:,:,gi)*t_strain_gi(:,:,gi) ) )
end do
! If sum of strain components = 0, don't use dynamic LES model
if(abs(sum(strain_gi(:,:,:))) < epsilon(0.0)) then
les_tensor_gi = 0.0
t_strain_mod = 0.0
else
! Choose original Germano model or Lilly's (1991) modification from options
if(.not. have_lilly) then
do gi=1, ele_ngi(nu, ele)
! |S1|*L.S1
numerator = sum( leonard_gi(:,:,gi)*strain_gi(:,:,gi) )*strain_mod(gi)
! alpha^2*|S2|*S2.S1
! This term is WRONG until I find a way of filtering the strain rate product. The difference may be quite small though.
denominator = -alpha**2*t_strain_mod(gi)*sum(t_strain_gi(:,:,gi)*strain_gi(:,:,gi))
! Dynamic eddy viscosity m_ij = C*S1
les_tensor_gi(:,:,gi) = numerator/denominator
! Whether or not to allow negative eddy viscosity (backscattering)
! but do not allow (viscosity+eddy_viscosity) < 0.
if(any(les_tensor_gi(:,:,gi) < 0.0)) then
if(backscatter) then
les_tensor_gi(:,:,gi) = max(les_tensor_gi(:,:,gi), epsilon(0.0) - viscosity_gi(:,:,gi))
else
les_tensor_gi(:,:,gi) = max(les_tensor_gi(:,:,gi),0.0)
end if
end if
end do
else if(have_lilly) then
do gi=1, ele_ngi(nu, ele)
! |S1|*L.S1
numerator = sum(leonard_gi(:,:,gi)*t_strain_gi(:,:,gi))*strain_mod(gi)
! alpha^2*|S2|^2*S2.S2
! This term is WRONG until I find a way of filtering the strain rate product. The difference may be quite small though.
denominator = -alpha**2*(t_strain_mod(gi))**2*sum(t_strain_gi(:,:,gi)*t_strain_gi(:,:,gi))
! Dynamic eddy viscosity m_ij
les_tensor_gi(:,:,gi) = numerator/denominator
! Whether or not to allow negative eddy viscosity (backscattering)
! but do not allow (viscosity+eddy_viscosity) < 0.
if(any(les_tensor_gi(:,:,gi) < 0.0)) then
if(backscatter) then
les_tensor_gi(:,:,gi) = max(les_tensor_gi(:,:,gi), epsilon(0.0) - viscosity_gi(:,:,gi))
else
les_tensor_gi(:,:,gi) = max(les_tensor_gi(:,:,gi),0.0)
end if
end if
end do
end if
end if
! Set diagnostic fields
call les_set_diagnostic_tensor_fields(state, nu, ele, detwei, &
mesh_size_gi, strain_gi, t_strain_gi, les_tensor_gi, &
have_eddy_visc, have_strain, have_filtered_strain, have_filter_width)
else
FLAbort("Unknown LES model")
end if
viscosity_gi=viscosity_gi+les_tensor_gi
end if
! element viscosity matrix - tensor form
! /
! | gradN_A^T viscosity gradN_B dV
! /
! only valid when incompressible and viscosity tensor is isotropic
viscosity_mat = 0.0
if(stress_form.or.partial_stress_form) then
! add in the stress form entries of the element viscosity matrix
! /
! | B_A^T C B_B dV
! /
viscosity_mat = stiffness_matrix(du_t, viscosity_gi, du_t, detwei)
else
if(isotropic_viscosity .and. .not. have_les) then
assert(u%dim > 0)
if(multiphase) then
! We need to compute \int{grad(N_A) vfrac viscosity grad(N_B)}
viscosity_mat(1, 1, :, :) = dshape_dot_dshape(du_t, du_t, detwei*viscosity_gi(1, 1, :)*&
ele_val_at_quad(nvfrac, ele))
else
viscosity_mat(1, 1, :, :) = dshape_dot_dshape(du_t, du_t, detwei * viscosity_gi(1, 1, :))
end if
do dim = 2, u%dim
viscosity_mat(dim, dim, :, :) = viscosity_mat(1, 1, :, :)
end do
else if(diagonal_viscosity .and. .not. have_les) then
assert(u%dim > 0)
viscosity_mat(1, 1, :, :) = dshape_diagtensor_dshape(du_t, viscosity_gi, du_t, detwei)
do dim = 2, u%dim
viscosity_mat(dim, dim, :, :) = viscosity_mat(1, 1, :, :)
end do
else
do dim = 1, u%dim
viscosity_mat(dim, dim, :, :) = &
dshape_tensor_dshape(du_t, viscosity_gi, du_t, detwei)
end do
end if
end if
big_m_tensor_addto = big_m_tensor_addto + dt*theta*viscosity_mat
do dim = 1, u%dim
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(viscosity_mat(dim,dim,:,:), oldu_val(dim,:))
! off block diagonal viscosity terms
if(stress_form.or.partial_stress_form) then
do dimj = 1, u%dim
if (dim==dimj) cycle ! already done this
rhs_addto(dim, :) = rhs_addto(dim, :) - matmul(viscosity_mat(dim,dimj,:,:), oldu_val(dimj,:))
end do
end if
end do
end subroutine add_viscosity_element_cg
subroutine get_viscous_terms_element_cg(ele, u, nu, x, viscosity, &
du_t, detwei, visc_inverse_masslump)
integer, intent(in) :: ele
type(vector_field), intent(in) :: u, nu
type(vector_field), intent(in) :: x
type(tensor_field), intent(in) :: viscosity
real, dimension(ele_loc(u, ele), ele_ngi(u, ele), u%dim), intent(in) :: du_t
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
type(vector_field), intent(inout) :: visc_inverse_masslump
integer :: i, dim, gi
real, dimension(u%dim, u%dim, ele_ngi(u, ele)) :: viscosity_gi
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)) :: viscosity_mat
integer, dimension(:), pointer :: nodes
real, dimension(x%dim, x%dim, ele_ngi(u,ele)) :: les_tensor_gi
real, dimension(ele_ngi(u, ele)) :: les_coef_gi
if (have_viscosity) then
viscosity_gi = ele_val_at_quad(viscosity, ele)
else
! if we don't have viscosity but maybe LES
viscosity_gi = 0.0
end if
if (have_les) then
! add in LES viscosity
les_tensor_gi=length_scale_tensor(du_t, ele_shape(u, ele))
les_coef_gi=les_viscosity_strength(du_t, ele_val(nu, ele))
do gi=1, size(les_coef_gi)
les_tensor_gi(:,:,gi)=les_coef_gi(gi)*les_tensor_gi(:,:,gi)* &
smagorinsky_coefficient**2
end do
viscosity_gi=viscosity_gi+les_tensor_gi
end if
! element viscosity matrix - tensor form
! /
! | gradN_A^T viscosity gradN_B dV
! /
! only valid when incompressible and viscosity tensor is isotropic
viscosity_mat = 0.0
if(stress_form.or.partial_stress_form) then
! add in the stress form entries of the element viscosity matrix
! /
! | B_A^T C B_B dV
! /
viscosity_mat = stiffness_matrix(du_t, viscosity_gi, du_t, detwei)
else
if(isotropic_viscosity .and. .not. have_les) then
assert(u%dim > 0)
viscosity_mat(1, 1, :, :) = dshape_dot_dshape(du_t, du_t, detwei * viscosity_gi(1, 1, :))
do dim = 2, u%dim
viscosity_mat(dim, dim, :, :) = viscosity_mat(1, 1, :, :)
end do
else if(diagonal_viscosity .and. .not. have_les) then
assert(u%dim > 0)
viscosity_mat(1, 1, :, :) = dshape_diagtensor_dshape(du_t, viscosity_gi, du_t, detwei)
do dim = 2, u%dim
viscosity_mat(dim, dim, :, :) = viscosity_mat(1, 1, :, :)
end do
else
do dim = 1, u%dim
viscosity_mat(dim, dim, :, :) = &
dshape_tensor_dshape(du_t, viscosity_gi, du_t, detwei)
end do
end if
end if
nodes => ele_nodes(u,ele)
do dim = 1, u%dim
do i = 1, ele_loc(u,ele)
call addto(visc_inverse_masslump, dim, nodes(i), dt*theta*viscosity_mat(dim,dim,i,i))
end do
end do
end subroutine get_viscous_terms_element_cg
subroutine add_coriolis_element_cg(ele, test_function, x, u, oldu_val, density, detwei, big_m_tensor_addto, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: x
type(vector_field), intent(in) :: u
real, dimension(:,:), intent(in) :: oldu_val
type(scalar_field), intent(in) :: density
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, u%dim, ele_loc(u, ele), ele_loc(u, ele)), intent(inout) :: big_m_tensor_addto
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
real, dimension(ele_ngi(u, ele)) :: coriolis_gi, density_gi
real, dimension(ele_loc(u, ele), ele_loc(u, ele)) :: coriolis_mat
density_gi = ele_val_at_quad(density, ele)
! element coriolis matrix
! /
! | N_A N_B rho omega dV
! /
!
! scaling factor (omega, or f_0+\beta y, etc. depending on options):
coriolis_gi=coriolis(ele_val_at_quad(x,ele))
coriolis_mat = shape_shape(test_function, ele_shape(u, ele), density_gi*coriolis_gi*detwei)
! cross terms in U_ and V_ for coriolis
big_m_tensor_addto(U_, V_, :, :) = big_m_tensor_addto(U_, V_, :, :) - dt*theta*coriolis_mat
big_m_tensor_addto(V_, U_, :, :) = big_m_tensor_addto(V_, U_, :, :) + dt*theta*coriolis_mat
rhs_addto(U_, :) = rhs_addto(U_, :) + matmul(coriolis_mat, oldu_val(V_,:))
rhs_addto(V_, :) = rhs_addto(V_, :) - matmul(coriolis_mat, oldu_val(U_,:))
end subroutine add_coriolis_element_cg
subroutine add_geostrophic_pressure_element_cg(ele, test_function, x, u, gp, detwei, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(vector_field), intent(in) :: x
type(vector_field), intent(in) :: u
type(scalar_field), intent(in) :: gp
real, dimension(ele_ngi(u, ele)), intent(in) :: detwei
real, dimension(u%dim, ele_loc(u, ele)), intent(inout) :: rhs_addto
real, dimension(ele_loc(gp, ele), ele_ngi(gp, ele), mesh_dim(gp)) :: dgp_t
! We assume here that gp is usually on a different mesh to u or p
call transform_to_physical(x, ele, ele_shape(gp, ele), &
& dshape = dgp_t)
rhs_addto = rhs_addto - shape_vector_rhs(test_function, ele_grad_at_quad(gp, ele, dgp_t), detwei)
end subroutine add_geostrophic_pressure_element_cg
function stiffness_matrix(dshape1, tensor, dshape2, detwei) result (matrix)
!!< Calculates the stiffness matrix.
!!<
!!< /
!!< matrix = | b_a^T c b_b dV
!!< /
!!<
!!< where
!!< b_a = / N_a,x 0 0 \ c = / 4/3*mu_xx -2/3*mu_xy -2/3*mu_xz 0 0 0 \
!!< | 0 N_a,y 0 | | -2/3*mu_yx 4/3*mu_yy -2/3*mu_yz 0 0 0 |
!!< | 0 0 N_a,z | | -2/3*mu_zx -2/3*mu_zy 4/3*mu_zz 0 0 0 |
!!< | N_a,y N_a,x 0 | | 0 0 0 mu_xy 0 0 |
!!< | N_a,z 0 N_a,x | | 0 0 0 0 mu_xz 0 |
!!< \ 0 N_a,z N_a,y / \ 0 0 0 0 0 mu_yz /
!!< which results in:
!!< b_a^T c b_b - I gradN_a^T diag(mu) gradN_b =
!!< / N_a,x*N_b,x*mu_xx - 2/3*N_a,x*N_b,x*mu_xx + (N_a,x*N_b,x*mu_xx + N_a,y*N_b,y*mu_xy + N_a,z*N_b,z*mu_xz)
!!< | N_a,x*N_b,y*mu_xy - 2/3*N_a,y*N_b,x*mu_yx ...
!!< \ N_a,x*N_b,z*mu_xz - 2/3*N_a,z*N_b,x*mu_zx
!!<
!!< N_a,y*N_b,x*mu_xy - 2/3*N_a,x*N_b,y*mu_xy
!!< ... N_a,y*N_b,y*mu_yy - 2/3*N_a,y*N_b,y*mu_yy + (N_a,x*N_b,x*mu_xy + N_a,y*N_b,y*mu_yy + N_a,z*N_b,z*mu_yz) ...
!!< N_a,y*N_b,z*mu_yz - 2/3*N_a,z*N_b,y*mu_zy
!!<
!!< N_a,z*N_b,x*mu_xz - 2/3*N_a,x*N_b,z*mu_xz \
!!< ... N_a,z*N_b,y*mu_yz - 2/3*N_a,y*N_b,z*mu_yz |
!!< N_a,z*N_b,z*mu_zz - 2/3*N_a,z*N_b,z*mu_zz + (N_a,x*N_b,x*mu_xz + N_a,y*N_b,y*mu_yz + N_a,z*N_b,z*mu_zz) /
!!< where the terms in brackets correspond to the tensor form entries I gradN_a^T row(symm(mu)) gradN_b (see below).
real, dimension(:,:,:), intent(in) :: dshape1, dshape2
real, dimension(size(dshape1,3),size(dshape1,3),size(dshape1,2)), intent(in) :: tensor
real, dimension(size(dshape1,2)), intent(in) :: detwei
real, dimension(size(dshape1,3),size(dshape1,3),size(dshape1,1),size(dshape2,1)) :: matrix
real, dimension(size(dshape1,3),size(dshape1,2)) :: tensor_diag, tensor_entries
integer :: iloc,jloc, gi, i, j
integer :: loc1, loc2, ngi, dim
loc1=size(dshape1,1)
loc2=size(dshape2,1)
ngi=size(dshape1,2)
dim=size(dshape1,3)
assert(loc1==loc2)
tensor_diag = 0.0
tensor_entries = 0.0
matrix=0.0
! /
! matrix = I| gradN_a^T row(symm(mu)) gradN_b dV
! /
do i=1,dim
! extract the relevent tensor entries into a vector
do j = 1, i-1
tensor_entries(j,:) = tensor(j,i,:)
end do
do j = i, dim
tensor_entries(j,:) = tensor(i,j,:)
end do
matrix(i,i,:,:) = dshape_vector_dshape(dshape1, tensor_entries, dshape2, detwei)
end do
if(partial_stress_form) then
! matrix = matrix + b_a^T c b_b - I gradN_a^T row(symm(mu)) gradN_b
! = matrix + / N_a,x*N_b,x*mu_xx
! | N_a,x*N_b,y*mu_xy ...
! \ N_a,x*N_b,z*mu_xz
!
! N_a,y*N_b,x*mu_xy
! ... N_a,y*N_b,y*mu_yy ...
! N_a,y*N_b,z*mu_yz
!
! N_a,z*N_b,x*mu_xz \
! ... N_a,z*N_b,y*mu_yz |
! N_a,z*N_b,z*mu_zz /
do gi=1,ngi
forall(iloc=1:loc1,jloc=1:loc2)
matrix(:,:,iloc,jloc) = matrix(:,:,iloc,jloc) &
+(spread(dshape1(iloc,gi,:), 1, dim) &
*spread(dshape2(jloc,gi,:), 2, dim) &
*tensor(:,:,gi)) &
*detwei(gi)
end forall
end do
else
! matrix = matrix + b_a^T c b_b - I gradN_a^T row(symm(mu)) gradN_b
! = matrix + / N_a,x*N_b,x*mu_xx - 2/3*N_a,x*N_b,x*mu_xx
! | N_a,x*N_b,y*mu_xy - 2/3*N_a,y*N_b,x*mu_yx ...
! \ N_a,x*N_b,z*mu_xz - 2/3*N_a,z*N_b,x*mu_zx
!
! N_a,y*N_b,x*mu_xy - 2/3*N_a,x*N_b,y*mu_xy
! ... N_a,y*N_b,y*mu_yy - 2/3*N_a,y*N_b,y*mu_yy ...
! N_a,y*N_b,z*mu_yz - 2/3*N_a,z*N_b,y*mu_zy
!
! N_a,z*N_b,x*mu_xz - 2/3*N_a,x*N_b,z*mu_xz \
! ... N_a,z*N_b,y*mu_yz - 2/3*N_a,y*N_b,z*mu_yz |
! N_a,z*N_b,z*mu_zz - 2/3*N_a,z*N_b,z*mu_zz /
do gi=1,ngi
forall(iloc=1:loc1,jloc=1:loc2)
matrix(:,:,iloc,jloc) = matrix(:,:,iloc,jloc) &
+(spread(dshape1(iloc,gi,:), 1, dim) &
*spread(dshape2(jloc,gi,:), 2, dim) &
*tensor(:,:,gi) &
-spread(dshape1(iloc,gi,:), 2, dim) &
*spread(dshape2(jloc,gi,:), 1, dim) &
*(2./3.)*tensor(:,:,gi)) &
*detwei(gi)
end forall
end do
end if
end function stiffness_matrix
subroutine deallocate_cg_mass(mass, inverse_masslump)
!!< Deallocates mass and/or inverse_masslump
!!< if they are assembled in construct_momentum_cg()
type(petsc_csr_matrix), intent(inout):: mass
type(vector_field), intent(inout):: inverse_masslump
if (assemble_mass_matrix) then
call deallocate(mass)
end if
if (assemble_inverse_masslump) then
call deallocate(inverse_masslump)
end if
end subroutine deallocate_cg_mass
subroutine correct_masslumped_velocity(u, inverse_masslump, ct_m, delta_p)
!!< Given the pressure correction delta_p, correct the velocity.
!!<
!!< U_new = U_old + M_l^{-1} * C * delta_P
type(vector_field), intent(inout) :: u
type(vector_field), intent(inout) :: inverse_masslump
type(block_csr_matrix), intent(in) :: ct_m
type(scalar_field), intent(in) :: delta_p
! Correction to u one dimension at a time.
type(scalar_field) :: delta_u, inverse_masslump_component
integer :: dim
ewrite(1,*) 'correct_masslumped_velocity'
call allocate(delta_u, u%mesh, "Delta_U")
do dim=1,u%dim
call mult_t(delta_u, block(ct_m,1,dim), delta_p)
inverse_masslump_component = extract_scalar_field(inverse_masslump, dim)
call scale(delta_u, inverse_masslump_component)
call addto(u, dim, delta_u)
end do
call halo_update(u)
ewrite_minmax(u)
call deallocate(delta_u)
end subroutine correct_masslumped_velocity
subroutine correct_velocity_cg(u, mass, ct_m, delta_p, state)
!!< Given the pressure correction delta_p, correct the velocity.
!!<
!!< U_new = U_old + M_l^{-1} * C * delta_P
type(vector_field), intent(inout) :: u
type(petsc_csr_matrix), intent(inout) :: mass
type(block_csr_matrix), intent(in) :: ct_m
type(scalar_field), intent(in) :: delta_p
type(state_type), intent(in) :: state
! Correction to u one dimension at a time.
type(vector_field) :: delta_u1, delta_u2
ewrite(1,*) 'correct_velocity_cg'
call allocate(delta_u1, u%dim, u%mesh, "Delta_U1")
call allocate(delta_u2, u%dim, u%mesh, "Delta_U2")
delta_u2%option_path = trim(delta_p%option_path)//&
&"/prognostic/scheme/use_projection_method"//&
&"/full_schur_complement/inner_matrix[0]"
! compute delta_u1=grad delta_p
call mult_t(delta_u1, ct_m, delta_p)
! compute M^{-1} delta_u1
call zero(delta_u2)
call petsc_solve(delta_u2, mass, delta_u1, state)
call addto(u, delta_u2)
call halo_update(u)
ewrite_minmax(u)
call deallocate(delta_U1)
call deallocate(delta_U2)
end subroutine correct_velocity_cg
subroutine assemble_poisson_rhs(poisson_rhs, &
ctp_m, mom_rhs, ct_rhs, big_m, velocity, dt, theta_pg)
type(scalar_field), intent(inout) :: poisson_rhs
type(block_csr_matrix), intent(in) :: ctp_m
type(vector_field), intent(in) :: mom_rhs
type(scalar_field), intent(in) :: ct_rhs
type(petsc_csr_matrix), intent(inout) :: big_m
type(vector_field), intent(in) :: velocity
real, intent(in) :: dt, theta_pg
type(vector_field) :: l_mom_rhs
ewrite(1,*) 'Entering assemble_poisson_rhs'
call allocate(l_mom_rhs, mom_rhs%dim, mom_rhs%mesh, name="AssemblePoissonMomRHS")
! poisson_rhs = ct_rhs/dt - C^T ( M^-1 mom_rhs + velocity/dt )
! compute M^-1 mom_rhs + velocity/dt
call zero(l_mom_rhs)
l_mom_rhs%option_path=velocity%option_path
call petsc_solve(l_mom_rhs, big_m, mom_rhs)
call addto(l_mom_rhs, velocity, scale=1.0/dt/theta_pg)
! need to update before the mult, as halo of mom_rhs may not be valid
! (although it probably is in halo 1 - let's be safe anyway)
call halo_update(l_mom_rhs)
call mult(poisson_rhs, ctp_m, l_mom_rhs)
call scale(poisson_rhs, -1.0)
call addto(poisson_rhs, ct_rhs, scale=1.0/dt/theta_pg)
call deallocate(l_mom_rhs)
end subroutine assemble_poisson_rhs
subroutine assemble_masslumped_poisson_rhs(poisson_rhs, &
ctp_m, mom_rhs, ct_rhs, inverse_masslump, velocity, dt, theta_pg)
type(scalar_field), intent(inout) :: poisson_rhs
type(block_csr_matrix), intent(in) :: ctp_m
type(vector_field), intent(in) :: mom_rhs
type(scalar_field), intent(in) :: ct_rhs
type(vector_field), intent(in) :: inverse_masslump
type(vector_field), intent(in) :: velocity
real, intent(in) :: dt, theta_pg
type(vector_field) :: l_mom_rhs
ewrite(1,*) 'Entering assemble_masslumped_poisson_rhs'
call allocate(l_mom_rhs, mom_rhs%dim, mom_rhs%mesh, name="AssemblePoissonMomRHS")
! poisson_rhs = ct_rhs/dt - C^T ( M_L^-1 mom_rhs + velocity/dt )
! compute M_L^-1 mom_rhs + velocity/dt
call set(l_mom_rhs, mom_rhs)
call scale(l_mom_rhs, inverse_masslump)
call addto(l_mom_rhs, velocity, scale=1.0/dt/theta_pg)
! need to update before the mult, as halo of mom_rhs may not be valid
! (although it probably is in halo 1 - let's be safe anyway)
call halo_update(l_mom_rhs)
call mult(poisson_rhs, ctp_m, l_mom_rhs)
call scale(poisson_rhs, -1.0)
call addto(poisson_rhs, ct_rhs, scale=1.0/dt/theta_pg)
call deallocate(l_mom_rhs)
end subroutine assemble_masslumped_poisson_rhs
subroutine assemble_kmk_matrix(state, pressure_mesh, coordinates, &
theta_pg)
! Assemble P1-P1 stabilisation term in the pressure matrix.
type(state_type), intent(inout) :: state
type(mesh_type), intent(inout) :: pressure_mesh
type(vector_field), intent(in) :: coordinates
! the required term is K^T M^-1 K (theta dt dp), the variable we're
! solving for in the pressure equation however is theta**2 dt dp
! thus we have to divide kmk by theta
real, intent(in) :: theta_pg
type(csr_matrix), pointer :: kmk
type(csr_sparsity), pointer :: p_sparsity
integer :: ele
type(csr_matrix) :: kt
real, dimension(mesh_dim(pressure_mesh), mesh_dim(pressure_mesh), ele_ngi(pressure_mesh, 1)) :: h_bar
type(element_type), pointer :: p_shape
real, dimension(ele_ngi(pressure_mesh, 1)) :: detwei
real, dimension(ele_loc(pressure_mesh, 1), ele_ngi(pressure_mesh, 1), coordinates%dim) :: dp_t
real, dimension(ele_loc(pressure_mesh, 1), ele_loc(pressure_mesh, 1)) :: little_stiff_matrix
type(scalar_field) :: scaled_p_masslump
type(scalar_field), pointer :: p_masslump
p_shape => ele_shape(pressure_mesh, 1)
kmk => get_pressure_stabilisation_matrix(state)
p_sparsity => get_csr_sparsity_firstorder(state, pressure_mesh, pressure_mesh)
call allocate(kt, p_sparsity, name="PressureDiffusionMatrix")
call zero(kt)
p_masslump => get_lumped_mass(state, pressure_mesh)
! Assemble the pressure diffusion matrix k. The diffusion parameter is
! given by a tensor describing the element length scales in physical space
! (h_bar). Simplex_tensor gives the metric that would make that element
! the ideal element.
do ele=1,ele_count(pressure_mesh)
call transform_to_physical(coordinates, ele, p_shape, dshape=dp_t, detwei=detwei)
call get_edge_lengths(pressure_mesh, coordinates, ele, h_bar)
little_stiff_matrix = dshape_tensor_dshape(dp_t, h_bar, dp_t, detwei)
call addto(kt, ele_nodes(pressure_mesh, ele), ele_nodes(pressure_mesh, ele), 0.5 * little_stiff_matrix)
end do
! by scaling masslump with theta, we divide kmk by theta
if(abs(theta_pg - 1.0) < epsilon(0.0)) then
call mult_div_invscalar_div_T(kmk, kt, p_masslump, kt)
else
call allocate(scaled_p_masslump, p_masslump%mesh, trim(p_masslump%name) // "Scaled")
call set(scaled_p_masslump, p_masslump)
call scale(scaled_p_masslump, theta_pg)
! Compute kmk, the stabilisation term.
call mult_div_invscalar_div_T(kmk, kt, scaled_p_masslump, kt)
call deallocate(scaled_p_masslump)
end if
call deallocate(kt)
end subroutine assemble_kmk_matrix
subroutine add_kmk_matrix(state, cmc_m)
! Add kmk (P1-P1 stabilisation term in the pressure matrix) to cmc_m.
type(state_type), intent(inout) :: state
type(csr_matrix), intent(inout) :: cmc_m
type(csr_matrix), pointer :: kmk
kmk => get_pressure_stabilisation_matrix(state)
call addto(cmc_m, kmk)
end subroutine add_kmk_matrix
subroutine add_kmk_rhs(state, rhs, pressure, dt)
type(state_type), intent(inout) :: state
type(scalar_field), intent(inout) :: rhs
type(scalar_field), intent(in) :: pressure
real, intent(in) :: dt
type(csr_matrix), pointer :: kmk
kmk => get_pressure_stabilisation_matrix(state)
call mult(rhs, kmk, pressure)
call scale(rhs, dt)
end subroutine add_kmk_rhs
end module momentum_cg
|