Skip to content

Commit dbfe1e2

Browse files
author
MFC Action
committed
Docs @ 8230af1
1 parent 2e5cda6 commit dbfe1e2

File tree

1,706 files changed

+94668
-49816
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,706 files changed

+94668
-49816
lines changed

documentation/doxygen_crawl.html

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@
4343
<a href="md_case.html#autotoc_md33"/>
4444
<a href="md_case.html#autotoc_md34"/>
4545
<a href="md_case.html#autotoc_md35"/>
46+
<a href="md_case.html#autotoc_md36"/>
4647
<a href="md_case.html#autotoc_md4"/>
4748
<a href="md_case.html#autotoc_md5"/>
4849
<a href="md_case.html#autotoc_md6"/>
4950
<a href="md_case.html#autotoc_md7"/>
5051
<a href="md_case.html#autotoc_md8"/>
5152
<a href="md_case.html#autotoc_md9"/>
5253
<a href="md_examples.html"/>
53-
<a href="md_examples.html#autotoc_md37"/>
5454
<a href="md_examples.html#autotoc_md38"/>
5555
<a href="md_examples.html#autotoc_md39"/>
5656
<a href="md_examples.html#autotoc_md40"/>
@@ -95,48 +95,51 @@
9595
<a href="md_examples.html#autotoc_md79"/>
9696
<a href="md_examples.html#autotoc_md80"/>
9797
<a href="md_examples.html#autotoc_md81"/>
98+
<a href="md_examples.html#autotoc_md82"/>
99+
<a href="md_examples.html#autotoc_md83"/>
100+
<a href="md_examples.html#autotoc_md84"/>
98101
<a href="md_expectedPerformance.html"/>
99-
<a href="md_expectedPerformance.html#autotoc_md83"/>
100-
<a href="md_expectedPerformance.html#autotoc_md84"/>
101-
<a href="md_expectedPerformance.html#autotoc_md85"/>
102102
<a href="md_expectedPerformance.html#autotoc_md86"/>
103103
<a href="md_expectedPerformance.html#autotoc_md87"/>
104104
<a href="md_expectedPerformance.html#autotoc_md88"/>
105105
<a href="md_expectedPerformance.html#autotoc_md89"/>
106106
<a href="md_expectedPerformance.html#autotoc_md90"/>
107107
<a href="md_expectedPerformance.html#autotoc_md91"/>
108108
<a href="md_expectedPerformance.html#autotoc_md92"/>
109+
<a href="md_expectedPerformance.html#autotoc_md93"/>
110+
<a href="md_expectedPerformance.html#autotoc_md94"/>
111+
<a href="md_expectedPerformance.html#autotoc_md95"/>
109112
<a href="md_getting-started.html"/>
110-
<a href="md_getting-started.html#autotoc_md94"/>
111-
<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_md100"/>
114+
<a href="md_getting-started.html#autotoc_md101"/>
113115
<a href="md_getting-started.html#autotoc_md97"/>
114116
<a href="md_getting-started.html#autotoc_md98"/>
117+
<a href="md_getting-started.html#autotoc_md99"/>
115118
<a href="md_papers.html"/>
116119
<a href="md_readme.html"/>
117-
<a href="md_readme.html#autotoc_md101"/>
118-
<a href="md_readme.html#autotoc_md102"/>
120+
<a href="md_readme.html#autotoc_md104"/>
121+
<a href="md_readme.html#autotoc_md105"/>
119122
<a href="md_references.html"/>
120123
<a href="md_running.html"/>
121-
<a href="md_running.html#autotoc_md105"/>
122-
<a href="md_running.html#autotoc_md106"/>
123-
<a href="md_running.html#autotoc_md107"/>
124124
<a href="md_running.html#autotoc_md108"/>
125125
<a href="md_running.html#autotoc_md109"/>
126126
<a href="md_running.html#autotoc_md110"/>
127127
<a href="md_running.html#autotoc_md111"/>
128+
<a href="md_running.html#autotoc_md112"/>
129+
<a href="md_running.html#autotoc_md113"/>
130+
<a href="md_running.html#autotoc_md114"/>
128131
<a href="md_testing.html"/>
129-
<a href="md_testing.html#autotoc_md113"/>
130-
<a href="md_testing.html#autotoc_md114"/>
132+
<a href="md_testing.html#autotoc_md116"/>
133+
<a href="md_testing.html#autotoc_md117"/>
131134
<a href="md_visualization.html"/>
132-
<a href="md_visualization.html#autotoc_md116"/>
133-
<a href="md_visualization.html#autotoc_md117"/>
134-
<a href="md_visualization.html#autotoc_md118"/>
135135
<a href="md_visualization.html#autotoc_md119"/>
136136
<a href="md_visualization.html#autotoc_md120"/>
137137
<a href="md_visualization.html#autotoc_md121"/>
138138
<a href="md_visualization.html#autotoc_md122"/>
139139
<a href="md_visualization.html#autotoc_md123"/>
140+
<a href="md_visualization.html#autotoc_md124"/>
141+
<a href="md_visualization.html#autotoc_md125"/>
142+
<a href="md_visualization.html#autotoc_md126"/>
140143
<a href="pages.html"/>
141144
</body>
142145
</html>
Loading

documentation/md_case.html

Lines changed: 49 additions & 20 deletions
Large diffs are not rendered by default.

documentation/md_examples.html

Lines changed: 51 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -135,30 +135,30 @@
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_md36"></a></p>
139-
<h1><a class="anchor" id="autotoc_md37"></a>
138+
<div class="textblock"><p><a class="anchor" id="autotoc_md37"></a></p>
139+
<h1><a class="anchor" id="autotoc_md38"></a>
140140
Shu-Osher problem (1D)</h1>
141141
<p>Reference: </p><blockquote class="doxtable">
142142
<p>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>
143143
</blockquote>
144-
<h2><a class="anchor" id="autotoc_md38"></a>
144+
<h2><a class="anchor" id="autotoc_md39"></a>
145145
Initial Condition</h2>
146146
<p><img src="initial-1D_shuosher_old-example.png" alt="" height="400" class="inline"/></p>
147-
<h2><a class="anchor" id="autotoc_md39"></a>
147+
<h2><a class="anchor" id="autotoc_md40"></a>
148148
Result</h2>
149149
<p><img src="result-1D_shuosher_old-example.png" alt="" height="400" class="inline"/></p>
150-
<h1><a class="anchor" id="autotoc_md40"></a>
150+
<h1><a class="anchor" id="autotoc_md41"></a>
151151
Titarev-Toro problem (1D)</h1>
152152
<p>Reference: </p><blockquote class="doxtable">
153153
<p>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>
154154
</blockquote>
155-
<h2><a class="anchor" id="autotoc_md41"></a>
155+
<h2><a class="anchor" id="autotoc_md42"></a>
156156
Initial Condition</h2>
157157
<p><img src="initial-1D_titarevtorro-example.png" alt="" heiht="400" class="inline"/></p>
158-
<h2><a class="anchor" id="autotoc_md42"></a>
158+
<h2><a class="anchor" id="autotoc_md43"></a>
159159
Result</h2>
160160
<p><img src="result-1D_titarevtorro-example.png" alt="" heiht="400" class="inline"/></p>
161-
<h1><a class="anchor" id="autotoc_md43"></a>
161+
<h1><a class="anchor" id="autotoc_md44"></a>
162162
Lid-Driven Cavity Problem (2D)</h1>
163163
<p>Reference: </p><blockquote class="doxtable">
164164
<p>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>
@@ -167,53 +167,58 @@ <h1><a class="anchor" id="autotoc_md43"></a>
167167
<p>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>
168168
</blockquote>
169169
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
170-
<h2><a class="anchor" id="autotoc_md44"></a>
170+
<h2><a class="anchor" id="autotoc_md45"></a>
171171
Final Condition</h2>
172172
<p><img src="final_condition-2D_lid_driven_cavity-example.png" alt="" height="400" class="inline"/></p>
173-
<h2><a class="anchor" id="autotoc_md45"></a>
173+
<h2><a class="anchor" id="autotoc_md46"></a>
174174
Centerline Velocities</h2>
175175
<p><img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt="" height="400" class="inline"/></p>
176-
<h1><a class="anchor" id="autotoc_md46"></a>
176+
<h1><a class="anchor" id="autotoc_md47"></a>
177177
2D Triple Point (2D)</h1>
178178
<p>Reference: </p><blockquote class="doxtable">
179179
<p>Trojak, W., &amp; Dzanic, T. Positivity-preserving discoutinous spectral element method for compressible multi-species flows. arXiv:2308.02426 </p>
180180
</blockquote>
181-
<h2><a class="anchor" id="autotoc_md47"></a>
181+
<h2><a class="anchor" id="autotoc_md48"></a>
182182
Numerical Schlieren at Final Time</h2>
183183
<p><img src="final-2D_triple_point-example.png" alt="" height="400" class="inline"/></p>
184-
<h1><a class="anchor" id="autotoc_md48"></a>
184+
<h1><a class="anchor" id="autotoc_md49"></a>
185+
Gas Jet (2D)</h1>
186+
<h2><a class="anchor" id="autotoc_md50"></a>
187+
Final Condition</h2>
188+
<p><img src="final_condition-2D_jet-example.png" alt="" height="400" class="inline"/></p>
189+
<h1><a class="anchor" id="autotoc_md51"></a>
185190
2D Hardcodied IC Example</h1>
186-
<h2><a class="anchor" id="autotoc_md49"></a>
191+
<h2><a class="anchor" id="autotoc_md52"></a>
187192
Initial Condition and Result</h2>
188193
<p><img src="initial-2D_hardcodied_ic-example.png" alt="" width="45%" class="inline"/> <img src="result-2D_hardcodied_ic-example.png" alt="" width="45%" class="inline"/></p>
189-
<h1><a class="anchor" id="autotoc_md50"></a>
194+
<h1><a class="anchor" id="autotoc_md53"></a>
190195
Shock Droplet (2D)</h1>
191196
<p>Reference: </p><blockquote class="doxtable">
192197
<p>Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023) </p>
193198
</blockquote>
194-
<h2><a class="anchor" id="autotoc_md51"></a>
199+
<h2><a class="anchor" id="autotoc_md54"></a>
195200
Initial Condition</h2>
196201
<p><img src="initial-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
197-
<h2><a class="anchor" id="autotoc_md52"></a>
202+
<h2><a class="anchor" id="autotoc_md55"></a>
198203
Result</h2>
199204
<p><img src="result-2D_shockdroplet-example.png" alt="" height="400" class="inline"/></p>
200-
<h1><a class="anchor" id="autotoc_md53"></a>
205+
<h1><a class="anchor" id="autotoc_md56"></a>
201206
Rayleigh-Taylor Instability (2D)</h1>
202-
<h2><a class="anchor" id="autotoc_md54"></a>
207+
<h2><a class="anchor" id="autotoc_md57"></a>
203208
Final Condition and Linear Theory</h2>
204209
<p><img src="final_condition-2D_rayleigh_taylor-example.png" alt="" height="400" class="inline"/> <img src="linear_theory-2D_rayleigh_taylor-example.png" alt="" height="400" class="inline"/></p>
205-
<h1><a class="anchor" id="autotoc_md55"></a>
210+
<h1><a class="anchor" id="autotoc_md58"></a>
206211
Lax shock tube problem (1D)</h1>
207212
<p>Reference: </p><blockquote class="doxtable">
208213
<p>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>
209214
</blockquote>
210-
<h2><a class="anchor" id="autotoc_md56"></a>
215+
<h2><a class="anchor" id="autotoc_md59"></a>
211216
Initial Condition</h2>
212217
<p><img src="initial-1D_laxshocktube-example.png" alt="" height="400" class="inline"/></p>
213-
<h2><a class="anchor" id="autotoc_md57"></a>
218+
<h2><a class="anchor" id="autotoc_md60"></a>
214219
Result</h2>
215220
<p><img src="result-1D_laxshocktube-example.png" alt="" height="400" class="inline"/></p>
216-
<h1><a class="anchor" id="autotoc_md58"></a>
221+
<h1><a class="anchor" id="autotoc_md61"></a>
217222
Perfectly Stirred Reactor</h1>
218223
<p>Reference: </p><blockquote class="doxtable">
219224
<p>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>
@@ -224,88 +229,88 @@ <h1><a class="anchor" id="autotoc_md58"></a>
224229
<div class="line"> + Cantera: 5.130e-05 s</div>
225230
<div class="line"> + (Che)MFC: 5.130e-05 s</div>
226231
</div><!-- fragment --><p><img src="result-nD_perfect_reactor-example.png" alt="" height="400" class="inline"/></p>
227-
<h1><a class="anchor" id="autotoc_md59"></a>
232+
<h1><a class="anchor" id="autotoc_md62"></a>
228233
IBM Bow Shock (3D)</h1>
229-
<h2><a class="anchor" id="autotoc_md60"></a>
234+
<h2><a class="anchor" id="autotoc_md63"></a>
230235
Final Condition</h2>
231236
<p><img src="result-3D_ibm_bowshock-example.png" alt="" height="400" class="inline"/></p>
232-
<h1><a class="anchor" id="autotoc_md61"></a>
237+
<h1><a class="anchor" id="autotoc_md64"></a>
233238
Taylor-Green Vortex (3D)</h1>
234239
<p>Reference: </p><blockquote class="doxtable">
235240
<p>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>
236241
</blockquote>
237-
<h2><a class="anchor" id="autotoc_md62"></a>
242+
<h2><a class="anchor" id="autotoc_md65"></a>
238243
Final Condition</h2>
239244
<p>This figure shows the isosurface with zero q-criterion.</p>
240245
<p><img src="result-3D_TaylorGreenVortex-example.png" alt="" height="400" class="inline"/></p>
241-
<h1><a class="anchor" id="autotoc_md63"></a>
246+
<h1><a class="anchor" id="autotoc_md66"></a>
242247
1D Multi-Component Inert Shock Tube</h1>
243248
<p>Reference: </p><blockquote class="doxtable">
244249
<p>P. J. Martínez Ferrer, R. Buttay, G. Lehnasch, and A. Mura, “A detailed verification procedure for compressible reactive multicomponent Navier–Stokes solvers”, Computers &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>
245250
</blockquote>
246-
<h2><a class="anchor" id="autotoc_md64"></a>
251+
<h2><a class="anchor" id="autotoc_md67"></a>
247252
Initial Condition</h2>
248253
<p><img src="initial-1D_inert_shocktube-example.png" alt="" height="400" class="inline"/></p>
249-
<h2><a class="anchor" id="autotoc_md65"></a>
254+
<h2><a class="anchor" id="autotoc_md68"></a>
250255
Results</h2>
251256
<p><img src="result-1D_inert_shocktube-example.png" alt="" height="400" class="inline"/></p>
252-
<h1><a class="anchor" id="autotoc_md66"></a>
257+
<h1><a class="anchor" id="autotoc_md69"></a>
253258
Strong- &amp; Weak-scaling</h1>
254259
<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>
255260
<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>
256-
<h2><a class="anchor" id="autotoc_md67"></a>
261+
<h2><a class="anchor" id="autotoc_md70"></a>
257262
Weak Scaling</h2>
258263
<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>
259-
<h2><a class="anchor" id="autotoc_md68"></a>
264+
<h2><a class="anchor" id="autotoc_md71"></a>
260265
Strong Scaling</h2>
261266
<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>
262-
<h2><a class="anchor" id="autotoc_md69"></a>
267+
<h2><a class="anchor" id="autotoc_md72"></a>
263268
Example</h2>
264269
<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>
265270
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
266271
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
267272
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
268-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md70"></a>
273+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md73"></a>
269274
2D Riemann Test (2D)</h1>
270275
<p>Reference: </p><blockquote class="doxtable">
271276
<p>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>
272277
</blockquote>
273-
<h2><a class="anchor" id="autotoc_md71"></a>
278+
<h2><a class="anchor" id="autotoc_md74"></a>
274279
Density Initial and Final Conditions</h2>
275280
<p><img src="alpha_rho1_initial-2D_riemann_test-example.png" alt="" width="45%" class="inline"/> <img src="alpha_rho1_final-2D_riemann_test-example.png" alt="" width="45%" class="inline"/></p>
276-
<h1><a class="anchor" id="autotoc_md72"></a>
281+
<h1><a class="anchor" id="autotoc_md75"></a>
277282
Rayleigh-Taylor Instability (3D)</h1>
278-
<h2><a class="anchor" id="autotoc_md73"></a>
283+
<h2><a class="anchor" id="autotoc_md76"></a>
279284
Final Condition and Linear Theory</h2>
280285
<p><img src="final_condition-3D_rayleigh_taylor-example.png" alt="" height="400" class="inline"/> <img src="linear_theory-3D_rayleigh_taylor-example.png" alt="" height="400" class="inline"/></p>
281-
<h1><a class="anchor" id="autotoc_md74"></a>
286+
<h1><a class="anchor" id="autotoc_md77"></a>
282287
1D Multi-Component Reactive Shock Tube</h1>
283288
<p>References: </p><blockquote class="doxtable">
284289
<p>P. J. Martínez Ferrer, R. Buttay, G. Lehnasch, and A. Mura, “A detailed verification procedure for compressible reactive multicomponent Navier–Stokes solvers”, Computers &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>
285290
</blockquote>
286291
<blockquote class="doxtable">
287292
<p>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>
288293
</blockquote>
289-
<h2><a class="anchor" id="autotoc_md75"></a>
294+
<h2><a class="anchor" id="autotoc_md78"></a>
290295
Initial Condition</h2>
291296
<p><img src="initial-1D_reactive_shocktube-example.png" alt="" height="400" class="inline"/></p>
292-
<h2><a class="anchor" id="autotoc_md76"></a>
297+
<h2><a class="anchor" id="autotoc_md79"></a>
293298
Results</h2>
294299
<p><img src="result-1D_reactive_shocktube-example.png" alt="" height="400" class="inline"/></p>
295-
<h1><a class="anchor" id="autotoc_md77"></a>
300+
<h1><a class="anchor" id="autotoc_md80"></a>
296301
Isentropic vortex problem (2D)</h1>
297302
<p>Reference: </p><blockquote class="doxtable">
298303
<p>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>
299304
</blockquote>
300-
<h2><a class="anchor" id="autotoc_md78"></a>
305+
<h2><a class="anchor" id="autotoc_md81"></a>
301306
Density</h2>
302307
<p><img src="alpha_rho1-2D_isentropicvortex-example.png" alt="" height="400" class="inline"/></p>
303-
<h2><a class="anchor" id="autotoc_md79"></a>
308+
<h2><a class="anchor" id="autotoc_md82"></a>
304309
Density Norms</h2>
305310
<p><img src="density_norms-2D_isentropicvortex-example.png" alt="" height="400" class="inline"/></p>
306-
<h1><a class="anchor" id="autotoc_md80"></a>
311+
<h1><a class="anchor" id="autotoc_md83"></a>
307312
2D IBM CFL dt (2D)</h1>
308-
<h2><a class="anchor" id="autotoc_md81"></a>
313+
<h2><a class="anchor" id="autotoc_md84"></a>
309314
Result</h2>
310315
<p><img src="result-2D_ibm_cfl_dt-example.png" alt="" height="400" class="inline"/> </p>
311316
</div></div><!-- contents -->

0 commit comments

Comments
 (0)