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
|
! 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 advection_diffusion_cg
! keep in this order, please:
use quadrature
use elements
use sparse_tools
use fields
!
use boundary_conditions
use boundary_conditions_from_options
use field_options
use fldebug
use global_parameters, only : FIELD_NAME_LEN, OPTION_PATH_LEN, COLOURING_CG1
use profiler
use spud
use petsc_solve_state_module
use state_module
use upwind_stabilisation
use sparsity_patterns_meshes
use porous_media
use sparse_tools_petsc
use colouring
#ifdef _OPENMP
use omp_lib
#endif
implicit none
private
public :: solve_field_equation_cg, advection_diffusion_cg_check_options
character(len = *), parameter, public :: advdif_cg_m_name = "AdvectionDiffusionCGMatrix"
character(len = *), parameter, public :: advdif_cg_rhs_name = "AdvectionDiffusionCGRHS"
character(len = *), parameter, public :: advdif_cg_delta_t_name = "AdvectionDiffusionCGChange"
character(len = *), parameter, public :: advdif_cg_velocity_name = "AdvectionDiffusionCGVelocity"
! Stabilisation schemes
integer, parameter :: STABILISATION_NONE = 0, &
& STABILISATION_STREAMLINE_UPWIND = 1, STABILISATION_SUPG = 2
! Boundary condition types
integer, parameter :: BC_TYPE_NEUMANN = 1, BC_TYPE_WEAKDIRICHLET = 2, BC_TYPE_INTERNAL = 3, &
BC_TYPE_ROBIN = 4
! Global variables, set by assemble_advection_diffusion_cg for use by
! assemble_advection_diffusion_element_cg and
! assemble_advection_diffusion_face_cg
! Local timestep
real :: local_dt
! Implicitness/explicitness factor * timestep
real :: dt_theta
! Implicitness/explicitness factor
real :: theta
! Conservative/non-conservative discretisation factor
real :: beta
! Stabilisation scheme
integer :: stabilisation_scheme
integer :: nu_bar_scheme
real :: nu_bar_scale
! equation type
integer :: equation_type
! Implicitness/explicitness factor for density
real :: density_theta
! Which terms do we have?
! Mass term?
logical :: have_mass
! Lump mass?
logical :: lump_mass
! Advection?
logical :: have_advection
! Integrate advection by parts?
logical :: integrate_advection_by_parts
! Source?
logical :: have_source
! Add source directly to the right hand side?
logical :: add_src_directly_to_rhs
! Absorption?
logical :: have_absorption
! Diffusivity?
logical :: have_diffusivity
! Isotropic diffusivity?
logical :: isotropic_diffusivity
! Is the mesh moving?
logical :: move_mesh
! Include porosity?
logical :: include_porosity
contains
subroutine solve_field_equation_cg(field_name, state, dt, velocity_name, iterations_taken)
!!< Construct and solve the advection-diffusion equation for the given
!!< field using a continuous Galerkin discretisation. Based on
!!< Advection_Diffusion_DG and Momentum_CG.
character(len = *), intent(in) :: field_name
type(state_type), intent(inout) :: state
real, intent(in) :: dt
character(len = *), optional, intent(in) :: velocity_name
integer, intent(out), optional :: iterations_taken
type(csr_matrix) :: matrix
type(scalar_field) :: delta_t, rhs
type(scalar_field), pointer :: t
ewrite(1, *) "In solve_field_equation_cg"
ewrite(2, *) "Solving advection-diffusion equation for field " // &
& trim(field_name) // " in state " // trim(state%name)
call initialise_advection_diffusion_cg(field_name, t, delta_t, matrix, rhs, state)
call profiler_tic(t, "assembly")
call assemble_advection_diffusion_cg(t, matrix, rhs, state, dt, velocity_name = velocity_name)
call profiler_toc(t, "assembly")
call profiler_tic(t, "solve_total")
call solve_advection_diffusion_cg(t, delta_t, matrix, rhs, state, &
iterations_taken = iterations_taken)
call profiler_toc(t, "solve_total")
call profiler_tic(t, "assembly")
call apply_advection_diffusion_cg_change(t, delta_t, dt)
call finalise_advection_diffusion_cg(delta_t, matrix, rhs)
call profiler_toc(t, "assembly")
ewrite(1, *) "Exiting solve_field_equation_cg"
end subroutine solve_field_equation_cg
subroutine initialise_advection_diffusion_cg(field_name, t, delta_t, matrix, rhs, state)
character(len = *), intent(in) :: field_name
type(scalar_field), pointer :: t
type(scalar_field), intent(out) :: delta_t
type(csr_matrix), intent(out) :: matrix
type(scalar_field), intent(out) :: rhs
type(state_type), intent(inout) :: state
integer :: stat
type(csr_sparsity), pointer :: sparsity
type(scalar_field), pointer :: t_old
t => extract_scalar_field(state, field_name)
if(t%mesh%continuity /= 0) then
FLExit("CG advection-diffusion requires a continuous mesh")
end if
t_old => extract_scalar_field(state, "Old" // field_name, stat = stat)
if(stat == 0) then
assert(t_old%mesh == t%mesh)
! Reset t to value at the beginning of the timestep
call set(t, t_old)
end if
sparsity => get_csr_sparsity_firstorder(state, t%mesh, t%mesh)
call allocate(matrix, sparsity, name = advdif_cg_m_name)
call allocate(rhs, t%mesh, name = advdif_cg_rhs_name)
call allocate(delta_t, t%mesh, name = trim(field_name)//advdif_cg_delta_t_name)
call set_advection_diffusion_cg_initial_guess(delta_t)
end subroutine initialise_advection_diffusion_cg
subroutine finalise_advection_diffusion_cg(delta_t, matrix, rhs)
type(scalar_field), intent(inout) :: delta_t
type(csr_matrix), intent(inout) :: matrix
type(scalar_field), intent(inout) :: rhs
call deallocate(matrix)
call deallocate(rhs)
call deallocate(delta_t)
end subroutine finalise_advection_diffusion_cg
subroutine set_advection_diffusion_cg_initial_guess(delta_t)
type(scalar_field), intent(inout) :: delta_t
call zero(delta_t)
end subroutine set_advection_diffusion_cg_initial_guess
subroutine assemble_advection_diffusion_cg(t, matrix, rhs, state, dt, velocity_name)
type(scalar_field), intent(inout) :: t
type(csr_matrix), intent(inout) :: matrix
type(scalar_field), intent(inout) :: rhs
type(state_type), intent(inout) :: state
real, intent(in) :: dt
character(len = *), optional, intent(in) :: velocity_name
character(len = FIELD_NAME_LEN) :: lvelocity_name
integer :: i, j, stat
integer, dimension(:), allocatable :: t_bc_types
type(scalar_field) :: t_bc, t_bc_2
type(scalar_field), pointer :: absorption, sinking_velocity, source
type(tensor_field), pointer :: diffusivity
type(vector_field) :: velocity
type(vector_field), pointer :: gravity_direction, velocity_ptr, grid_velocity
type(vector_field), pointer :: positions, old_positions, new_positions
type(scalar_field), target :: dummydensity
type(scalar_field), pointer :: density, olddensity
character(len = FIELD_NAME_LEN) :: density_name
type(scalar_field), pointer :: pressure
! Porosity field
type(scalar_field) :: porosity_theta
!! Coloring data structures for OpenMP parallization
type(integer_set), dimension(:), pointer :: colours
integer :: clr, nnid, len, ele
integer :: num_threads, thread_num
!! Did we successfully prepopulate the transform_to_physical_cache?
logical :: cache_valid
type(element_type), dimension(:), allocatable :: supg_element
ewrite(1, *) "In assemble_advection_diffusion_cg"
assert(mesh_dim(rhs) == mesh_dim(t))
assert(ele_count(rhs) == ele_count(t))
if(present(velocity_name)) then
lvelocity_name = velocity_name
else
lvelocity_name = "NonlinearVelocity"
end if
#ifdef _OPENMP
num_threads = omp_get_max_threads()
#else
num_threads = 1
#endif
! Step 1: Pull fields out of state
! Coordinate
positions => extract_vector_field(state, "Coordinate")
ewrite_minmax(positions)
assert(positions%dim == mesh_dim(t))
assert(ele_count(positions) == ele_count(t))
! Velocity
velocity_ptr => extract_vector_field(state, lvelocity_name, stat = stat)
if(stat == 0) then
assert(velocity_ptr%dim == mesh_dim(t))
assert(ele_count(velocity_ptr) == ele_count(t))
ewrite(2, *) "Velocity:"
ewrite_minmax(velocity_ptr)
if (have_option(trim(t%option_path) // &
"/prognostic/spatial_discretisation/continuous_galerkin/advection_terms/only_sinking_velocity")) then
ewrite(2, *) "No advection set for field"
call allocate(velocity, mesh_dim(t), t%mesh, name = advdif_cg_velocity_name)
call zero(velocity)
else
call allocate(velocity, velocity_ptr%dim, velocity_ptr%mesh, name = advdif_cg_velocity_name)
call set(velocity, velocity_ptr)
end if
else
ewrite(2, *) "No velocity"
call allocate(velocity, mesh_dim(t), t%mesh, name = advdif_cg_velocity_name)
call zero(velocity)
end if
! Source
source => extract_scalar_field(state, trim(t%name) // "Source", stat = stat)
have_source = stat == 0
if(have_source) then
assert(mesh_dim(source) == mesh_dim(t))
assert(ele_count(source) == ele_count(t))
add_src_directly_to_rhs = have_option(trim(source%option_path)//'/diagnostic/add_directly_to_rhs')
if (add_src_directly_to_rhs) then
ewrite(2, *) "Adding Source field directly to the right hand side"
assert(node_count(source) == node_count(t))
end if
ewrite_minmax(source)
else
ewrite(2, *) "No source"
add_src_directly_to_rhs = .false.
end if
! Absorption
absorption => extract_scalar_field(state, trim(t%name) // "Absorption", stat = stat)
have_absorption = stat == 0
if(have_absorption) then
assert(mesh_dim(absorption) == mesh_dim(t))
assert(ele_count(absorption) == ele_count(t))
ewrite_minmax(absorption)
else
ewrite(2, *) "No absorption"
end if
! Sinking velocity
sinking_velocity => extract_scalar_field(state, trim(t%name) // "SinkingVelocity", stat = stat)
if(stat == 0) then
ewrite_minmax(sinking_velocity)
gravity_direction => extract_vector_field(state, "GravityDirection")
! this may perform a "remap" internally from CoordinateMesh to VelocitMesh
call addto(velocity, gravity_direction, scale = sinking_velocity)
ewrite_minmax(velocity)
else
ewrite(2, *) "No sinking velocity"
end if
! Diffusivity
diffusivity => extract_tensor_field(state, trim(t%name) // "Diffusivity", stat = stat)
have_diffusivity = stat == 0
if(have_diffusivity) then
assert(all(diffusivity%dim == mesh_dim(t)))
assert(ele_count(diffusivity) == ele_count(t))
isotropic_diffusivity = option_count(complete_field_path(diffusivity%option_path)) &
& == option_count(trim(complete_field_path(diffusivity%option_path)) // "/value/isotropic")
if(isotropic_diffusivity) then
ewrite(2, *) "Isotropic diffusivity"
assert(all(diffusivity%dim > 0))
ewrite_minmax(diffusivity%val(1, 1, :))
else
ewrite_minmax(diffusivity)
end if
else
isotropic_diffusivity = .false.
ewrite(2, *) "No diffusivity"
end if
! Porosity
if (have_option(trim(complete_field_path(t%option_path))//'/porosity')) then
include_porosity = .true.
! get the porosity theta averaged field - this will allocate it
call form_porosity_theta(porosity_theta, state, option_path = trim(complete_field_path(t%option_path))//'/porosity')
else
include_porosity = .false.
call allocate(porosity_theta, t%mesh, field_type=FIELD_TYPE_CONSTANT)
call set(porosity_theta, 1.0)
end if
! Step 2: Pull options out of the options tree
call get_option(trim(t%option_path) // "/prognostic/temporal_discretisation/theta", theta)
assert(theta >= 0.0 .and. theta <= 1.0)
ewrite(2, *) "Theta = ", theta
dt_theta = dt * theta
local_dt = dt
call get_option(trim(t%option_path) // "/prognostic/spatial_discretisation/conservative_advection", beta)
assert(beta >= 0.0 .and. beta <= 1.0)
ewrite(2, *) "Beta = ", beta
have_advection = .not. have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/advection_terms/exclude_advection_terms")
if(have_advection) then
ewrite(2, *) "Including advection"
integrate_advection_by_parts = have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/advection_terms/integrate_advection_by_parts")
if(integrate_advection_by_parts) then
ewrite(2, *) "Integrating advection terms by parts"
end if
else
integrate_advection_by_parts = .false.
ewrite(2, *) "Excluding advection"
end if
have_mass = .not. have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/mass_terms/exclude_mass_terms")
if(have_mass) then
ewrite(2, *) "Including mass"
lump_mass = have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/mass_terms/lump_mass_matrix")
if(lump_mass) then
ewrite(2, *) "Lumping mass"
end if
else
lump_mass = .false.
ewrite(2, *) "Excluding mass"
end if
! are we moving the mesh?
move_mesh = (have_option("/mesh_adaptivity/mesh_movement") .and. have_mass)
if(move_mesh) then
if (include_porosity) then
FLExit('Cannot include porosity in CG advection diffusion of a field with a moving mesh')
end if
ewrite(2,*) "Moving the mesh"
old_positions => extract_vector_field(state, "OldCoordinate")
ewrite_minmax(old_positions)
new_positions => extract_vector_field(state, "IteratedCoordinate")
ewrite_minmax(new_positions)
! Grid velocity
grid_velocity => extract_vector_field(state, "GridVelocity")
assert(grid_velocity%dim == mesh_dim(t))
assert(ele_count(grid_velocity) == ele_count(t))
ewrite(2, *) "Grid velocity:"
ewrite_minmax(grid_velocity)
else
ewrite(2,*) "Not moving the mesh"
end if
allocate(supg_element(num_threads))
if(have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind")) then
ewrite(2, *) "Streamline upwind stabilisation"
stabilisation_scheme = STABILISATION_STREAMLINE_UPWIND
call get_upwind_options(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind", &
& nu_bar_scheme, nu_bar_scale)
if(move_mesh) then
FLExit("Haven't thought about how mesh movement works with stabilisation yet.")
end if
else if(have_option(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind_petrov_galerkin")) then
ewrite(2, *) "SUPG stabilisation"
stabilisation_scheme = STABILISATION_SUPG
call get_upwind_options(trim(t%option_path) // "/prognostic/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind_petrov_galerkin", &
& nu_bar_scheme, nu_bar_scale)
! Note this is not mixed mesh safe (but then nothing really is)
! You need 1 supg_element per thread.
do i = 1, num_threads
supg_element(i)=make_supg_element(ele_shape(t,1))
end do
if(move_mesh) then
FLExit("Haven't thought about how mesh movement works with stabilisation yet.")
end if
else
ewrite(2, *) "No stabilisation"
stabilisation_scheme = STABILISATION_NONE
end if
call allocate(dummydensity, t%mesh, "DummyDensity", field_type=FIELD_TYPE_CONSTANT)
call set(dummydensity, 1.0)
! find out equation type and hence if density is needed or not
equation_type=equation_type_index(trim(t%option_path))
select case(equation_type)
case(FIELD_EQUATION_ADVECTIONDIFFUSION)
ewrite(2,*) "Solving advection-diffusion equation"
! density not needed so use a constant field for assembly
density => dummydensity
olddensity => dummydensity
density_theta = 1.0
pressure => dummydensity
case(FIELD_EQUATION_INTERNALENERGY)
ewrite(2,*) "Solving internal energy equation"
if(move_mesh) then
FLExit("Haven't implemented a moving mesh energy equation yet.")
end if
call get_option(trim(t%option_path)//'/prognostic/equation[0]/density[0]/name', &
density_name)
density=>extract_scalar_field(state, trim(density_name))
ewrite_minmax(density)
olddensity=>extract_scalar_field(state, "Old"//trim(density_name))
ewrite_minmax(olddensity)
call get_option(trim(density%option_path)//"/prognostic/temporal_discretisation/theta", &
density_theta)
pressure=>extract_scalar_field(state, "Pressure")
ewrite_minmax(pressure)
case default
FLExit("Unknown field equation type for cg advection diffusion.")
end select
! Step 3: Assembly
call zero(matrix)
call zero(rhs)
call profiler_tic(t, "advection_diffusion_loop_overhead")
#ifdef _OPENMP
cache_valid = prepopulate_transform_cache(positions)
assert(cache_valid)
#endif
call get_mesh_colouring(state, t%mesh, COLOURING_CG1, colours)
call profiler_toc(t, "advection_diffusion_loop_overhead")
call profiler_tic(t, "advection_diffusion_loop")
!$OMP PARALLEL DEFAULT(SHARED) &
!$OMP PRIVATE(clr, len, nnid, ele, thread_num)
#ifdef _OPENMP
thread_num = omp_get_thread_num()
#else
thread_num=0
#endif
colour_loop: do clr = 1, size(colours)
len = key_count(colours(clr))
!$OMP DO SCHEDULE(STATIC)
element_loop: do nnid = 1, len
ele = fetch(colours(clr), nnid)
call assemble_advection_diffusion_element_cg(ele, t, matrix, rhs, &
positions, old_positions, new_positions, &
velocity, grid_velocity, &
source, absorption, diffusivity, &
density, olddensity, pressure, porosity_theta, &
supg_element(thread_num+1))
end do element_loop
!$OMP END DO
end do colour_loop
!$OMP END PARALLEL
call profiler_toc(t, "advection_diffusion_loop")
! Add the source directly to the rhs if required
! which must be included before dirichlet BC's.
if (add_src_directly_to_rhs) call addto(rhs, source)
! Step 4: Boundary conditions
if( &
& (integrate_advection_by_parts .and. have_advection) &
& .or. have_diffusivity &
& ) then
allocate(t_bc_types(surface_element_count(t)))
call get_entire_boundary_condition(t, &
(/ "neumann ", &
"weakdirichlet", &
"internal ", &
"robin "/), &
t_bc, &
t_bc_types, &
boundary_second_value = t_bc_2)
if(any(t_bc_types /= 0)) then
call ewrite_bc_counts(2, t_bc_types)
end if
do i = 1, surface_element_count(t)
if(t_bc_types(i)==BC_TYPE_INTERNAL) cycle
call assemble_advection_diffusion_face_cg(i, t_bc_types(i), t, t_bc, t_bc_2, &
matrix, rhs, &
positions, velocity, grid_velocity, &
density, olddensity)
end do
call deallocate(t_bc)
call deallocate(t_bc_2)
deallocate(t_bc_types)
end if
ewrite(2, *) "Applying strong Dirichlet boundary conditions"
call apply_dirichlet_conditions(matrix, rhs, t, dt)
ewrite_minmax(rhs)
call deallocate(velocity)
call deallocate(dummydensity)
if (stabilisation_scheme == STABILISATION_SUPG) then
do i = 1, num_threads
call deallocate(supg_element(i))
end do
end if
deallocate(supg_element)
call deallocate(porosity_theta)
ewrite(1, *) "Exiting assemble_advection_diffusion_cg"
end subroutine assemble_advection_diffusion_cg
subroutine ewrite_bc_counts(debug_level, bc_types)
!!< A simple subroutine to count and output the number of elements with
!!< each boundary conditions (combines counts into a single surface
!!< element loop).
integer, intent(in) :: debug_level
integer, dimension(:), intent(in) :: bc_types
integer :: i, nneumann, nweak_dirichlet, ninternal, nrobin
if(debug_level > current_debug_level) return
nneumann = 0
nweak_dirichlet = 0
ninternal = 0
nrobin = 0
do i = 1, size(bc_types)
select case(bc_types(i))
case(BC_TYPE_NEUMANN)
nneumann = nneumann + 1
case(BC_TYPE_WEAKDIRICHLET)
nweak_dirichlet = nweak_dirichlet + 1
case(BC_TYPE_INTERNAL)
ninternal = ninternal + 1
case(BC_TYPE_ROBIN)
nrobin = nrobin + 1
case(0)
case default
! this is a code error
ewrite(-1, *) "For boundary condition type: ", bc_types(i)
FLAbort("Unrecognised boundary condition type")
end select
end do
ewrite(debug_level, *) "Surface elements with Neumann boundary condition: ", nneumann
ewrite(debug_level, *) "Surface elements with weak Dirichlet boundary condition: ", nweak_dirichlet
ewrite(debug_level, *) "Surface elements with internal or periodic boundary condition: ", ninternal
ewrite(debug_level, *) "Surface elements with Robin boundary condition: ", nrobin
end subroutine ewrite_bc_counts
subroutine assemble_advection_diffusion_element_cg(ele, t, matrix, rhs, &
positions, old_positions, new_positions, &
velocity, grid_velocity, &
source, absorption, diffusivity, &
density, olddensity, pressure, porosity_theta, supg_shape)
integer, intent(in) :: ele
type(scalar_field), intent(in) :: t
type(csr_matrix), intent(inout) :: matrix
type(scalar_field), intent(inout) :: rhs
type(vector_field), intent(in) :: positions
type(vector_field), pointer :: old_positions, new_positions
type(vector_field), intent(in) :: velocity
type(vector_field), pointer :: grid_velocity
type(scalar_field), intent(in) :: source
type(scalar_field), intent(in) :: absorption
type(tensor_field), intent(in) :: diffusivity
type(scalar_field), intent(in) :: density
type(scalar_field), intent(in) :: olddensity
type(scalar_field), intent(in) :: pressure
type(scalar_field), intent(in) :: porosity_theta
type(element_type), intent(inout) :: supg_shape
integer, dimension(:), pointer :: element_nodes
real, dimension(ele_ngi(t, ele)) :: detwei, detwei_old, detwei_new
real, dimension(ele_loc(t, ele), ele_ngi(t, ele), mesh_dim(t)) :: dt_t
real, dimension(ele_loc(density, ele), ele_ngi(density, ele), mesh_dim(density)) :: drho_t
real, dimension(ele_loc(velocity, ele), ele_ngi(velocity, ele), mesh_dim(t)) :: du_t
real, dimension(ele_loc(positions, ele), ele_ngi(velocity, ele), mesh_dim(t)) :: dug_t
real, dimension(mesh_dim(t), mesh_dim(t), ele_ngi(t, ele)) :: j_mat
type(element_type) :: test_function
type(element_type), pointer :: t_shape
! 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(ele_loc(t, ele)) :: rhs_addto
real, dimension(ele_loc(t, ele), ele_loc(t, ele)) :: matrix_addto
#ifdef DDEBUG
assert(ele_ngi(positions, ele) == ele_ngi(t, ele))
assert(ele_ngi(velocity, ele) == ele_ngi(t, ele))
if(have_diffusivity) then
assert(ele_ngi(diffusivity, ele) == ele_ngi(t, ele))
end if
if(have_source) then
assert(ele_ngi(source, ele) == ele_ngi(t, ele))
end if
if(have_absorption) then
assert(ele_ngi(absorption, ele) == ele_ngi(t, ele))
end if
if(move_mesh) then
! the following has been assumed in the declarations above
assert(ele_loc(grid_velocity, ele) == ele_loc(positions, ele))
assert(ele_ngi(grid_velocity, ele) == ele_ngi(velocity, ele))
end if
if (include_porosity) then
assert(ele_ngi(porosity_theta, ele) == ele_ngi(t, ele))
end if
#endif
matrix_addto = 0.0
rhs_addto = 0.0
t_shape => ele_shape(t, ele)
! Step 1: Transform
if(.not. have_advection .and. .not. have_diffusivity) then
call transform_to_physical(positions, ele, detwei = detwei)
else if(any(stabilisation_scheme == (/STABILISATION_STREAMLINE_UPWIND, STABILISATION_SUPG/))) then
call transform_to_physical(positions, ele, t_shape, &
& dshape = dt_t, detwei = detwei, j = j_mat)
else
call transform_to_physical(positions, ele, t_shape, &
& dshape = dt_t, detwei = detwei)
end if
if(have_advection.or.(equation_type==FIELD_EQUATION_INTERNALENERGY)) then
call transform_to_physical(positions, ele, &
& ele_shape(velocity, ele), dshape = du_t)
end if
if(have_advection.and.move_mesh.and..not.integrate_advection_by_parts) then
call transform_to_physical(positions, ele, &
& ele_shape(grid_velocity, ele), dshape = dug_t)
end if
if(move_mesh) then
call transform_to_physical(old_positions, ele, detwei=detwei_old)
call transform_to_physical(new_positions, ele, detwei=detwei_new)
end if
if(have_advection.and.(equation_type==FIELD_EQUATION_INTERNALENERGY)) then
if(ele_shape(density, ele)==t_shape) then
drho_t = dt_t
else
call transform_to_physical(positions, ele, &
& ele_shape(density, ele), dshape = drho_t)
end if
end if
! Step 2: Set up test function
select case(stabilisation_scheme)
case(STABILISATION_SUPG)
if(have_diffusivity) then
call supg_test_function(supg_shape, t_shape, dt_t, ele_val_at_quad(velocity, ele), j_mat, diff_q = ele_val_at_quad(diffusivity, ele), &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
else
call supg_test_function(supg_shape, t_shape, dt_t, ele_val_at_quad(velocity, ele), j_mat, &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
end if
test_function = supg_shape
case default
test_function = t_shape
end select
! Important note: with SUPG the test function derivatives have not been
! modified - i.e. dt_t is currently used everywhere. This is fine for P1,
! but is not consistent for P>1.
! Step 3: Assemble contributions
! Mass
if(have_mass) call add_mass_element_cg(ele, test_function, t, density, olddensity, porosity_theta, detwei, detwei_old, detwei_new, matrix_addto, rhs_addto)
! Advection
if(have_advection) call add_advection_element_cg(ele, test_function, t, &
velocity, grid_velocity, diffusivity, &
density, olddensity, &
dt_t, du_t, dug_t, drho_t, detwei, j_mat, matrix_addto, rhs_addto)
! Absorption
if(have_absorption) call add_absorption_element_cg(ele, test_function, t, absorption, detwei, matrix_addto, rhs_addto)
! Diffusivity
if(have_diffusivity) call add_diffusivity_element_cg(ele, t, diffusivity, dt_t, detwei, matrix_addto, rhs_addto)
! Source
if(have_source .and. (.not. add_src_directly_to_rhs)) then
call add_source_element_cg(ele, test_function, t, source, detwei, rhs_addto)
end if
! Pressure
if(equation_type==FIELD_EQUATION_INTERNALENERGY) call add_pressurediv_element_cg(ele, test_function, t, &
velocity, pressure, &
du_t, detwei, rhs_addto)
! Step 4: Insertion
element_nodes => ele_nodes(t, ele)
call addto(matrix, element_nodes, element_nodes, matrix_addto)
call addto(rhs, element_nodes, rhs_addto)
end subroutine assemble_advection_diffusion_element_cg
subroutine add_mass_element_cg(ele, test_function, t, density, olddensity, porosity_theta, detwei, detwei_old, detwei_new, matrix_addto, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: density, olddensity
type(scalar_field), intent(in) :: porosity_theta
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei, detwei_old, detwei_new
real, dimension(ele_loc(t, ele), ele_loc(t, ele)), intent(inout) :: matrix_addto
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
integer :: i
real, dimension(ele_loc(t, ele), ele_loc(t, ele)) :: mass_matrix
real, dimension(ele_ngi(density,ele)) :: density_at_quad
real, dimension(ele_ngi(porosity_theta,ele)) :: porosity_theta_at_quad
assert(have_mass)
if (include_porosity) porosity_theta_at_quad = ele_val_at_quad(porosity_theta, ele)
select case(equation_type)
case(FIELD_EQUATION_INTERNALENERGY)
assert(ele_ngi(density, ele)==ele_ngi(olddensity, ele))
density_at_quad = ele_val_at_quad(olddensity, ele)
if(move_mesh) then
! needs to be evaluated at t+dt
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei_new*density_at_quad)
else
if (include_porosity) then
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei*density_at_quad*porosity_theta_at_quad)
else
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei*density_at_quad)
end if
end if
case default
if(move_mesh) then
! needs to be evaluated at t+dt
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei_new)
else
if (include_porosity) then
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei*porosity_theta_at_quad)
else
mass_matrix = shape_shape(test_function, ele_shape(t, ele), detwei)
end if
end if
end select
if(lump_mass) then
do i = 1, size(matrix_addto, 1)
matrix_addto(i, i) = matrix_addto(i, i) + sum(mass_matrix(i, :))
end do
else
matrix_addto = matrix_addto + mass_matrix
end if
if(move_mesh) then
! In the unaccelerated form we solve:
! /
! | N^{n+1} T^{n+1}/dt - N^{n} T^n/dt + ... = f
! /
! so in accelerated form:
! /
! | N^{n+1} dT + (N^{n+1}- N^{n}) T^n/dt + ... = f
! /
! where dT=(T^{n+1}-T^{n})/dt is the acceleration.
! Put the (N^{n+1}-N^{n}) T^n term on the rhs
mass_matrix = shape_shape(test_function, ele_shape(t, ele), (detwei_new-detwei_old))
if(lump_mass) then
rhs_addto = rhs_addto - sum(mass_matrix, 2)*ele_val(t, ele)/local_dt
else
rhs_addto = rhs_addto - matmul(mass_matrix, ele_val(t, ele))/local_dt
end if
end if
end subroutine add_mass_element_cg
subroutine add_advection_element_cg(ele, test_function, t, &
velocity, grid_velocity, diffusivity, &
density, olddensity, &
dt_t, du_t, dug_t, drho_t, detwei, j_mat, matrix_addto, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(scalar_field), intent(in) :: t
type(vector_field), intent(in) :: velocity
type(vector_field), pointer :: grid_velocity
type(tensor_field), intent(in) :: diffusivity
type(scalar_field), intent(in) :: density, olddensity
real, dimension(ele_loc(t, ele), ele_ngi(t, ele), mesh_dim(t)), intent(in) :: dt_t
real, dimension(ele_loc(velocity, ele), ele_ngi(velocity, ele), mesh_dim(t)) :: du_t
real, dimension(:, :, :) :: dug_t
real, dimension(ele_loc(density, ele), ele_ngi(density, ele), mesh_dim(density)), intent(in) :: drho_t
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei
real, dimension(mesh_dim(t), mesh_dim(t), ele_ngi(t, ele)), intent(in) :: j_mat
real, dimension(ele_loc(t, ele), ele_loc(t, ele)), intent(inout) :: matrix_addto
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
real, dimension(ele_loc(t, ele), ele_loc(t,ele)) :: advection_mat
real, dimension(velocity%dim, ele_ngi(velocity, ele)) :: velocity_at_quad
real, dimension(ele_ngi(velocity, ele)) :: velocity_div_at_quad
type(element_type), pointer :: t_shape
real, dimension(ele_ngi(density, ele)) :: density_at_quad
real, dimension(velocity%dim, ele_ngi(density, ele)) :: densitygrad_at_quad
real, dimension(ele_ngi(density, ele)) :: udotgradrho_at_quad
assert(have_advection)
t_shape => ele_shape(t, ele)
velocity_at_quad = ele_val_at_quad(velocity, ele)
if(move_mesh) then
velocity_at_quad = velocity_at_quad - ele_val_at_quad(grid_velocity, ele)
end if
select case(equation_type)
case(FIELD_EQUATION_INTERNALENERGY)
assert(ele_ngi(density, ele)==ele_ngi(olddensity, ele))
density_at_quad = density_theta*ele_val_at_quad(density, ele)&
+(1.-density_theta)*ele_val_at_quad(olddensity, ele)
densitygrad_at_quad = density_theta*ele_grad_at_quad(density, ele, drho_t) &
+(1.-density_theta)*ele_grad_at_quad(olddensity, ele, drho_t)
udotgradrho_at_quad = sum(densitygrad_at_quad*velocity_at_quad, 1)
end select
if(integrate_advection_by_parts) then
! element advection matrix
! / /
! - | (grad N_A dot nu) N_B dV - (1. - beta) | N_A ( div nu ) N_B dV
! / /
select case(equation_type)
case(FIELD_EQUATION_INTERNALENERGY)
advection_mat = -dshape_dot_vector_shape(dt_t, velocity_at_quad, t_shape, detwei*density_at_quad)
if(abs(1.0 - beta) > epsilon(0.0)) then
velocity_div_at_quad = ele_div_at_quad(velocity, ele, du_t)
advection_mat = advection_mat &
- (1.0-beta) * shape_shape(test_function, t_shape, (velocity_div_at_quad*density_at_quad &
+udotgradrho_at_quad)* detwei)
end if
case default
advection_mat = -dshape_dot_vector_shape(dt_t, velocity_at_quad, t_shape, detwei)
if(abs(1.0 - beta) > epsilon(0.0)) then
velocity_div_at_quad = ele_div_at_quad(velocity, ele, du_t)
advection_mat = advection_mat &
- (1.0-beta)*shape_shape(test_function, t_shape, velocity_div_at_quad*detwei)
end if
end select
else
! element advection matrix
! / /
! | N_A (nu dot grad N_B) dV + beta | N_A ( div nu ) N_B dV
! / /
select case(equation_type)
case(FIELD_EQUATION_INTERNALENERGY)
advection_mat = shape_vector_dot_dshape(test_function, velocity_at_quad, dt_t, detwei*density_at_quad)
if(abs(beta) > epsilon(0.0)) then
velocity_div_at_quad = ele_div_at_quad(velocity, ele, du_t)
advection_mat = advection_mat &
+ beta*shape_shape(test_function, t_shape, (velocity_div_at_quad*density_at_quad &
+udotgradrho_at_quad)*detwei)
end if
case default
advection_mat = shape_vector_dot_dshape(test_function, velocity_at_quad, dt_t, detwei)
if(abs(beta) > epsilon(0.0)) then
velocity_div_at_quad = ele_div_at_quad(velocity, ele, du_t)
advection_mat = advection_mat &
+ beta*shape_shape(test_function, t_shape, velocity_div_at_quad*detwei)
end if
if(move_mesh) then
advection_mat = advection_mat &
- shape_shape(test_function, t_shape, ele_div_at_quad(grid_velocity, ele, dug_t)*detwei)
end if
end select
end if
! Stabilisation
select case(stabilisation_scheme)
case(STABILISATION_STREAMLINE_UPWIND)
if(have_diffusivity) then
advection_mat = advection_mat + &
& element_upwind_stabilisation(t_shape, dt_t, velocity_at_quad, j_mat, detwei, &
& diff_q = ele_val_at_quad(diffusivity, ele), nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
else
advection_mat = advection_mat + &
& element_upwind_stabilisation(t_shape, dt_t, velocity_at_quad, j_mat, detwei, &
& nu_bar_scheme = nu_bar_scheme, nu_bar_scale = nu_bar_scale)
end if
case default
end select
if(abs(dt_theta) > epsilon(0.0)) then
matrix_addto = matrix_addto + dt_theta * advection_mat
end if
rhs_addto = rhs_addto - matmul(advection_mat, ele_val(t, ele))
end subroutine add_advection_element_cg
subroutine add_source_element_cg(ele, test_function, t, source, detwei, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: source
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
assert(have_source)
rhs_addto = rhs_addto + shape_rhs(test_function, detwei * ele_val_at_quad(source, ele))
end subroutine add_source_element_cg
subroutine add_absorption_element_cg(ele, test_function, t, absorption, detwei, matrix_addto, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: absorption
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei
real, dimension(ele_loc(t, ele), ele_loc(t, ele)), intent(inout) :: matrix_addto
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
real, dimension(ele_loc(t, ele), ele_loc(t, ele)) :: absorption_mat
assert(have_absorption)
absorption_mat = shape_shape(test_function, ele_shape(t, ele), detwei * ele_val_at_quad(absorption, ele))
if(abs(dt_theta) > epsilon(0.0)) matrix_addto = matrix_addto + dt_theta * absorption_mat
rhs_addto = rhs_addto - matmul(absorption_mat, ele_val(t, ele))
end subroutine add_absorption_element_cg
subroutine add_diffusivity_element_cg(ele, t, diffusivity, dt_t, detwei, matrix_addto, rhs_addto)
integer, intent(in) :: ele
type(scalar_field), intent(in) :: t
type(tensor_field), intent(in) :: diffusivity
real, dimension(ele_loc(t, ele), ele_ngi(t, ele), mesh_dim(t)), intent(in) :: dt_t
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei
real, dimension(ele_loc(t, ele), ele_loc(t, ele)), intent(inout) :: matrix_addto
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
real, dimension(diffusivity%dim(1), diffusivity%dim(2), ele_ngi(diffusivity, ele)) :: diffusivity_gi
real, dimension(ele_loc(t, ele), ele_loc(t, ele)) :: diffusivity_mat
assert(have_diffusivity)
diffusivity_gi = ele_val_at_quad(diffusivity, ele)
if(isotropic_diffusivity) then
assert(size(diffusivity_gi, 1) > 0)
diffusivity_mat = dshape_dot_dshape(dt_t, dt_t, detwei * diffusivity_gi(1, 1, :))
else
diffusivity_mat = dshape_tensor_dshape(dt_t, diffusivity_gi, dt_t, detwei)
end if
if(abs(dt_theta) > epsilon(0.0)) matrix_addto = matrix_addto + dt_theta * diffusivity_mat
rhs_addto = rhs_addto - matmul(diffusivity_mat, ele_val(t, ele))
end subroutine add_diffusivity_element_cg
subroutine add_pressurediv_element_cg(ele, test_function, t, velocity, pressure, du_t, detwei, rhs_addto)
integer, intent(in) :: ele
type(element_type), intent(in) :: test_function
type(scalar_field), intent(in) :: t
type(vector_field), intent(in) :: velocity
type(scalar_field), intent(in) :: pressure
real, dimension(ele_loc(velocity, ele), ele_ngi(velocity, ele), mesh_dim(t)) :: du_t
real, dimension(ele_ngi(t, ele)), intent(in) :: detwei
real, dimension(ele_loc(t, ele)), intent(inout) :: rhs_addto
assert(equation_type==FIELD_EQUATION_INTERNALENERGY)
assert(ele_ngi(pressure, ele)==ele_ngi(t, ele))
rhs_addto = rhs_addto - &
shape_rhs(test_function, ele_div_at_quad(velocity, ele, du_t) * ele_val_at_quad(pressure, ele) * detwei)
end subroutine add_pressurediv_element_cg
subroutine assemble_advection_diffusion_face_cg(face, bc_type, t, t_bc, t_bc_2, matrix, rhs, positions, velocity, grid_velocity, density, olddensity)
integer, intent(in) :: face
integer, intent(in) :: bc_type
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: t_bc
type(scalar_field), intent(in) :: t_bc_2
type(csr_matrix), intent(inout) :: matrix
type(scalar_field), intent(inout) :: rhs
type(vector_field), intent(in) :: positions
type(vector_field), intent(in) :: velocity
type(vector_field), pointer :: grid_velocity
type(scalar_field), intent(in) :: density
type(scalar_field), intent(in) :: olddensity
integer, dimension(face_loc(t, face)) :: face_nodes
real, dimension(face_ngi(t, face)) :: detwei
real, dimension(mesh_dim(t), face_ngi(t, face)) :: normal
! 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(face_loc(t, face)) :: rhs_addto
real, dimension(face_loc(t, face), face_loc(t, face)) :: matrix_addto
assert(any(bc_type == (/0, BC_TYPE_NEUMANN, BC_TYPE_WEAKDIRICHLET, BC_TYPE_ROBIN/)))
assert(face_ngi(positions, face) == face_ngi(t, face))
assert(face_ngi(velocity, face) == face_ngi(t, face))
matrix_addto = 0.0
rhs_addto = 0.0
! Step 1: Transform
if(have_advection .and. integrate_advection_by_parts) then
call transform_facet_to_physical(positions, face, &
& detwei_f = detwei, normal = normal)
else if(have_diffusivity.and.((bc_type == BC_TYPE_NEUMANN).or.(bc_type == BC_TYPE_ROBIN))) then
call transform_facet_to_physical(positions, face, &
& detwei_f = detwei)
end if
! Note that with SUPG the surface element test function is not modified
! Step 2: Assemble contributions
! Advection
if(have_advection .and. integrate_advection_by_parts) &
call add_advection_face_cg(face, bc_type, t, t_bc, velocity, grid_velocity, density, olddensity, detwei, normal, matrix_addto, rhs_addto)
! Diffusivity
if(have_diffusivity) call add_diffusivity_face_cg(face, bc_type, t, t_bc, t_bc_2, detwei, matrix_addto, rhs_addto)
! Step 3: Insertion
face_nodes = face_global_nodes(t, face)
call addto(matrix, face_nodes, face_nodes, matrix_addto)
call addto(rhs, face_nodes, rhs_addto)
end subroutine assemble_advection_diffusion_face_cg
subroutine add_advection_face_cg(face, bc_type, t, t_bc, velocity, grid_velocity, density, olddensity, detwei, normal, matrix_addto, rhs_addto)
integer, intent(in) :: face
integer, intent(in) :: bc_type
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: t_bc
type(vector_field), intent(in) :: velocity
type(vector_field), pointer :: grid_velocity
type(scalar_field), intent(in) :: density
type(scalar_field), intent(in) :: olddensity
real, dimension(face_ngi(t, face)), intent(in) :: detwei
real, dimension(mesh_dim(t), face_ngi(t, face)), intent(in) :: normal
real, dimension(face_loc(t, face), face_loc(t, face)), intent(inout) :: matrix_addto
real, dimension(face_loc(t, face)), intent(inout) :: rhs_addto
real, dimension(velocity%dim, face_ngi(velocity, face)) :: velocity_at_quad
real, dimension(face_loc(t, face), face_loc(t,face)) :: advection_mat
type(element_type), pointer :: t_shape
real, dimension(face_ngi(density, face)) :: density_at_quad
assert(have_advection)
assert(integrate_advection_by_parts)
t_shape => face_shape(t, face)
velocity_at_quad = face_val_at_quad(velocity, face)
if(move_mesh) then
velocity_at_quad = velocity_at_quad - face_val_at_quad(grid_velocity, face)
end if
select case(equation_type)
case(FIELD_EQUATION_INTERNALENERGY)
density_at_quad = density_theta*face_val_at_quad(density, face) &
+(1.0-density_theta)*face_val_at_quad(olddensity, face)
advection_mat = shape_shape(t_shape, t_shape, detwei * sum(velocity_at_quad * normal, 1) * density_at_quad)
case default
advection_mat = shape_shape(t_shape, t_shape, detwei * sum(velocity_at_quad * normal, 1))
end select
if(abs(dt_theta) > epsilon(0.0)) then
if(bc_type == BC_TYPE_WEAKDIRICHLET) then
rhs_addto = rhs_addto - theta * matmul(advection_mat, ele_val(t_bc, face) - face_val(t, face))
else
matrix_addto = matrix_addto + dt_theta * advection_mat
end if
end if
rhs_addto = rhs_addto - matmul(advection_mat, face_val(t, face))
end subroutine add_advection_face_cg
subroutine add_diffusivity_face_cg(face, bc_type, t, t_bc, t_bc_2, detwei, matrix_addto, rhs_addto)
integer, intent(in) :: face
integer, intent(in) :: bc_type
type(scalar_field), intent(in) :: t
type(scalar_field), intent(in) :: t_bc
type(scalar_field), intent(in) :: t_bc_2
real, dimension(face_ngi(t, face)), intent(in) :: detwei
real, dimension(face_loc(t, face), face_loc(t, face)), intent(inout) :: matrix_addto
real, dimension(face_loc(t, face)), intent(inout) :: rhs_addto
real, dimension(face_loc(t, face), face_loc(t,face)) :: robin_mat
type(element_type), pointer :: t_shape
assert(have_diffusivity)
t_shape => face_shape(t, face)
if(bc_type == BC_TYPE_NEUMANN) then
rhs_addto = rhs_addto + shape_rhs(t_shape, detwei * ele_val_at_quad(t_bc, face))
else if(bc_type == BC_TYPE_ROBIN) then
rhs_addto = rhs_addto + shape_rhs(t_shape, detwei * ele_val_at_quad(t_bc, face))
robin_mat = shape_shape(t_shape, t_shape, detwei * ele_val_at_quad(t_bc_2, face))
if (abs(dt_theta) > epsilon(0.0)) then
matrix_addto = matrix_addto + dt_theta * robin_mat
end if
! this next term is due to solving the acceleration form of the equation
rhs_addto = rhs_addto - matmul(robin_mat, face_val(t, face))
else if(bc_type == BC_TYPE_WEAKDIRICHLET) then
! Need to add stuff here once transform_to_physical can supply gradients
! on faces to ensure that weak bcs work
FLExit("Weak Dirichlet boundary conditions with diffusivity are not supported by CG advection-diffusion")
end if
end subroutine add_diffusivity_face_cg
subroutine solve_advection_diffusion_cg(t, delta_t, matrix, rhs, state, iterations_taken)
type(scalar_field), intent(in) :: t
type(scalar_field), intent(inout) :: delta_t
type(csr_matrix), intent(in) :: matrix
type(scalar_field), intent(in) :: rhs
type(state_type), intent(in) :: state
integer, intent(out), optional :: iterations_taken
call petsc_solve(delta_t, matrix, rhs, state, option_path = t%option_path, &
iterations_taken = iterations_taken, &
local_assembly=.true.)
ewrite_minmax(delta_t)
end subroutine solve_advection_diffusion_cg
subroutine apply_advection_diffusion_cg_change(t, delta_t, dt)
type(scalar_field), intent(inout) :: t
type(scalar_field), intent(in) :: delta_t
real, intent(in) :: dt
ewrite_minmax(t)
call addto(t, delta_t, dt)
ewrite_minmax(t)
end subroutine apply_advection_diffusion_cg_change
subroutine advection_diffusion_cg_check_options
!!< Check CG advection-diffusion specific options
character(len = FIELD_NAME_LEN) :: field_name, state_name
character(len = OPTION_PATH_LEN) :: path
integer :: i, j, stat
real :: beta, l_theta
if(option_count("/material_phase/scalar_field/prognostic/spatial_discretisation/continuous_galerkin") == 0) then
! Nothing to check
return
end if
ewrite(2, *) "Checking CG advection-diffusion options"
if(option_count("/material_phase/scalar_field::" // advdif_cg_rhs_name) > 0) then
FLExit("The scalar field name " // advdif_cg_rhs_name // " is reserved")
end if
if(option_count("/material_phase/scalar_field::" // advdif_cg_delta_t_name) > 0) then
FLExit("The scalar field name " // advdif_cg_delta_t_name // " is reserved")
end if
do i = 0, option_count("/material_phase") - 1
path = "/material_phase[" // int2str(i) // "]"
call get_option(trim(path) // "/name", state_name)
do j = 0, option_count(trim(path) // "/scalar_field") - 1
path = "/material_phase[" // int2str(i) // "]/scalar_field[" // int2str(j) // "]"
call get_option(trim(path) // "/name", field_name)
if(field_name /= "Pressure") then
path = trim(path) // "/prognostic"
if(have_option(trim(path) // "/spatial_discretisation/continuous_galerkin").and.&
have_option(trim(path) // "/equation[0]")) then
call get_option(trim(path) // "/spatial_discretisation/conservative_advection", beta, stat)
if(stat == SPUD_NO_ERROR) then
if(beta < 0.0 .or. beta > 1.0) then
call field_error(state_name, field_name, &
& "Conservative advection factor (beta) must be >= 0.0 and <= 1.0")
end if
else
call field_error(state_name, field_name, &
& "Conservative advection factor (beta) required")
end if
call get_option(trim(path) // "/temporal_discretisation/theta", l_theta, stat)
if(stat == SPUD_NO_ERROR) then
if(l_theta < 0. .or. l_theta > 1.0) then
call field_error(state_name, field_name, &
&"Implicitness factor (theta) must be >= 0.0 and <= 1.0")
end if
else
call field_error(state_name, field_name, &
& "Implicitness factor (theta) required")
end if
if(have_option(trim(path) // "/spatial_discretisation/continuous_galerkin/mass_terms/exclude_mass_terms") .and. &
& abs(l_theta - 1.0) > epsilon(0.0)) then
call field_warning(state_name, field_name, &
& "Implicitness factor (theta) should = 1.0 when excluding mass")
end if
if(have_option(trim(path) // "/spatial_discretisation/continuous_galerkin/stabilisation/streamline_upwind_petrov_galerkin") .and. &
& have_option(trim(path) // "/spatial_discretisation/continuous_galerkin/advection_terms/integrate_advection_by_parts")) then
call field_warning(state_name, field_name, &
& "SUPG stabilisation should only be used with advection not integrated by parts")
end if
if(option_count(trim(path) // "/boundary_conditions/type::dirichlet/apply_weakly") > 0 &
& .and. have_option(trim(path) // "/tensor_field::Diffusivity")) then
call field_error(state_name, field_name, &
& "Weak Dirichlet boundary conditions with diffusivity are not supported by CG advection-diffusion")
end if
if(have_option(trim(path) // "/spatial_discretisation/continuous_galerkin/advection_terms/exclude_advection_terms")) then
if(have_option(trim(path) // "/scalar_field::SinkingVelocity")) then
call field_warning(state_name, field_name, &
& "SinkingVelocity set, but advection terms have been excluded - SinkingVelocity will have no effect")
end if
end if
if(option_count(trim(path) // "/boundary_conditions/type::neumann") > 0 &
& .and. .not. (have_option(trim(path) // "/tensor_field::Diffusivity") &
& .or. have_option(trim(path) // "/subgridscale_parameterisation::k-epsilon") &
& .or. have_option(trim(path) // "/subgridscale_parameterisation::GLS"))) then
call field_warning(state_name, field_name, &
& "Neumann boundary condition set, but have no diffusivity - boundary condition will not be applied")
end if
end if
end if
end do
end do
ewrite(2, *) "Finished checking CG advection-diffusion options"
contains
subroutine field_warning(state_name, field_name, msg)
character(len = *), intent(in) :: state_name
character(len = *), intent(in) :: field_name
character(len = *), intent(in) :: msg
ewrite(0, *) "Warning: For field " // trim(field_name) // " in state " // trim(state_name)
ewrite(0, *) trim(msg)
end subroutine field_warning
subroutine field_error(state_name, field_name, msg)
character(len = *), intent(in) :: state_name
character(len = *), intent(in) :: field_name
character(len = *), intent(in) :: msg
ewrite(-1, *) "For field " // trim(field_name) // " in state " // trim(state_name)
FLExit(trim(msg))
end subroutine field_error
end subroutine advection_diffusion_cg_check_options
end module advection_diffusion_cg
|