MFC
Exascale flow solver
Loading...
Searching...
No Matches
m_helper.fpp.f90
Go to the documentation of this file.
1# 1 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
2# 1 "/home/runner/work/MFC/MFC/src/common/include/case.fpp" 1
3! This file exists so that Fypp can be run without generating case.fpp files for
4! each target. This is useful when generating documentation, for example. This
5! should also let MFC be built with CMake directly, without invoking mfc.sh.
6
7! For pre-process.
8# 8 "/home/runner/work/MFC/MFC/src/common/include/case.fpp"
9
10! For moving immersed boundaries in simulation
11# 12 "/home/runner/work/MFC/MFC/src/common/include/case.fpp"
12# 2 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp" 2
13# 1 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp" 1
14# 1 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp" 1
15# 1 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 1
16# 2 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
17# 3 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
18# 4 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
19# 5 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
20# 6 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
21
22# 8 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
23# 9 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
24# 10 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
25
26# 12 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
27# 1 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp" 1
28! Default for Fypp runs outside the toolchain (e.g. documentation). Searched last, so the
29! build/include/<target>/thermochem.fpp the toolchain writes from m_thermochem takes precedence.
30# 4 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
31# 5 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
32# 13 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 2
33
34# 16 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
35# 17 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
36
37# 24 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
38
39# 53 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
40
41# 65 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
42
43# 75 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
44
45# 105 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
46
47# 117 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
48
49# 127 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
50
51# 174 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
52! New line at end of file is required for FYPP
53# 2 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp" 2
54# 1 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp" 1
55# 1 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 1
56# 2 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
57# 3 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
58# 4 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
59# 5 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
60# 6 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
61
62# 8 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
63# 9 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
64# 10 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
65
66# 12 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
67# 1 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp" 1
68! Default for Fypp runs outside the toolchain (e.g. documentation). Searched last, so the
69! build/include/<target>/thermochem.fpp the toolchain writes from m_thermochem takes precedence.
70# 4 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
71# 5 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
72# 13 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 2
73
74# 16 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
75# 17 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
76
77# 24 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
78
79# 53 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
80
81# 65 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
82
83# 75 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
84
85# 105 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
86
87# 117 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
88
89# 127 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
90
91# 174 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
92! New line at end of file is required for FYPP
93# 2 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp" 2
94
95# 4 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
96# 5 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
97# 6 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
98# 7 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
99# 8 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
100
101# 20 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
102
103# 49 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
104
105# 54 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
106
107# 59 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
108
109# 64 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
110
111# 69 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
112
113# 74 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
114
115# 87 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
116
117# 101 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
118
119# 106 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
120
121# 111 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
122
123# 116 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
124
125# 121 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
126
127# 126 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
128
129# 131 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
130
131# 136 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
132
133# 141 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
134
135# 171 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
136
137# 231 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
138
139# 245 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
140
141# 270 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
142
143# 281 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
144
145# 283 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
146# 294 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
147
148# 343 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
149
150# 353 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
151
152# 363 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
153
154# 372 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
155
156# 389 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
157
158# 399 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
159
160# 406 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
161
162# 412 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
163
164# 418 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
165
166# 424 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
167
168# 430 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
169
170# 436 "/home/runner/work/MFC/MFC/src/common/include/omp_macros.fpp"
171! New line at end of file is required for FYPP
172# 3 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp" 2
173# 1 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp" 1
174# 1 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 1
175# 2 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
176# 3 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
177# 4 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
178# 5 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
179# 6 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
180
181# 8 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
182# 9 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
183# 10 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
184
185# 12 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
186# 1 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp" 1
187! Default for Fypp runs outside the toolchain (e.g. documentation). Searched last, so the
188! build/include/<target>/thermochem.fpp the toolchain writes from m_thermochem takes precedence.
189# 4 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
190# 5 "/home/runner/work/MFC/MFC/src/common/include/defaults/thermochem.fpp"
191# 13 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp" 2
192
193# 16 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
194# 17 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
195
196# 24 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
197
198# 53 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
199
200# 65 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
201
202# 75 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
203
204# 105 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
205
206# 117 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
207
208# 127 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
209
210# 174 "/home/runner/work/MFC/MFC/src/common/include/shared_parallel_macros.fpp"
211! New line at end of file is required for FYPP
212# 2 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp" 2
213
214# 7 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
215
216# 17 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
217
218# 22 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
219
220# 27 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
221
222# 32 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
223
224# 37 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
225
226# 42 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
227
228# 47 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
229
230# 52 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
231
232# 57 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
233
234# 62 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
235
236# 73 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
237
238# 78 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
239
240# 83 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
241
242# 88 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
243
244# 103 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
245
246# 131 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
247
248# 161 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
249
250# 176 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
251
252# 194 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
253
254# 216 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
255
256# 245 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
257
258# 260 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
259
260# 270 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
261
262# 279 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
263
264# 295 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
265
266# 305 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
267
268# 312 "/home/runner/work/MFC/MFC/src/common/include/acc_macros.fpp"
269! New line at end of file is required for FYPP
270# 4 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp" 2
271
272! GPU parallel region (scalar reductions, maxval/minval)
273# 23 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
274
275! GPU parallel loop over threads (most common GPU macro)
276# 44 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
277
278! Required closing for GPU_PARALLEL_LOOP
279# 56 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
280
281! Mark routine for device compilation
282# 113 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
283
284! Declare device-resident data
285# 131 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
286
287! Inner loop within a GPU parallel region
288# 146 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
289
290! Scoped GPU data region
291# 165 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
292
293! Host code with device pointers (for MPI with GPU buffers)
294# 191 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
295
296! Allocate device memory (unscoped)
297# 205 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
298
299! Free device memory
300# 217 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
301
302! Atomic operation on device
303# 229 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
304
305! End atomic capture block
306# 240 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
307
308! Copy data between host and device
309# 252 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
310
311! Synchronization barrier
312# 264 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
313
314! Import GPU library module (openacc or omp_lib)
315# 273 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
316
317! Emit code only for AMD compiler
318# 280 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
319
320! Emit code for non-Cray compilers
321# 287 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
322
323! Emit code only for Cray compiler
324# 294 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
325
326! Cray compiler directive, emitted from Fypp so the formatter cannot turn it into a comment
327# 301 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
328
329! Emit code for non-NVIDIA compilers
330# 308 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
331
332# 310 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
333# 311 "/home/runner/work/MFC/MFC/src/common/include/parallel_macros.fpp"
334! New line at end of file is required for FYPP
335# 2 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp" 2
336
337# 14 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
338
339! Caution: This macro requires the use of a binding script to set CUDA_VISIBLE_DEVICES, such that we have one GPU device per MPI
340! rank. That's because for both cudaMemAdvise (preferred location) and cudaMemPrefetchAsync we use location = device_id = 0. For an
341! example see misc/nvidia_uvm/bind.sh.
342# 52 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
343
344! Allocate and create GPU device memory
345# 72 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
346
347! Free GPU device memory and deallocate
348# 80 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
349
350! Cray-specific GPU pointer setup for vector fields
351# 104 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
352
353! Cray-specific GPU pointer setup for scalar fields
354# 120 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
355
356! Cray-specific GPU pointer teardown for scalar fields - exact inverse of ACC_SETUP_SFs. Removes the
357! present-table entries ACC_SETUP_SFs added (the scalar_field descriptor and its %sf copyin). REQUIRED when
358! an ACC_SETUP'd field is freed MID-RUN (e.g. AMR slot free on regrid/restart): Cray 'exit data delete'
359! decrements the reference counter, so the lone @:DEALLOCATE(arg%sf) only undoes the @:ALLOCATE create ref
360! and leaves the descriptor + the ACC_SETUP %sf copyin dangling. Call BEFORE @:DEALLOCATE(arg%sf).
361# 140 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
362
363! Cray-specific GPU pointer setup for acoustic source spatials
364# 165 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
365
366! Whether stress index idx is a shear component. Spelled out because NVHPC 26.9 at -O2 vectorizes any(idx == shear_indices)
367! inside a loop to always true, which doubled the normal-stress elastic energy.
368# 171 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
369
370# 177 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
371
372# 184 "/home/runner/work/MFC/MFC/src/common/include/macros.fpp"
373! New line at end of file is required for FYPP
374# 3 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp" 2
375
376!>
377!! @file
378!! @brief Contains module m_helper
379
380!> @brief Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions
382
387 use ieee_arithmetic !< for checking nan
388
389 implicit none
390
391 private
397
398contains
399
400 !> Computes the bubble number density n from the primitive variables
401 subroutine s_comp_n_from_prim(vftmp, Rtmp, ntmp, weights)
402
403
404# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
405#if MFC_OpenACC
406# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
407!$acc routine seq
408# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
409#elif MFC_OpenMP
410# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
411
412# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
413
414# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
415!$omp declare target device_type(any)
416# 31 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
417#endif
418# 32 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
419 real(wp), intent(in) :: vftmp
420 real(wp), dimension(nb), intent(in) :: rtmp
421 real(wp), intent(out) :: ntmp
422 real(wp), dimension(nb), intent(in) :: weights
423 real(wp) :: r3
424
425 r3 = dot_product(weights, rtmp**3._wp)
426 ntmp = (3._wp/(4._wp*pi))*vftmp/r3
427
428 end subroutine s_comp_n_from_prim
429
430 !> Compute the bubble number density from the conservative void fraction and weighted bubble radii.
431 subroutine s_comp_n_from_cons(vftmp, nRtmp, ntmp, weights)
432
433
434# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
435#if MFC_OpenACC
436# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
437!$acc routine seq
438# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
439#elif MFC_OpenMP
440# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
441
442# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
443
444# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
445!$omp declare target device_type(any)
446# 46 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
447#endif
448# 47 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
449 real(wp), intent(in) :: vftmp
450 real(wp), dimension(nb), intent(in) :: nrtmp
451 real(wp), intent(out) :: ntmp
452 real(wp), dimension(nb), intent(in) :: weights
453 real(wp) :: nr3
454
455 nr3 = dot_product(weights, nrtmp**3._wp)
456 ntmp = sqrt((4._wp*pi/3._wp)*nr3/vftmp)
457
458 end subroutine s_comp_n_from_cons
459
460 !> Print a 2D real array to standard output, optionally dividing each element by a given scalar.
461 impure subroutine s_print_2d_array(A, div)
462
463 real(wp), dimension(:,:), intent(in) :: a
464 real(wp), optional, intent(in) :: div
465 integer :: i, j
466 integer :: local_m, local_n
467 real(wp) :: c
468
469 local_m = size(a, 1)
470 local_n = size(a, 2)
471
472 if (present(div)) then
473 c = div
474 else
475 c = 1._wp
476 end if
477
478 print *, local_m, local_n
479
480 do i = 1, local_m
481 do j = 1, local_n
482 write (*, fmt="(F12.4)", advance="no") a(i, j)/c
483 end do
484 write (*, fmt="(A1)") " "
485 end do
486 write (*, fmt="(A1)") " "
487
488 end subroutine s_print_2d_array
489
490 !> Initialize bubble model arrays for Euler or Lagrangian bubbles with polytropic or non-polytropic gas.
491 impure subroutine s_initialize_bubbles_model()
492
493 ! Allocate memory
494 if (bubbles_euler) then
495#ifdef MFC_DEBUG
496# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
497 block
498# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
499 use iso_fortran_env, only: output_unit
500# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
501
502# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
503 print *, 'm_helper.fpp:93: ', '@:ALLOCATE(weight(nb), R0(nb))'
504# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
505
506# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
507 call flush (output_unit)
508# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
509 end block
510# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
511#endif
512# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
513 allocate (weight(nb), r0(nb))
514# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
515
516# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
517
518# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
519
520# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
521#if defined(MFC_OpenACC)
522# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
523!$acc enter data create(weight, R0)
524# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
525#elif defined(MFC_OpenMP)
526# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
527!$omp target enter data map(always,alloc:weight, R0)
528# 93 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
529#endif
530# 94 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
531 if (.not. polytropic) then
532#ifdef MFC_DEBUG
533# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
534 block
535# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
536 use iso_fortran_env, only: output_unit
537# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
538
539# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
540 print *, 'm_helper.fpp:95: ', '@:ALLOCATE(pb0(nb), Pe_T(nb), k_g(nb), k_v(nb), mass_g0(nb), mass_v0(nb))'
541# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
542
543# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
544 call flush (output_unit)
545# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
546 end block
547# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
548#endif
549# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
550 allocate (pb0(nb), pe_t(nb), k_g(nb), k_v(nb), mass_g0(nb), mass_v0(nb))
551# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
552
553# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
554
555# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
556
557# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
558
559# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
560
561# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
562
563# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
564
565# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
566#if defined(MFC_OpenACC)
567# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
568!$acc enter data create(pb0, Pe_T, k_g, k_v, mass_g0, mass_v0)
569# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
570#elif defined(MFC_OpenMP)
571# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
572!$omp target enter data map(always,alloc:pb0, Pe_T, k_g, k_v, mass_g0, mass_v0)
573# 95 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
574#endif
575# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
576#ifdef MFC_DEBUG
577# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
578 block
579# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
580 use iso_fortran_env, only: output_unit
581# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
582
583# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
584 print *, 'm_helper.fpp:96: ', '@:ALLOCATE(Re_trans_T(nb), Re_trans_c(nb), Im_trans_T(nb), Im_trans_c(nb))'
585# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
586
587# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
588 call flush (output_unit)
589# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
590 end block
591# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
592#endif
593# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
594 allocate (re_trans_t(nb), re_trans_c(nb), im_trans_t(nb), im_trans_c(nb))
595# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
596
597# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
598
599# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
600
601# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
602
603# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
604
605# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
606#if defined(MFC_OpenACC)
607# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
608!$acc enter data create(Re_trans_T, Re_trans_c, Im_trans_T, Im_trans_c)
609# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
610#elif defined(MFC_OpenMP)
611# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
612!$omp target enter data map(always,alloc:Re_trans_T, Re_trans_c, Im_trans_T, Im_trans_c)
613# 96 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
614#endif
615# 97 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
616 else if (qbmm) then
617#ifdef MFC_DEBUG
618# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
619 block
620# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
621 use iso_fortran_env, only: output_unit
622# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
623
624# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
625 print *, 'm_helper.fpp:98: ', '@:ALLOCATE(pb0(nb))'
626# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
627
628# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
629 call flush (output_unit)
630# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
631 end block
632# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
633#endif
634# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
635 allocate (pb0(nb))
636# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
637
638# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
639
640# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
641#if defined(MFC_OpenACC)
642# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
643!$acc enter data create(pb0)
644# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
645#elif defined(MFC_OpenMP)
646# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
647!$omp target enter data map(always,alloc:pb0)
648# 98 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
649#endif
650# 99 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
651 end if
652
653 ! Compute quadrature weights and nodes for polydisperse simulations
654 if (nb > 1) then
655 call s_simpson(weight, r0)
656 else if (nb == 1) then
657 r0 = 1._wp
658 weight = 1._wp
659 else
660 stop 'Invalid value of nb'
661 end if
662 r0 = r0*bub_pp%R0ref
663 end if
664
665 ! Initialize bubble variables
667
668 end subroutine s_initialize_bubbles_model
669
670 !> Set bubble physical parameters and nondimensional numbers from the input configuration.
671 impure subroutine s_initialize_bubble_vars()
672
673 r0ref = bub_pp%R0ref; p0ref = bub_pp%p0ref
674 rho0ref = bub_pp%rho0ref
675 ss = bub_pp%ss; pv = bub_pp%pv; vd = bub_pp%vd
676 mu_l = bub_pp%mu_l; mu_v = bub_pp%mu_v; mu_g = bub_pp%mu_g
677 gam_v = bub_pp%gam_v; gam_g = bub_pp%gam_g
678 if (.not. polytropic) then
679 if (bubbles_euler) then
680 m_v = bub_pp%M_v; m_g = bub_pp%M_g
681 k_v = bub_pp%k_v; k_g = bub_pp%k_g
682 end if
683 r_v = bub_pp%R_v; r_g = bub_pp%R_g
684 tw = bub_pp%T0ref
685 end if
686 if (bubbles_lagrange) then
687 cp_v = bub_pp%cp_v; cp_g = bub_pp%cp_g
688 k_vl = bub_pp%k_v; k_gl = bub_pp%k_g
689 end if
690
691 ! Input quantities
692 if (bubbles_euler .and. (.not. polytropic)) then
693 if (thermal == 2) then
694 gam_m = 1._wp
695 else
696 gam_m = gam_g
697 end if
698 end if
699
700 ! Nondimensional numbers
701 eu = p0ref
702 ca = eu - pv
703 if (.not. f_is_default(bub_pp%ss)) web = 1._wp/ss
704 if (.not. f_is_default(bub_pp%mu_l)) re_inv = mu_l
705 if (.not. polytropic) pe_c = 1._wp/vd
706
707 if (bubbles_euler) then
708 ! Initialize variables for non-polytropic (Preston) model
709 if (.not. polytropic) then
711 end if
712 ! Initialize pb based on surface tension for qbmm (polytropic)
713 if (qbmm .and. polytropic) then
714 pb0 = eu
715 if (.not. f_is_default(web)) then
716 pb0 = pb0 + 2._wp/web/r0
717 end if
718 end if
719 end if
720
721 end subroutine s_initialize_bubble_vars
722
723 !> Initializes non-polydisperse bubble modeling
724 impure subroutine s_initialize_nonpoly()
725
726 integer :: ir
727 real(wp), dimension(nb) :: chi_vw0, cp_m0, k_m0, rho_m0, x_vw, omegan
728 real(wp), parameter :: k_poly = 1._wp !< polytropic index used to compute isothermal natural frequency
729 ! Chapman-Enskog transport coefficients for vapor-gas mixture, Ando JAS (2010)
730
731 phi_vg = (1._wp + sqrt(mu_v/mu_g)*(m_g/m_v)**(0.25_wp))**2/(sqrt(8._wp)*sqrt(1._wp + m_v/m_g))
732 phi_gv = (1._wp + sqrt(mu_g/mu_v)*(m_v/m_g)**(0.25_wp))**2/(sqrt(8._wp)*sqrt(1._wp + m_g/m_v))
733
734 ! Initial internal bubble pressure (Euler number + Laplace pressure)
735 pb0 = eu + 2._wp/web/r0
736
737 ! Vapor mass fraction at bubble wall, Ando JAS (2010)
738 chi_vw0 = 1._wp/(1._wp + r_v/r_g*(pb0/pv - 1._wp))
739
740 ! Mixture specific heat from mass-weighted vapor/gas contributions
741 cp_m0 = chi_vw0*r_v*gam_v/(gam_v - 1._wp) + (1._wp - chi_vw0)*r_g*gam_g/(gam_g - 1._wp)
742
743 ! mole fraction of vapor (Eq. 2.23 in Ando 2010)
744 x_vw = m_g*chi_vw0/(m_v + (m_g - m_v)*chi_vw0)
745
746 ! thermal conductivity for gas/vapor mixture (Eq. 2.21 in Ando 2010)
747 k_m0 = x_vw*k_v/(x_vw + (1._wp - x_vw)*phi_vg) + (1._wp - x_vw)*k_g/(x_vw*phi_gv + 1._wp - x_vw)
748 k_g(:) = k_g(:)/k_m0(:)
749 k_v(:) = k_v(:)/k_m0(:)
750
751 ! mixture density (Eq. 2.20 in Ando 2010)
752 rho_m0 = pv/(chi_vw0*r_v*tw)
753
754 ! mass of gas/vapor
755 mass_g0(:) = (4._wp*pi/3._wp)*(pb0(:) - pv)/(r_g*tw)*r0(:)**3
756 mass_v0(:) = (4._wp*pi/3._wp)*pv/(r_v*tw)*r0(:)**3
757
758 ! Peclet numbers
759 pe_t(:) = rho_m0*cp_m0(:)/k_m0(:)
760
761 ! Bubble natural frequency, Ando JAS (2010)
762 omegan(:) = sqrt(3._wp*k_poly*ca + 2._wp*(3._wp*k_poly - 1._wp)/(web*r0))/r0/sqrt(rho0ref)
763 do ir = 1, nb
764 call s_transcoeff(omegan(ir)*r0(ir), pe_t(ir)*r0(ir), re_trans_t(ir), im_trans_t(ir))
765 call s_transcoeff(omegan(ir)*r0(ir), pe_c*r0(ir), re_trans_c(ir), im_trans_c(ir))
766 end do
767 im_trans_t = 0._wp
768
769 end subroutine s_initialize_nonpoly
770
771 !> Computes the transfer coefficient for the non-polytropic bubble compression process
772 elemental subroutine s_transcoeff(omega, peclet, Re_trans, Im_trans)
773
774 real(wp), intent(in) :: omega, peclet
775 real(wp), intent(out) :: re_trans, im_trans
776 complex(wp) :: imag, trans, c1, c2, c3
777
778 imag = (0._wp, 1._wp)
779
780 c1 = imag*omega*peclet
781 c2 = sqrt(c1)
782 c3 = (exp(c2) - exp(-c2))/(exp(c2) + exp(-c2)) ! TANH(c2)
783 trans = ((c2/c3 - 1._wp)**(-1) - 3._wp/c1)**(-1) ! transfer function
784
785 re_trans = trans
786 im_trans = aimag(trans)
787
788 end subroutine s_transcoeff
789
790 !> Convert an integer to its trimmed string representation.
791 elemental subroutine s_int_to_str(i, res)
792
793 integer, intent(in) :: i
794 character(len=*), intent(inout) :: res
795
796 write (res, '(I0)') i
797 res = trim(res)
798
799 end subroutine s_int_to_str
800
801 !> Compute the Simpson weights for quadrature
802 subroutine s_simpson(local_weight, local_R0)
803
804 real(wp), dimension(:), intent(inout) :: local_weight
805 real(wp), dimension(:), intent(inout) :: local_r0
806 integer :: ir
807 real(wp) :: r0mn, r0mx, dphi, tmp, sd
808 real(wp), dimension(nb) :: phi
809
810 sd = poly_sigma
811 r0mn = 0.8_wp*exp(-2.8_wp*sd)
812 r0mx = 0.2_wp*exp(9.5_wp*sd) + 1._wp
813
814 ! phi = ln( R0 ) & return R0
815 do ir = 1, nb
816 phi(ir) = log(r0mn) + (ir - 1._wp)*log(r0mx/r0mn)/(nb - 1._wp)
817 local_r0(ir) = exp(phi(ir))
818 end do
819
820# 269 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
821 dphi = phi(2) - phi(1)
822# 271 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
823
824 ! weights for quadrature using Simpson's rule
825 do ir = 2, nb - 1
826 ! Gaussian
827 tmp = exp(-0.5_wp*(phi(ir)/sd)**2)/sqrt(2._wp*pi)/sd
828 if (mod(ir, 2) == 0) then
829 local_weight(ir) = tmp*4._wp*dphi/3._wp
830 else
831 local_weight(ir) = tmp*2._wp*dphi/3._wp
832 end if
833 end do
834 tmp = exp(-0.5_wp*(phi(1)/sd)**2)/sqrt(2._wp*pi)/sd
835 local_weight(1) = tmp*dphi/3._wp
836 tmp = exp(-0.5_wp*(phi(nb)/sd)**2)/sqrt(2._wp*pi)/sd
837 local_weight(nb) = tmp*dphi/3._wp
838
839 end subroutine s_simpson
840
841 !> Compute the cross product of two vectors.
842 pure function f_cross(a, b) result(c)
843
844
845# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
846#if MFC_OpenACC
847# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
848!$acc routine seq
849# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
850#elif MFC_OpenMP
851# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
852
853# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
854
855# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
856!$omp declare target device_type(any)
857# 292 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
858#endif
859# 293 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
860
861 real(wp), dimension(3), intent(in) :: a, b
862 real(wp), dimension(3) :: c
863
864 c(1) = a(2)*b(3) - a(3)*b(2)
865 c(2) = a(3)*b(1) - a(1)*b(3)
866 c(3) = a(1)*b(2) - a(2)*b(1)
867
868 end function f_cross
869
870 !> Generate a unit vector uniformly distributed on the sphere from two random parameters.
871 function f_unit_vector(theta, eta) result(vec)
872
873
874# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
875#if MFC_OpenACC
876# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
877!$acc routine seq
878# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
879#elif MFC_OpenMP
880# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
881
882# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
883
884# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
885!$omp declare target device_type(any)
886# 306 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
887#endif
888# 307 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
889 real(wp), intent(in) :: theta, eta
890 real(wp) :: zeta, xi
891 real(wp), dimension(3) :: vec
892
893 xi = 2._wp*pi*theta
894 zeta = acos(2._wp*eta - 1._wp)
895 vec(1) = sin(zeta)*cos(xi)
896 vec(2) = sin(zeta)*sin(xi)
897 vec(3) = cos(zeta)
898
899 end function f_unit_vector
900
901 !> True when the first num_dims components of v are finite.
902 function f_finite_vec(v) result(finite)
903
904
905# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
906#if MFC_OpenACC
907# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
908!$acc routine seq
909# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
910#elif MFC_OpenMP
911# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
912
913# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
914
915# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
916!$omp declare target device_type(any)
917# 322 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
918#endif
919# 323 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
920
921 real(wp), dimension(3), intent(in) :: v
922 logical :: finite
923 integer :: dir
924
925 finite = .true.
926 do dir = 1, num_dims
927 finite = finite .and. f_is_finite_gpu(v(dir))
928 end do
929
930 end function f_finite_vec
931
932 !> Generate a pseudo-random number between 0 and 1 using a linear congruential generator.
933 subroutine s_prng(var, seed)
934
935
936# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
937#if MFC_OpenACC
938# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
939!$acc routine seq
940# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
941#elif MFC_OpenMP
942# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
943
944# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
945
946# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
947!$omp declare target device_type(any)
948# 338 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
949#endif
950# 339 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
951 integer, intent(inout) :: seed
952 real(wp), intent(out) :: var
953
954 seed = mod(modmul(seed), modulus)
955 var = seed/real(modulus, wp)
956
957 end subroutine s_prng
958
959 !> Compute a modular multiplication step for the linear congruential pseudo-random number generator.
960 function modmul(a) result(val)
961
962
963# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
964#if MFC_OpenACC
965# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
966!$acc routine seq
967# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
968#elif MFC_OpenMP
969# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
970
971# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
972
973# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
974!$omp declare target device_type(any)
975# 350 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
976#endif
977# 351 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
978 integer, intent(in) :: a
979 integer :: val
980 real(wp) :: x, y
981
982 x = (multiplier/real(modulus, wp))*a + (increment/real(modulus, wp))
983 y = nint((x - floor(x))*decimal_trim)/decimal_trim
984 val = nint(y*modulus)
985
986 end function modmul
987
988 !> Uniform draw in [0, 1) (1 only via single-precision rounding) from a 32-bit SplitMix-style generator (Weyl sequence hashed by
989 !! the MurmurHash3 finalizer). Exact integer arithmetic, so the stream is compiler-independent; period 2^32, and different seeds
990 !! give unrelated streams.
991 subroutine s_prng_splitmix32(var, state)
992
993
994# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
995#ifdef _CRAYFTN
996# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
997#if MFC_OpenACC
998# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
999!$acc routine seq
1000# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1001#elif MFC_OpenMP
1002# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1003
1004# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1005
1006# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1007!$omp declare target device_type(any)
1008# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1009#else
1010# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1011!DIR$ INLINEALWAYS s_prng_splitmix32
1012# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1013#endif
1014# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1015#elif MFC_OpenACC
1016# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1017!$acc routine seq
1018# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1019#elif MFC_OpenMP
1020# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1021
1022# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1023
1024# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1025!$omp declare target device_type(any)
1026# 366 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1027#endif
1028# 367 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1029
1030 real(wp), intent(out) :: var
1031 integer(kind=seed_kind), intent(inout) :: state !< reduced mod 2^32 on each draw
1032 integer(kind=seed_kind) :: z
1033
1034 state = iand(state + 2654435769_seed_kind, 4294967295_seed_kind)
1035 z = f_mulmod32(ieor(state, ishft(state, -16)), 2246822507_seed_kind)
1036 z = f_mulmod32(ieor(z, ishft(z, -13)), 3266489909_seed_kind)
1037 z = ieor(z, ishft(z, -16))
1038 var = real(z, wp)/4294967296._wp
1039
1040 end subroutine s_prng_splitmix32
1041
1042 !> a*b mod 2^32 for a, b in [0, 2^32), split into 16-bit halves of b so no intermediate exceeds 2^49
1043 pure function f_mulmod32(a, b) result(c)
1044
1045
1046# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1047#if MFC_OpenACC
1048# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1049!$acc routine seq
1050# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1051#elif MFC_OpenMP
1052# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1053
1054# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1055
1056# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1057!$omp declare target device_type(any)
1058# 383 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1059#endif
1060# 384 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1061
1062 integer(kind=seed_kind), intent(in) :: a, b
1063 integer(kind=seed_kind) :: c
1064
1065 c = iand(a*iand(b, 65535_seed_kind) + iand(a*ishft(b, -16), 65535_seed_kind)*65536_seed_kind, 4294967295_seed_kind)
1066
1067 end function f_mulmod32
1068
1069 !> Compute the cross product c = a x b of two 3D vectors.
1070 subroutine s_cross_product(a, b, c)
1071
1072
1073# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1074#if MFC_OpenACC
1075# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1076!$acc routine seq
1077# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1078#elif MFC_OpenMP
1079# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1080
1081# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1082
1083# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1084!$omp declare target device_type(any)
1085# 395 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1086#endif
1087# 396 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1088 real(wp), intent(in) :: a(3), b(3)
1089 real(wp), intent(out) :: c(3)
1090
1091 c(1) = a(2)*b(3) - a(3)*b(2)
1092 c(2) = a(3)*b(1) - a(1)*b(3)
1093 c(3) = a(1)*b(2) - a(2)*b(1)
1094
1095 end subroutine s_cross_product
1096
1097 !> Swap two real numbers.
1098 elemental subroutine s_swap(lhs, rhs)
1099
1100 real(wp), intent(inout) :: lhs, rhs
1101 real(wp) :: ltemp
1102
1103 ltemp = lhs
1104 lhs = rhs
1105 rhs = ltemp
1106
1107 end subroutine s_swap
1108
1109 !> Sort the key-value pair by the key
1110 pure subroutine s_sort_int_key_value(keys, vals, n)
1111
1112 integer, dimension(:), intent(inout) :: keys, vals
1113 integer, intent(in) :: n
1114 integer :: i, j, key, val
1115
1116 do i = 2, n
1117 key = keys(i); val = vals(i)
1118
1119 j = i
1120 do while (j > 1)
1121 if (keys(j - 1) <= key) exit
1122 j = j - 1
1123 end do
1124
1125 keys(j + 1:i) = keys(j:i - 1)
1126 vals(j + 1:i) = vals(j:i - 1)
1127 keys(j) = key; vals(j) = val
1128 end do
1129
1130 end subroutine s_sort_int_key_value
1131
1132 !> Create a transformation matrix.
1133 function f_create_transform_matrix(param, center) result(out_matrix)
1134
1135 type(ic_model_parameters), intent(in) :: param
1136 real(wp), dimension(1:3), optional, intent(in) :: center
1137 real(wp), dimension(1:4,1:4) :: sc, rz, rx, ry, tr, t_back, t_to_origin, out_matrix
1138
1139 sc = transpose(reshape([param%scale(1), 0._wp, 0._wp, 0._wp, 0._wp, param%scale(2), 0._wp, 0._wp, 0._wp, 0._wp, &
1140 & param%scale(3), 0._wp, 0._wp, 0._wp, 0._wp, 1._wp], shape(sc)))
1141
1142 rz = transpose(reshape([cos(param%rotate(3)), -sin(param%rotate(3)), 0._wp, 0._wp, sin(param%rotate(3)), &
1143 & cos(param%rotate(3)), 0._wp, 0._wp, 0._wp, 0._wp, 1._wp, 0._wp, 0._wp, 0._wp, 0._wp, 1._wp], shape(rz)))
1144
1145 rx = transpose(reshape([1._wp, 0._wp, 0._wp, 0._wp, 0._wp, cos(param%rotate(1)), -sin(param%rotate(1)), 0._wp, 0._wp, &
1146 & sin(param%rotate(1)), cos(param%rotate(1)), 0._wp, 0._wp, 0._wp, 0._wp, 1._wp], shape(rx)))
1147
1148 ry = transpose(reshape([cos(param%rotate(2)), 0._wp, sin(param%rotate(2)), 0._wp, 0._wp, 1._wp, 0._wp, 0._wp, &
1149 & -sin(param%rotate(2)), 0._wp, cos(param%rotate(2)), 0._wp, 0._wp, 0._wp, 0._wp, 1._wp], shape(ry)))
1150
1151 tr = transpose(reshape([1._wp, 0._wp, 0._wp, param%translate(1), 0._wp, 1._wp, 0._wp, param%translate(2), 0._wp, 0._wp, &
1152 & 1._wp, param%translate(3), 0._wp, 0._wp, 0._wp, 1._wp], shape(tr)))
1153
1154 if (present(center)) then
1155 ! Translation matrix to move center to the origin
1156 t_to_origin = transpose(reshape([1._wp, 0._wp, 0._wp, -center(1), 0._wp, 1._wp, 0._wp, -center(2), 0._wp, 0._wp, &
1157 & 1._wp, -center(3), 0._wp, 0._wp, 0._wp, 1._wp], shape(tr)))
1158
1159 ! Translation matrix to move center back to original position
1160 t_back = transpose(reshape([1._wp, 0._wp, 0._wp, center(1), 0._wp, 1._wp, 0._wp, center(2), 0._wp, 0._wp, 1._wp, &
1161 & center(3), 0._wp, 0._wp, 0._wp, 1._wp], shape(tr)))
1162
1163 out_matrix = matmul(tr, matmul(t_back, matmul(ry, matmul(rx, matmul(rz, matmul(sc, t_to_origin))))))
1164 else
1165 out_matrix = matmul(ry, matmul(rx, rz))
1166 end if
1167
1168 end function f_create_transform_matrix
1169
1170 !> Transform a vector by a matrix.
1171 subroutine s_transform_vec(vec, matrix)
1172
1173 real(wp), dimension(1:3), intent(inout) :: vec
1174 real(wp), dimension(1:4,1:4), intent(in) :: matrix
1175 real(wp), dimension(1:4) :: tmp
1176
1177 tmp = matmul(matrix, [vec(1), vec(2), vec(3), 1._wp])
1178 vec = tmp(1:3)
1179
1180 end subroutine s_transform_vec
1181
1182 !> Transform a triangle by a matrix, one vertex at a time.
1183 subroutine s_transform_triangle(triangle, matrix, matrix_n)
1184
1185 type(t_triangle), intent(inout) :: triangle
1186 real(wp), dimension(1:4,1:4), intent(in) :: matrix, matrix_n
1187 integer :: i
1188
1189 do i = 1, 3
1190 call s_transform_vec(triangle%v(i,:), matrix)
1191 end do
1192
1193 call s_transform_vec(triangle%n(1:3), matrix_n)
1194
1195 end subroutine s_transform_triangle
1196
1197 !> Transform a model by a matrix, one triangle at a time.
1198 subroutine s_transform_model(model, matrix, matrix_n)
1199
1200 type(t_model), intent(inout) :: model
1201 real(wp), dimension(1:4,1:4), intent(in) :: matrix, matrix_n
1202 integer :: i
1203
1204 do i = 1, size(model%trs)
1205 call s_transform_triangle(model%trs(i), matrix, matrix_n)
1206 end do
1207
1208 end subroutine s_transform_model
1209
1210 !> Create a bounding box for a model.
1211 function f_create_bbox(model) result(bbox)
1212
1213 type(t_model), intent(in) :: model
1214 type(t_bbox) :: bbox
1215 integer :: i, j
1216
1217 if (size(model%trs) == 0) then
1218 bbox%min = 0._wp
1219 bbox%max = 0._wp
1220 return
1221 end if
1222
1223 bbox%min = model%trs(1)%v(1,:)
1224 bbox%max = model%trs(1)%v(1,:)
1225
1226 do i = 1, size(model%trs)
1227 do j = 1, 3
1228 bbox%min = min(bbox%min, model%trs(i)%v(j,:))
1229 bbox%max = max(bbox%max, model%trs(i)%v(j,:))
1230 end do
1231 end do
1232
1233 end function f_create_bbox
1234
1235 !> Perform XOR on lhs and rhs.
1236 elemental function f_xor(lhs, rhs) result(res)
1237
1238 logical, intent(in) :: lhs, rhs
1239 logical :: res
1240
1241 res = (lhs .and. .not. rhs) .or. (.not. lhs .and. rhs)
1242
1243 end function f_xor
1244
1245 !> Convert a logical to 1 or 0.
1246 elemental function f_logical_to_int(predicate) result(int)
1247
1248 logical, intent(in) :: predicate
1249 integer :: int
1250
1251 if (predicate) then
1252 int = 1
1253 else
1254 int = 0
1255 end if
1256
1257 end function f_logical_to_int
1258
1259 !> Real spherical harmonic Y_lm(theta, phi). theta = polar angle from +z (acos(z/r)), phi = atan2(y,x). Uses associated Legendre
1260 !! P_l^|m|(cos theta). Standard normalisation.
1261 function real_ylm(theta, phi, l, m) result(Y)
1262
1263 integer, intent(in) :: l, m
1264 real(wp), intent(in) :: theta, phi
1265 real(wp) :: y, x, prefac
1266 integer :: m_abs
1267
1268 m_abs = abs(m)
1269 if (m_abs > l) then
1270 y = 0._wp
1271 return
1272 end if
1273 x = cos(theta)
1274 prefac = sqrt((2*l + 1)*real(factorial(l - m_abs), wp)/real(factorial(l + m_abs), wp)/(4._wp*pi))
1275 if (m == 0) then
1276 y = prefac*associated_legendre(x, l, 0)
1277 else if (m > 0) then
1278 y = prefac*sqrt(2._wp)*associated_legendre(x, l, m_abs)*cos(m*phi)
1279 else
1280 y = prefac*sqrt(2._wp)*associated_legendre(x, l, m_abs)*sin(m_abs*phi)
1281 end if
1282
1283 end function real_ylm
1284
1285 !> Associated Legendre polynomial P_l^m(x) (Ferrers function, Condon-Shortley phase). Valid for integer l >= 0, 0 <= m <= l, and
1286 !! x in [-1,1]. Returns 0 for |m| > l or l < 0. Formulas: DLMF 14.10.3 (recurrence in degree), Wikipedia "Associated Legendre
1287 !! polynomials" (P_l^l and P_l^{l-1} identities). Recurrence: (l-m)P_l^m = (2l-1)x P_{l-1}^m - (l+m-1)P_{l-2}^m.
1288 !! @param x argument (typically cos(theta)), should be in [-1,1]
1289 !! @param l degree (>= 0)
1290 !! @param m_order order (0 <= m_order <= l)
1291 recursive function associated_legendre(x, l, m_order) result(result_P)
1292
1293 integer, intent(in) :: l, m_order
1294 real(wp), intent(in) :: x
1295 real(wp) :: result_p
1296 real(wp) :: one_minus_x2
1297
1298 ! Out-of-domain: P_l^m = 0 for |m| > l or l < 0 (standard convention)
1299
1300 if (l < 0 .or. m_order < 0 .or. m_order > l) then
1301 result_p = 0._wp
1302 return
1303 end if
1304
1305 if (m_order <= 0 .and. l <= 0) then
1306 result_p = 1._wp
1307 else if (l == 1 .and. m_order <= 0) then
1308 result_p = x
1309 else if (l == 1 .and. m_order == 1) then
1310 one_minus_x2 = max(0._wp, 1._wp - x**2)
1311 result_p = -sqrt(one_minus_x2)
1312 else if (m_order == l) then
1313 ! P_l^l(x) = (-1)^l (2l-1)!! (1-x^2)^(l/2). Use real exponent for odd l
1314 one_minus_x2 = max(0._wp, 1._wp - x**2)
1315 result_p = (-1)**l*real(double_factorial(2*l - 1), wp)*one_minus_x2**(0.5_wp*real(l, wp))
1316 else if (m_order == l - 1) then
1317 result_p = x*(2*l - 1)*associated_legendre(x, l - 1, l - 1)
1318 else
1319 result_p = ((2*l - 1)*x*associated_legendre(x, l - 1, m_order) - (l + m_order - 1)*associated_legendre(x, l - 2, &
1320 & m_order))/(l - m_order)
1321 end if
1322
1323 end function associated_legendre
1324
1325 !> Calculate the double factorial of an integer
1326 elemental function double_factorial(n_in) result(R_result)
1327
1328 integer, intent(in) :: n_in
1329 integer, parameter :: int64_kind = selected_int_kind(18) !< 18 bytes for 64-bit integer
1330 integer(kind=int64_kind) :: r_result
1331 integer :: i
1332
1333 r_result = product((/(i, i=n_in, 1, -2)/))
1334
1335 end function double_factorial
1336
1337 !> Calculate the factorial of an integer
1338 elemental function factorial(n_in) result(R_result)
1339
1340 integer, intent(in) :: n_in
1341 integer, parameter :: int64_kind = selected_int_kind(18) !< 18 bytes for 64-bit integer
1342 integer(kind=int64_kind) :: r_result
1343 integer :: i
1344
1345 r_result = product((/(i, i=n_in, 1, -1)/))
1346
1347 end function factorial
1348
1349 !> Calculate a smooth cut-on function that is zero for x values smaller than zero and goes to one, for generating smooth initial
1350 !! conditions
1351 function f_cut_on(x, eps) result(fx)
1352
1353 real(wp), intent(in) :: x, eps
1354 real(wp) :: fx
1355
1356 fx = 1 - f_gx(x/eps)/(f_gx(x/eps) + f_gx(1 - x/eps))
1357
1358 end function f_cut_on
1359
1360 !> Calculate a smooth cut-off function that is one for x values smaller than zero and goes to zero, for generating smooth
1361 !! initial conditions
1362 function f_cut_off(x, eps) result(fx)
1363
1364 real(wp), intent(in) :: x, eps
1365 real(wp) :: fx
1366
1367 fx = f_gx(x/eps)/(f_gx(x/eps) + f_gx(1 - x/eps))
1368
1369 end function f_cut_off
1370
1371 !> Helper function for f_cut_on and f_cut_off
1372 function f_gx(x) result(gx)
1373
1374 real(wp), intent(in) :: x
1375 real(wp) :: gx
1376
1377 if (x > 0) then
1378 gx = exp(-1._wp/x)
1379 else
1380 gx = 0._wp
1381 end if
1382
1383 end function f_gx
1384
1385 !> Downsample conservative variable fields by a factor of 3 in each direction using volume averaging.
1386 subroutine s_downsample_data(q_cons_vf, q_cons_temp, m_ds, n_ds, p_ds, m_glb_ds, n_glb_ds, p_glb_ds)
1387
1388 type(scalar_field), dimension(sys_size), intent(inout) :: q_cons_vf, q_cons_temp
1389
1390 ! Down sampling variables
1391 integer :: i, j, k, l
1392 integer :: ix, iy, iz, x_id, y_id, z_id
1393 integer, intent(inout) :: m_ds, n_ds, p_ds, m_glb_ds, n_glb_ds, p_glb_ds
1394
1395 m_ds = int((m + 1)/3) - 1
1396 n_ds = int((n + 1)/3) - 1
1397 p_ds = int((p + 1)/3) - 1
1398
1399 m_glb_ds = int((m_glb + 1)/3) - 1
1400 n_glb_ds = int((n_glb + 1)/3) - 1
1401 p_glb_ds = int((p_glb + 1)/3) - 1
1402
1403 do l = -1, p_ds + 1
1404 do k = -1, n_ds + 1
1405 do j = -1, m_ds + 1
1406 x_id = 3*j + 1
1407 y_id = 3*k + 1
1408 z_id = 3*l + 1
1409 do i = 1, sys_size
1410 q_cons_temp(i)%sf(j, k, l) = 0
1411
1412 do iz = -1, 1
1413 do iy = -1, 1
1414 do ix = -1, 1
1415 q_cons_temp(i)%sf(j, k, l) = q_cons_temp(i)%sf(j, k, &
1416 & l) + (1._wp/27._wp)*q_cons_vf(i)%sf(x_id + ix, y_id + iy, z_id + iz)
1417 end do
1418 end do
1419 end do
1420 end do
1421 end do
1422 end do
1423 end do
1424
1425 end subroutine s_downsample_data
1426
1427 !> Upsample conservative variable fields from a coarsened grid back to the original resolution using interpolation.
1428 subroutine s_upsample_data(q_cons_vf, q_cons_temp)
1429
1430 type(scalar_field), intent(inout), dimension(sys_size) :: q_cons_vf, q_cons_temp
1431 integer :: i, j, k, l
1432 integer :: ix, iy, iz
1433 integer :: x_id, y_id, z_id
1434 real(wp), dimension(4) :: temp
1435
1436 do l = 0, p
1437 do k = 0, n
1438 do j = 0, m
1439 do i = 1, sys_size
1440 ix = int(j/3._wp)
1441 iy = int(k/3._wp)
1442 iz = int(l/3._wp)
1443
1444 x_id = j - int(3*ix) - 1
1445 y_id = k - int(3*iy) - 1
1446 z_id = l - int(3*iz) - 1
1447
1448 temp(1) = (2._wp/3._wp)*q_cons_temp(i)%sf(ix, iy, iz) + (1._wp/3._wp)*q_cons_temp(i)%sf(ix + x_id, iy, iz)
1449 temp(2) = (2._wp/3._wp)*q_cons_temp(i)%sf(ix, iy + y_id, iz) + (1._wp/3._wp)*q_cons_temp(i)%sf(ix + x_id, &
1450 & iy + y_id, iz)
1451 temp(3) = (2._wp/3._wp)*temp(1) + (1._wp/3._wp)*temp(2)
1452
1453 temp(1) = (2._wp/3._wp)*q_cons_temp(i)%sf(ix, iy, iz + z_id) + (1._wp/3._wp)*q_cons_temp(i)%sf(ix + x_id, &
1454 & iy, iz + z_id)
1455 temp(2) = (2._wp/3._wp)*q_cons_temp(i)%sf(ix, iy + y_id, &
1456 & iz + z_id) + (1._wp/3._wp)*q_cons_temp(i)%sf(ix + x_id, iy + y_id, iz + z_id)
1457 temp(4) = (2._wp/3._wp)*temp(1) + (1._wp/3._wp)*temp(2)
1458
1459 q_cons_vf(i)%sf(j, k, l) = (2._wp/3._wp)*temp(3) + (1._wp/3._wp)*temp(4)
1460 end do
1461 end do
1462 end do
1463 end do
1464
1465 end subroutine s_upsample_data
1466
1467 !> @brief True if `location` falls within this rank's own subdomain (a strict partition - each location is owned by exactly one
1468 !! rank, unlike an overlapping multi-rank ghost-stencil neighborhood). Used by both pre_process (to decide which
1469 !! generated/namelist IBs a rank writes to its own restart_data/ib_state_0.dat chunk) and simulation (to decide which IBs a rank
1470 !! owns for its own periodic IB-state writes) so the two stay consistent. glb_bounds_in is the global domain extent, used only
1471 !! to project a location that falls just outside the domain (floating-point edge case) onto the domain so some rank still claims
1472 !! it.
1473 function f_local_rank_owns_location(location, glb_bounds_in) result(owns_location)
1474
1475
1476# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1477#if MFC_OpenACC
1478# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1479!$acc routine seq
1480# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1481#elif MFC_OpenMP
1482# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1483
1484# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1485
1486# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1487!$omp declare target device_type(any)
1488# 783 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1489#endif
1490# 784 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1491
1492 real(wp), dimension(3), intent(in) :: location
1493 type(bounds_info), dimension(3), intent(in) :: glb_bounds_in
1494 logical :: owns_location
1495 real(wp), dimension(3) :: projected_location
1496
1497 owns_location = .true.
1498
1499#ifdef MFC_MPI
1500 if (num_procs > 1) then
1501 projected_location(:) = location(:)
1502
1503 ! catch the edge case where the location lies just outside the computational domain
1504# 798 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1505 if (num_dims >= 1) then
1506# 799 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1507 if (ib_bc_x%beg /= bc_periodic) then
1508# 800 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1509 ! if it is outside the domain in one direction, project it somewhere inside so at least one rank owns it
1510 if (location(1) < glb_bounds_in(1)%beg) then
1511# 802 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1512 projected_location(1) = glb_bounds_in(1)%beg
1513# 803 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1514 else if (glb_bounds_in(1)%end < location(1)) then
1515# 804 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1516 projected_location(1) = glb_bounds_in(1)%end - 1.0e-10_wp
1517# 805 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1518 end if
1519 end if
1520 owns_location = owns_location .and. x_cb(-1) <= projected_location(1) &
1521# 808 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1522 & .and. projected_location(1) < x_cb(m)
1523# 809 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1524 end if
1525# 798 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1526 if (num_dims >= 2) then
1527# 799 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1528 if (ib_bc_y%beg /= bc_periodic) then
1529# 800 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1530 ! if it is outside the domain in one direction, project it somewhere inside so at least one rank owns it
1531 if (location(2) < glb_bounds_in(2)%beg) then
1532# 802 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1533 projected_location(2) = glb_bounds_in(2)%beg
1534# 803 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1535 else if (glb_bounds_in(2)%end < location(2)) then
1536# 804 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1537 projected_location(2) = glb_bounds_in(2)%end - 1.0e-10_wp
1538# 805 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1539 end if
1540 end if
1541 owns_location = owns_location .and. y_cb(-1) <= projected_location(2) &
1542# 808 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1543 & .and. projected_location(2) < y_cb(n)
1544# 809 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1545 end if
1546# 798 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1547 if (num_dims >= 3) then
1548# 799 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1549 if (ib_bc_z%beg /= bc_periodic) then
1550# 800 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1551 ! if it is outside the domain in one direction, project it somewhere inside so at least one rank owns it
1552 if (location(3) < glb_bounds_in(3)%beg) then
1553# 802 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1554 projected_location(3) = glb_bounds_in(3)%beg
1555# 803 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1556 else if (glb_bounds_in(3)%end < location(3)) then
1557# 804 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1558 projected_location(3) = glb_bounds_in(3)%end - 1.0e-10_wp
1559# 805 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1560 end if
1561 end if
1562 owns_location = owns_location .and. z_cb(-1) <= projected_location(3) &
1563# 808 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1564 & .and. projected_location(3) < z_cb(p)
1565# 809 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1566 end if
1567# 811 "/home/runner/work/MFC/MFC/src/common/m_helper.fpp"
1568 end if
1569#endif
1570
1571 end function f_local_rank_owns_location
1572
1573 !> One IB's restart_data/ib_state record; see ib_state_nfields for the layout.
1574 pure subroutine s_pack_ib_state(ib_patch, time, buf)
1575
1576 type(ib_patch_parameters), intent(in) :: ib_patch
1577 real(wp), intent(in) :: time
1578 real(wp), dimension(ib_state_nfields), intent(out) :: buf
1579
1580 buf(1) = time
1581 buf(2:4) = ib_patch%force(1:3)
1582 buf(5:7) = ib_patch%torque(1:3)
1583 buf(8:10) = ib_patch%vel(1:3)
1584 buf(11:13) = ib_patch%angular_vel(1:3)
1585 buf(14:16) = ib_patch%angles(1:3)
1586 buf(17) = ib_patch%x_centroid
1587 buf(18) = ib_patch%y_centroid
1588 buf(19) = ib_patch%z_centroid
1589 buf(20) = ib_patch%radius
1590 buf(21) = ib_patch%Twall
1591
1592 end subroutine s_pack_ib_state
1593
1594end module m_helper
type(scalar_field), dimension(sys_size), intent(inout) q_cons_vf
integer, intent(in) k
integer, intent(in) j
integer, intent(in) l
Compile-time constant parameters: default values, tolerances, and physical constants.
integer, parameter ib_state_nfields
Reals per IB in restart_data/ib_state: time, force(3), torque(3), vel(3), angular_vel(3),...
integer, parameter seed_kind
64-bit state of s_prng_splitmix32
real(wp), parameter pi
Pi.
integer, parameter bc_periodic
Shared derived types for field data, patch geometry, bubble dynamics, and MPI I/O structures.
Global parameters for the computational domain, fluid properties, and simulation algorithm configurat...
real(wp), dimension(:), allocatable weight
Simpson quadrature weights.
real(wp), dimension(:), allocatable r0
Bubble sizes.
Basic floating-point utilities: approximate equality, default detection, and coordinate bounds.
logical function, public f_is_finite_gpu(val)
True when val is neither NaN nor infinite, without ieee_arithmetic so it is callable on the device.
Utility routines for bubble model setup, coordinate transforms, array sampling, and special functions...
subroutine, public s_comp_n_from_prim(vftmp, rtmp, ntmp, weights)
Computes the bubble number density n from the primitive variables.
subroutine, public s_cross_product(a, b, c)
Compute the cross product c = a x b of two 3D vectors.
integer function, public modmul(a)
Compute a modular multiplication step for the linear congruential pseudo-random number generator.
impure subroutine, public s_initialize_nonpoly()
Initializes non-polydisperse bubble modeling.
recursive real(wp) function, public associated_legendre(x, l, m_order)
Associated Legendre polynomial P_l^m(x) (Ferrers function, Condon-Shortley phase)....
logical function, public f_finite_vec(v)
True when the first num_dims components of v are finite.
subroutine, public s_transform_triangle(triangle, matrix, matrix_n)
Transform a triangle by a matrix, one vertex at a time.
real(wp) function, dimension(3), public f_unit_vector(theta, eta)
Generate a unit vector uniformly distributed on the sphere from two random parameters.
logical function, public f_local_rank_owns_location(location, glb_bounds_in)
True if location falls within this rank's own subdomain (a strict partition - each location is owned ...
real(wp) function, public f_cut_on(x, eps)
Calculate a smooth cut-on function that is zero for x values smaller than zero and goes to one,...
subroutine, public s_transform_model(model, matrix, matrix_n)
Transform a model by a matrix, one triangle at a time.
type(t_bbox) function, public f_create_bbox(model)
Create a bounding box for a model.
real(wp) function f_gx(x)
Helper function for f_cut_on and f_cut_off.
subroutine, public s_simpson(local_weight, local_r0)
Compute the Simpson weights for quadrature.
elemental integer(kind=int64_kind) function, public double_factorial(n_in)
Calculate the double factorial of an integer.
pure integer(kind=seed_kind) function f_mulmod32(a, b)
a*b mod 2^32 for a, b in [0, 2^32), split into 16-bit halves of b so no intermediate exceeds 2^49
impure subroutine s_initialize_bubble_vars()
Set bubble physical parameters and nondimensional numbers from the input configuration.
elemental integer(kind=int64_kind) function, public factorial(n_in)
Calculate the factorial of an integer.
subroutine, public s_upsample_data(q_cons_vf, q_cons_temp)
Upsample conservative variable fields from a coarsened grid back to the original resolution using int...
real(wp) function, dimension(1:4, 1:4), public f_create_transform_matrix(param, center)
Create a transformation matrix.
real(wp) function, public f_cut_off(x, eps)
Calculate a smooth cut-off function that is one for x values smaller than zero and goes to zero,...
subroutine, public s_transform_vec(vec, matrix)
Transform a vector by a matrix.
impure subroutine, public s_initialize_bubbles_model()
Initialize bubble model arrays for Euler or Lagrangian bubbles with polytropic or non-polytropic gas.
subroutine, public s_prng_splitmix32(var, state)
Uniform draw in [0, 1) (1 only via single-precision rounding) from a 32-bit SplitMix-style generator ...
impure subroutine, public s_print_2d_array(a, div)
Print a 2D real array to standard output, optionally dividing each element by a given scalar.
elemental subroutine, public s_transcoeff(omega, peclet, re_trans, im_trans)
Computes the transfer coefficient for the non-polytropic bubble compression process.
pure subroutine, public s_pack_ib_state(ib_patch, time, buf)
One IB's restart_data/ib_state record; see ib_state_nfields for the layout.
subroutine, public s_prng(var, seed)
Generate a pseudo-random number between 0 and 1 using a linear congruential generator.
pure real(wp) function, dimension(3), public f_cross(a, b)
Compute the cross product of two vectors.
subroutine, public s_downsample_data(q_cons_vf, q_cons_temp, m_ds, n_ds, p_ds, m_glb_ds, n_glb_ds, p_glb_ds)
Downsample conservative variable fields by a factor of 3 in each direction using volume averaging.
elemental logical function, public f_xor(lhs, rhs)
Perform XOR on lhs and rhs.
pure subroutine, public s_sort_int_key_value(keys, vals, n)
Sort the key-value pair by the key.
subroutine, public s_comp_n_from_cons(vftmp, nrtmp, ntmp, weights)
Compute the bubble number density from the conservative void fraction and weighted bubble radii.
real(wp) function, public real_ylm(theta, phi, l, m)
Real spherical harmonic Y_lm(theta, phi). theta = polar angle from +z (acos(z/r)),...
elemental integer function, public f_logical_to_int(predicate)
Convert a logical to 1 or 0.
elemental subroutine, public s_int_to_str(i, res)
Convert an integer to its trimmed string representation.
elemental subroutine, public s_swap(lhs, rhs)
Swap two real numbers.