Skip to content

Commit 841f3b7

Browse files
author
MFC Action
committed
Docs @ bdf3709
1 parent 907896a commit 841f3b7

File tree

1,341 files changed

+98184
-50823
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,341 files changed

+98184
-50823
lines changed

documentation/doxygen_crawl.html

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,15 @@
3838
<a href="md_case.html#autotoc_md29"/>
3939
<a href="md_case.html#autotoc_md3"/>
4040
<a href="md_case.html#autotoc_md30"/>
41+
<a href="md_case.html#autotoc_md31"/>
42+
<a href="md_case.html#autotoc_md32"/>
4143
<a href="md_case.html#autotoc_md4"/>
4244
<a href="md_case.html#autotoc_md5"/>
4345
<a href="md_case.html#autotoc_md6"/>
4446
<a href="md_case.html#autotoc_md7"/>
4547
<a href="md_case.html#autotoc_md8"/>
4648
<a href="md_case.html#autotoc_md9"/>
4749
<a href="md_examples.html"/>
48-
<a href="md_examples.html#autotoc_md32"/>
49-
<a href="md_examples.html#autotoc_md33"/>
5050
<a href="md_examples.html#autotoc_md34"/>
5151
<a href="md_examples.html#autotoc_md35"/>
5252
<a href="md_examples.html#autotoc_md36"/>
@@ -92,9 +92,9 @@
9292
<a href="md_examples.html#autotoc_md76"/>
9393
<a href="md_examples.html#autotoc_md77"/>
9494
<a href="md_examples.html#autotoc_md78"/>
95+
<a href="md_examples.html#autotoc_md79"/>
96+
<a href="md_examples.html#autotoc_md80"/>
9597
<a href="md_expectedPerformance.html"/>
96-
<a href="md_expectedPerformance.html#autotoc_md80"/>
97-
<a href="md_expectedPerformance.html#autotoc_md81"/>
9898
<a href="md_expectedPerformance.html#autotoc_md82"/>
9999
<a href="md_expectedPerformance.html#autotoc_md83"/>
100100
<a href="md_expectedPerformance.html#autotoc_md84"/>
@@ -103,37 +103,39 @@
103103
<a href="md_expectedPerformance.html#autotoc_md87"/>
104104
<a href="md_expectedPerformance.html#autotoc_md88"/>
105105
<a href="md_expectedPerformance.html#autotoc_md89"/>
106+
<a href="md_expectedPerformance.html#autotoc_md90"/>
107+
<a href="md_expectedPerformance.html#autotoc_md91"/>
106108
<a href="md_getting-started.html"/>
107-
<a href="md_getting-started.html#autotoc_md91"/>
108-
<a href="md_getting-started.html#autotoc_md92"/>
109109
<a href="md_getting-started.html#autotoc_md93"/>
110110
<a href="md_getting-started.html#autotoc_md94"/>
111111
<a href="md_getting-started.html#autotoc_md95"/>
112+
<a href="md_getting-started.html#autotoc_md96"/>
113+
<a href="md_getting-started.html#autotoc_md97"/>
112114
<a href="md_papers.html"/>
113115
<a href="md_readme.html"/>
114-
<a href="md_readme.html#autotoc_md98"/>
115-
<a href="md_readme.html#autotoc_md99"/>
116+
<a href="md_readme.html#autotoc_md100"/>
117+
<a href="md_readme.html#autotoc_md101"/>
116118
<a href="md_references.html"/>
117119
<a href="md_running.html"/>
118-
<a href="md_running.html#autotoc_md102"/>
119-
<a href="md_running.html#autotoc_md103"/>
120120
<a href="md_running.html#autotoc_md104"/>
121121
<a href="md_running.html#autotoc_md105"/>
122122
<a href="md_running.html#autotoc_md106"/>
123123
<a href="md_running.html#autotoc_md107"/>
124124
<a href="md_running.html#autotoc_md108"/>
125+
<a href="md_running.html#autotoc_md109"/>
126+
<a href="md_running.html#autotoc_md110"/>
125127
<a href="md_testing.html"/>
126-
<a href="md_testing.html#autotoc_md110"/>
127-
<a href="md_testing.html#autotoc_md111"/>
128+
<a href="md_testing.html#autotoc_md112"/>
129+
<a href="md_testing.html#autotoc_md113"/>
128130
<a href="md_visualization.html"/>
129-
<a href="md_visualization.html#autotoc_md113"/>
130-
<a href="md_visualization.html#autotoc_md114"/>
131131
<a href="md_visualization.html#autotoc_md115"/>
132132
<a href="md_visualization.html#autotoc_md116"/>
133133
<a href="md_visualization.html#autotoc_md117"/>
134134
<a href="md_visualization.html#autotoc_md118"/>
135135
<a href="md_visualization.html#autotoc_md119"/>
136136
<a href="md_visualization.html#autotoc_md120"/>
137+
<a href="md_visualization.html#autotoc_md121"/>
138+
<a href="md_visualization.html#autotoc_md122"/>
137139
<a href="pages.html"/>
138140
</body>
139141
</html>

documentation/md_case.html

Lines changed: 123 additions & 43 deletions
Large diffs are not rendered by default.

documentation/md_examples.html

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -135,35 +135,35 @@
135135
<div class="headertitle"><div class="title">Example Cases</div></div>
136136
</div><!--header-->
137137
<div class="contents">
138-
<div class="textblock"><p><a class="anchor" id="autotoc_md31"></a></p>
139-
<h1><a class="anchor" id="autotoc_md32"></a>
138+
<div class="textblock"><p><a class="anchor" id="autotoc_md33"></a></p>
139+
<h1><a class="anchor" id="autotoc_md34"></a>
140140
2D Riemann Test (2D)</h1>
141141
<p>Reference: Chamarthi, A., &amp; Hoffmann, N., &amp; Nishikawa, H., &amp; Frankel S. (2023). Implicit gradients based conservative numerical scheme for compressible flows. arXiv:2110.05461</p>
142-
<h2><a class="anchor" id="autotoc_md33"></a>
142+
<h2><a class="anchor" id="autotoc_md35"></a>
143143
Density Initial Condition</h2>
144144
<div class="image">
145145
<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
146146
<div class="caption">
147147
Density</div></div>
148-
<h2><a class="anchor" id="autotoc_md34"></a>
148+
<h2><a class="anchor" id="autotoc_md36"></a>
149149
Density Final Condition</h2>
150150
<div class="image">
151151
<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
152152
<div class="caption">
153153
Density Norms</div></div>
154-
<h1><a class="anchor" id="autotoc_md35"></a>
154+
<h1><a class="anchor" id="autotoc_md37"></a>
155155
Shock Droplet (2D)</h1>
156156
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
157-
<h2><a class="anchor" id="autotoc_md36"></a>
157+
<h2><a class="anchor" id="autotoc_md38"></a>
158158
Initial Condition</h2>
159159
<div class="image">
160160
<img src="initial-2D_shockdroplet-example.png" alt=""/>
161161
<div class="caption">
162162
Initial Condition</div></div>
163-
<h2><a class="anchor" id="autotoc_md37"></a>
163+
<h2><a class="anchor" id="autotoc_md39"></a>
164164
Result</h2>
165165
<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/> </p>
166-
<h1><a class="anchor" id="autotoc_md38"></a>
166+
<h1><a class="anchor" id="autotoc_md40"></a>
167167
Perfectly Stirred Reactor</h1>
168168
<p>Reference: G. B. Skinner and G. H. Ringrose, “Ignition Delays of a Hydrogen—Oxygen—Argon Mixture at Relatively Low Temperatures”, J. Chem. Phys., vol. 42, no. 6, pp. 2190–2192, Mar. 1965. Accessed: Oct. 13, 2024. [Online]. Available: <a href="https://doi.org/10.1063/1.1696266">https://doi.org/10.1063/1.1696266</a>.</p>
169169
<div class="fragment"><div class="line">$ python3 analyze.py</div>
@@ -172,186 +172,186 @@ <h1><a class="anchor" id="autotoc_md38"></a>
172172
<div class="line"> + Cantera: 5.130e-05 s</div>
173173
<div class="line"> + (Che)MFC: 5.130e-05 s</div>
174174
</div><!-- fragment --><p><img src="result-nD_perfect_reactor-example.png" alt="" class="inline" title="Result"/> </p>
175-
<h1><a class="anchor" id="autotoc_md39"></a>
175+
<h1><a class="anchor" id="autotoc_md41"></a>
176176
Titarev-Toro problem (1D)</h1>
177177
<p>Reference: V. A. Titarev, E. F. Toro, Finite-volume WENO schemes for three-dimensional conservation laws, Journal of Computational Physics 201 (1) (2004) 238–260.</p>
178-
<h2><a class="anchor" id="autotoc_md40"></a>
178+
<h2><a class="anchor" id="autotoc_md42"></a>
179179
Initial Condition</h2>
180180
<div class="image">
181181
<img src="initial-1D_titarevtorro-example.png" alt=""/>
182182
<div class="caption">
183183
Initial Condition</div></div>
184-
<h2><a class="anchor" id="autotoc_md41"></a>
184+
<h2><a class="anchor" id="autotoc_md43"></a>
185185
Result</h2>
186186
<div class="image">
187187
<img src="result-1D_titarevtorro-example.png" alt=""/>
188188
<div class="caption">
189189
Result</div></div>
190-
<h1><a class="anchor" id="autotoc_md42"></a>
190+
<h1><a class="anchor" id="autotoc_md44"></a>
191191
2D IBM CFL dt (2D)</h1>
192-
<h2><a class="anchor" id="autotoc_md43"></a>
192+
<h2><a class="anchor" id="autotoc_md45"></a>
193193
Result</h2>
194194
<div class="image">
195195
<img src="result-2D_ibm_cfl_dt-example.png" alt=""/>
196196
<div class="caption">
197197
Result</div></div>
198-
<h1><a class="anchor" id="autotoc_md44"></a>
198+
<h1><a class="anchor" id="autotoc_md46"></a>
199199
Shu-Osher problem (1D)</h1>
200200
<p>Reference: C. W. Shu, S. Osher, Efficient implementation of essentially non-oscillatory shock-capturing schemes, Journal of Computational Physics 77 (2) (1988) 439–471. doi:10.1016/0021-9991(88)90177-5.</p>
201-
<h2><a class="anchor" id="autotoc_md45"></a>
201+
<h2><a class="anchor" id="autotoc_md47"></a>
202202
Initial Condition</h2>
203203
<div class="image">
204204
<img src="initial-1D_shuosher_old-example.png" alt=""/>
205205
<div class="caption">
206206
Initial Condition</div></div>
207-
<h2><a class="anchor" id="autotoc_md46"></a>
207+
<h2><a class="anchor" id="autotoc_md48"></a>
208208
Result</h2>
209209
<div class="image">
210210
<img src="result-1D_shuosher_old-example.png" alt=""/>
211211
<div class="caption">
212212
Result</div></div>
213-
<h1><a class="anchor" id="autotoc_md47"></a>
213+
<h1><a class="anchor" id="autotoc_md49"></a>
214214
2D Hardcodied IC Example</h1>
215-
<h2><a class="anchor" id="autotoc_md48"></a>
215+
<h2><a class="anchor" id="autotoc_md50"></a>
216216
Initial Condition</h2>
217217
<div class="image">
218218
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
219219
<div class="caption">
220220
Initial Condition</div></div>
221-
<h2><a class="anchor" id="autotoc_md49"></a>
221+
<h2><a class="anchor" id="autotoc_md51"></a>
222222
Result</h2>
223223
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
224-
<h1><a class="anchor" id="autotoc_md50"></a>
224+
<h1><a class="anchor" id="autotoc_md52"></a>
225225
Lax shock tube problem (1D)</h1>
226226
<p>Reference: P. D. Lax, Weak solutions of nonlinear hyperbolic equations and their numerical computation, Communications on pure and applied mathematics 7 (1) (1954) 159–193.</p>
227-
<h2><a class="anchor" id="autotoc_md51"></a>
227+
<h2><a class="anchor" id="autotoc_md53"></a>
228228
Initial Condition</h2>
229229
<div class="image">
230230
<img src="initial-1D_laxshocktube-example.png" alt=""/>
231231
<div class="caption">
232232
Initial Condition</div></div>
233-
<h2><a class="anchor" id="autotoc_md52"></a>
233+
<h2><a class="anchor" id="autotoc_md54"></a>
234234
Result</h2>
235235
<div class="image">
236236
<img src="result-1D_laxshocktube-example.png" alt=""/>
237237
<div class="caption">
238238
Result</div></div>
239-
<h1><a class="anchor" id="autotoc_md53"></a>
239+
<h1><a class="anchor" id="autotoc_md55"></a>
240240
Lid-Driven Cavity Problem (2D)</h1>
241241
<p>Reference: Bezgin, D. A., &amp; Buhendwa A. B., &amp; Adams N. A. (2022). JAX-FLUIDS: A fully-differentiable high-order computational fluid dynamics solver for compressible two-phase flows. arXiv:2203.13760</p>
242242
<p>Reference: Ghia, U., &amp; Ghia, K. N., &amp; Shin, C. T. (1982). High-re solutions for incompressible flow using the Navier-Stokes equations and a multigrid method. Journal of Computational Physics, 48, 387-411</p>
243243
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
244-
<h2><a class="anchor" id="autotoc_md54"></a>
244+
<h2><a class="anchor" id="autotoc_md56"></a>
245245
Final Condition</h2>
246246
<div class="image">
247247
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
248248
<div class="caption">
249249
Final Condition</div></div>
250-
<h2><a class="anchor" id="autotoc_md55"></a>
250+
<h2><a class="anchor" id="autotoc_md57"></a>
251251
Centerline Velocities</h2>
252252
<div class="image">
253253
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
254254
<div class="caption">
255255
Centerline Velocities</div></div>
256-
<h1><a class="anchor" id="autotoc_md56"></a>
256+
<h1><a class="anchor" id="autotoc_md58"></a>
257257
1D Multi-Component Inert Shock Tube</h1>
258258
<p>References: </p><blockquote class="doxtable">
259259
<p>&zwj;P. J. Martínez Ferrer, R. Buttay, G. Lehnasch, and A. Mura, “A detailed verification procedure for compressible reactive multicomponent Navier–Stokes solvers”, Comput. &amp; Fluids, vol. 89, pp. 88–110, Jan. 2014. Accessed: Oct. 13, 2024. [Online]. Available: <a href="https://doi.org/10.1016/j.compfluid.2013.10.014">https://doi.org/10.1016/j.compfluid.2013.10.014</a> </p>
260260
</blockquote>
261-
<h2><a class="anchor" id="autotoc_md57"></a>
261+
<h2><a class="anchor" id="autotoc_md59"></a>
262262
Initial Condition</h2>
263263
<div class="image">
264264
<img src="initial-1D_inert_shocktube-example.png" alt=""/>
265265
<div class="caption">
266266
Initial Condition</div></div>
267-
<h2><a class="anchor" id="autotoc_md58"></a>
267+
<h2><a class="anchor" id="autotoc_md60"></a>
268268
Results</h2>
269269
<p><img src="result-1D_inert_shocktube-example.png" alt="" class="inline" title="Results"/> </p>
270-
<h1><a class="anchor" id="autotoc_md59"></a>
270+
<h1><a class="anchor" id="autotoc_md61"></a>
271271
Isentropic vortex problem (2D)</h1>
272272
<p>Reference: Coralic, V., &amp; Colonius, T. (2014). Finite-volume Weno scheme for viscous compressible multicomponent flows. Journal of Computational Physics, 274, 95–121. <a href="https://doi.org/10.1016/j.jcp.2014.06.003">https://doi.org/10.1016/j.jcp.2014.06.003</a></p>
273-
<h2><a class="anchor" id="autotoc_md60"></a>
273+
<h2><a class="anchor" id="autotoc_md62"></a>
274274
Density</h2>
275275
<div class="image">
276276
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
277277
<div class="caption">
278278
Density</div></div>
279-
<h2><a class="anchor" id="autotoc_md61"></a>
279+
<h2><a class="anchor" id="autotoc_md63"></a>
280280
Density Norms</h2>
281281
<div class="image">
282282
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
283283
<div class="caption">
284284
Density Norms</div></div>
285-
<h1><a class="anchor" id="autotoc_md62"></a>
285+
<h1><a class="anchor" id="autotoc_md64"></a>
286286
Strong- &amp; Weak-scaling</h1>
287287
<p>The <a href="case.py"><b>Scaling</b></a> case can exercise both weak- and strong-scaling. It adjusts itself depending on the number of requested ranks.</p>
288288
<p>This directory also contains a collection of scripts used to test strong-scaling on OLCF Frontier. They required modifying MFC to collect some metrics but are meant to serve as a reference to users wishing to run similar experiments.</p>
289-
<h2><a class="anchor" id="autotoc_md63"></a>
289+
<h2><a class="anchor" id="autotoc_md65"></a>
290290
Weak Scaling</h2>
291291
<p>Pass <code>--scaling weak</code>. The <code>--memory</code> option controls (approximately) how much memory each rank should use, in Gigabytes. The number of cells in each dimension is then adjusted according to the number of requested ranks and an approximation for the relation between cell count and memory usage. The problem size increases linearly with the number of ranks.</p>
292-
<h2><a class="anchor" id="autotoc_md64"></a>
292+
<h2><a class="anchor" id="autotoc_md66"></a>
293293
Strong Scaling</h2>
294294
<p>Pass <code>--scaling strong</code>. The <code>--memory</code> option controls (approximately) how much memory should be used in total during simulation, across all ranks, in Gigabytes. The problem size remains constant as the number of ranks increases.</p>
295-
<h2><a class="anchor" id="autotoc_md65"></a>
295+
<h2><a class="anchor" id="autotoc_md67"></a>
296296
Example</h2>
297297
<p>For example, to run a weak-scaling test that uses ~4GB of GPU memory per rank on 8 2-rank nodes with case optimization, one could:</p>
298298
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
299299
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
300300
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
301-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md66"></a>
301+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md68"></a>
302302
IBM Bow Shock (3D)</h1>
303-
<h2><a class="anchor" id="autotoc_md67"></a>
303+
<h2><a class="anchor" id="autotoc_md69"></a>
304304
Final Condition</h2>
305305
<div class="image">
306306
<img src="result-3D_ibm_bowshock-example.png" alt=""/>
307307
<div class="caption">
308308
Density</div></div>
309-
<h1><a class="anchor" id="autotoc_md68"></a>
309+
<h1><a class="anchor" id="autotoc_md70"></a>
310310
Taylor-Green Vortex (3D)</h1>
311311
<p>Reference: Hillewaert, K. (2013). TestCase C3.5 - DNS of the transition of the Taylor-Green vortex, Re=1600 - Introduction and result summary. 2nd International Workshop on high-order methods for CFD.</p>
312-
<h2><a class="anchor" id="autotoc_md69"></a>
312+
<h2><a class="anchor" id="autotoc_md71"></a>
313313
Final Condition</h2>
314314
<p>This figure shows the isosurface with zero q-criterion. <img src="result-3D_TaylorGreenVortex-example.png" alt="" class="inline" title="Density"/> </p>
315-
<h1><a class="anchor" id="autotoc_md70"></a>
315+
<h1><a class="anchor" id="autotoc_md72"></a>
316316
Rayleigh-Taylor Instability (3D)</h1>
317-
<h2><a class="anchor" id="autotoc_md71"></a>
317+
<h2><a class="anchor" id="autotoc_md73"></a>
318318
Final Condition</h2>
319319
<div class="image">
320320
<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
321321
<div class="caption">
322322
Final Condition</div></div>
323-
<h2><a class="anchor" id="autotoc_md72"></a>
323+
<h2><a class="anchor" id="autotoc_md74"></a>
324324
Centerline Velocities</h2>
325325
<div class="image">
326326
<img src="linear_theory-3D_rayleigh_taylor-example.png" alt=""/>
327327
<div class="caption">
328328
Linear Theory Comparison</div></div>
329-
<h1><a class="anchor" id="autotoc_md73"></a>
329+
<h1><a class="anchor" id="autotoc_md75"></a>
330330
Rayleigh-Taylor Instability (2D)</h1>
331-
<h2><a class="anchor" id="autotoc_md74"></a>
331+
<h2><a class="anchor" id="autotoc_md76"></a>
332332
Final Condition</h2>
333333
<div class="image">
334334
<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
335335
<div class="caption">
336336
Final Condition</div></div>
337-
<h2><a class="anchor" id="autotoc_md75"></a>
337+
<h2><a class="anchor" id="autotoc_md77"></a>
338338
Centerline Velocities</h2>
339339
<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
340-
<h1><a class="anchor" id="autotoc_md76"></a>
340+
<h1><a class="anchor" id="autotoc_md78"></a>
341341
1D Multi-Component Reactive Shock Tube</h1>
342342
<p>References: </p><blockquote class="doxtable">
343343
<p>&zwj;P. J. Martínez Ferrer, R. Buttay, G. Lehnasch, and A. Mura, “A detailed verification procedure for compressible reactive multicomponent Navier–Stokes solvers”, Comput. &amp; Fluids, vol. 89, pp. 88–110, Jan. 2014. Accessed: Oct. 13, 2024. [Online]. Available: <a href="https://doi.org/10.1016/j.compfluid.2013.10.014">https://doi.org/10.1016/j.compfluid.2013.10.014</a> </p>
344344
</blockquote>
345345
<blockquote class="doxtable">
346346
<p>&zwj;H. Chen, C. Si, Y. Wu, H. Hu, and Y. Zhu, “Numerical investigation of the effect of equivalence ratio on the propagation characteristics and performance of rotating detonation engine”, Int. J. Hydrogen Energy, Mar. 2023. Accessed: Oct. 13, 2024. [Online]. Available: <a href="https://doi.org/10.1016/j.ijhydene.2023.03.190">https://doi.org/10.1016/j.ijhydene.2023.03.190</a> </p>
347347
</blockquote>
348-
<h2><a class="anchor" id="autotoc_md77"></a>
348+
<h2><a class="anchor" id="autotoc_md79"></a>
349349
Initial Condition</h2>
350350
<div class="image">
351351
<img src="initial-1D_reactive_shocktube-example.png" alt=""/>
352352
<div class="caption">
353353
Initial Condition</div></div>
354-
<h2><a class="anchor" id="autotoc_md78"></a>
354+
<h2><a class="anchor" id="autotoc_md80"></a>
355355
Results</h2>
356356
<div class="image">
357357
<img src="result-1D_reactive_shocktube-example.png" alt=""/>

0 commit comments

Comments
 (0)