Skip to content

Commit 006c7a3

Browse files
author
MFC Action
committed
Docs @ f032ad8
1 parent 039db69 commit 006c7a3

28 files changed

+336
-940
lines changed

‎documentation/doxygen_crawl.html‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,8 @@
88
<meta name="viewport" content="width=device-width, initial-scale=1"/>
99
</head>
1010
<body>
11-
<a href="md_authors.html"/>
12-
<a href="md_case.html"/>
13-
<a href="md_examples.html"/>
14-
<a href="md_expectedPerformance.html"/>
15-
<a href="md_getting-started.html"/>
16-
<a href="md_papers.html"/>
17-
<a href="md_references.html"/>
18-
<a href="md_running.html"/>
19-
<a href="md_testing.html"/>
20-
<a href="md_visualization.html"/>
21-
<a href="graph_legend.html"/>
22-
<a href="index.html"/>
2311
<a href="doxygen_crawl.html"/>
24-
<a href="pages.html"/>
12+
<a href="graph_legend.html"/>
2513
<a href="index.html"/>
2614
<a href="index.html#autotoc_md89"/>
2715
<a href="index.html#autotoc_md90"/>
@@ -134,5 +122,6 @@
134122
<a href="md_visualization.html#autotoc_md107"/>
135123
<a href="md_visualization.html#autotoc_md108"/>
136124
<a href="md_visualization.html#autotoc_md109"/>
125+
<a href="pages.html"/>
137126
</body>
138127
</html>

‎documentation/md_examples.html‎

Lines changed: 108 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -136,186 +136,183 @@
136136
<div class="contents">
137137
<div class="textblock"><p><a class="anchor" id="autotoc_md29"></a></p>
138138
<h1><a class="anchor" id="autotoc_md30"></a>
139-
Shock Droplet (2D)</h1>
140-
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
141-
<h2><a class="anchor" id="autotoc_md31"></a>
142-
Initial Condition</h2>
143-
<div class="image">
144-
<img src="initial-2D_shockdroplet-example.png" alt=""/>
145-
<div class="caption">
146-
Initial Condition</div></div>
147-
<h2><a class="anchor" id="autotoc_md32"></a>
148-
Result</h2>
149-
<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/> </p>
150-
<h1><a class="anchor" id="autotoc_md33"></a>
151-
Taylor-Green Vortex (3D)</h1>
152-
<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>
153-
<h2><a class="anchor" id="autotoc_md34"></a>
154-
Final Condition</h2>
155-
<p>This figure shows the isosurface with zero q-criterion. <img src="result-3D_TaylorGreenVortex-example.png" alt="" class="inline" title="Density"/> </p>
156-
<h1><a class="anchor" id="autotoc_md35"></a>
157-
Rayleigh-Taylor Instability (3D)</h1>
158-
<h2><a class="anchor" id="autotoc_md36"></a>
159-
Final Condition</h2>
160-
<div class="image">
161-
<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
162-
<div class="caption">
163-
Final Condition</div></div>
164-
<h2><a class="anchor" id="autotoc_md37"></a>
165-
Centerline Velocities</h2>
166-
<div class="image">
167-
<img src="linear_theory-3D_rayleigh_taylor-example.png" alt=""/>
168-
<div class="caption">
169-
Linear Theory Comparison</div></div>
170-
<h1><a class="anchor" id="autotoc_md38"></a>
171-
2D IBM CFL dt (2D)</h1>
172-
<h2><a class="anchor" id="autotoc_md39"></a>
173-
Result</h2>
174-
<div class="image">
175-
<img src="result-2D_ibm_cfl_dt-example.png" alt=""/>
176-
<div class="caption">
177-
Result</div></div>
178-
<h1><a class="anchor" id="autotoc_md40"></a>
179-
Rayleigh-Taylor Instability (2D)</h1>
180-
<h2><a class="anchor" id="autotoc_md41"></a>
181-
Final Condition</h2>
182-
<div class="image">
183-
<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
184-
<div class="caption">
185-
Final Condition</div></div>
186-
<h2><a class="anchor" id="autotoc_md42"></a>
187-
Centerline Velocities</h2>
188-
<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
189-
<h1><a class="anchor" id="autotoc_md43"></a>
190-
Strong- &amp; Weak-scaling</h1>
191-
<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>
192-
<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>
193-
<h2><a class="anchor" id="autotoc_md44"></a>
194-
Weak Scaling</h2>
195-
<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>
196-
<h2><a class="anchor" id="autotoc_md45"></a>
197-
Strong Scaling</h2>
198-
<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>
199-
<h2><a class="anchor" id="autotoc_md46"></a>
200-
Example</h2>
201-
<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>
202-
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
203-
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
204-
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
205-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md47"></a>
206139
2D Riemann Test (2D)</h1>
207140
<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>
208-
<h2><a class="anchor" id="autotoc_md48"></a>
141+
<h2><a class="anchor" id="autotoc_md31"></a>
209142
Density Initial Condition</h2>
210143
<div class="image">
211144
<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
212145
<div class="caption">
213146
Density</div></div>
214-
<h2><a class="anchor" id="autotoc_md49"></a>
147+
<h2><a class="anchor" id="autotoc_md32"></a>
215148
Density Final Condition</h2>
216149
<div class="image">
217150
<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
218151
<div class="caption">
219152
Density Norms</div></div>
220-
<h1><a class="anchor" id="autotoc_md50"></a>
221-
IBM Bow Shock (3D)</h1>
222-
<h2><a class="anchor" id="autotoc_md51"></a>
223-
Final Condition</h2>
224-
<div class="image">
225-
<img src="result-3D_ibm_bowshock-example.png" alt=""/>
226-
<div class="caption">
227-
Density</div></div>
228-
<h1><a class="anchor" id="autotoc_md52"></a>
153+
<h1><a class="anchor" id="autotoc_md33"></a>
229154
Titarev-Toro problem (1D)</h1>
230155
<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>
231-
<h2><a class="anchor" id="autotoc_md53"></a>
156+
<h2><a class="anchor" id="autotoc_md34"></a>
232157
Initial Condition</h2>
233158
<div class="image">
234159
<img src="initial-1D_titarevtorro-example.png" alt=""/>
235160
<div class="caption">
236161
Initial Condition</div></div>
237-
<h2><a class="anchor" id="autotoc_md54"></a>
162+
<h2><a class="anchor" id="autotoc_md35"></a>
238163
Result</h2>
239164
<div class="image">
240165
<img src="result-1D_titarevtorro-example.png" alt=""/>
241166
<div class="caption">
242167
Result</div></div>
243-
<h1><a class="anchor" id="autotoc_md55"></a>
168+
<h1><a class="anchor" id="autotoc_md36"></a>
169+
2D IBM CFL dt (2D)</h1>
170+
<h2><a class="anchor" id="autotoc_md37"></a>
171+
Result</h2>
172+
<div class="image">
173+
<img src="result-2D_ibm_cfl_dt-example.png" alt=""/>
174+
<div class="caption">
175+
Result</div></div>
176+
<h1><a class="anchor" id="autotoc_md38"></a>
244177
Shu-Osher problem (1D)</h1>
245178
<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>
246-
<h2><a class="anchor" id="autotoc_md56"></a>
179+
<h2><a class="anchor" id="autotoc_md39"></a>
247180
Initial Condition</h2>
248181
<div class="image">
249182
<img src="initial-1D_shuosher_old-example.png" alt=""/>
250183
<div class="caption">
251184
Initial Condition</div></div>
252-
<h2><a class="anchor" id="autotoc_md57"></a>
185+
<h2><a class="anchor" id="autotoc_md40"></a>
253186
Result</h2>
254187
<div class="image">
255188
<img src="result-1D_shuosher_old-example.png" alt=""/>
256189
<div class="caption">
257190
Result</div></div>
258-
<h1><a class="anchor" id="autotoc_md58"></a>
191+
<h1><a class="anchor" id="autotoc_md41"></a>
259192
Isentropic vortex problem (2D)</h1>
260193
<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>
261-
<h2><a class="anchor" id="autotoc_md59"></a>
194+
<h2><a class="anchor" id="autotoc_md42"></a>
262195
Density</h2>
263196
<div class="image">
264197
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
265198
<div class="caption">
266199
Density</div></div>
267-
<h2><a class="anchor" id="autotoc_md60"></a>
200+
<h2><a class="anchor" id="autotoc_md43"></a>
268201
Density Norms</h2>
269202
<div class="image">
270203
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
271204
<div class="caption">
272205
Density Norms</div></div>
273-
<h1><a class="anchor" id="autotoc_md61"></a>
274-
Lid-Driven Cavity Problem (2D)</h1>
275-
<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>
276-
<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>
277-
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
278-
<h2><a class="anchor" id="autotoc_md62"></a>
279-
Final Condition</h2>
280-
<div class="image">
281-
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
282-
<div class="caption">
283-
Final Condition</div></div>
284-
<h2><a class="anchor" id="autotoc_md63"></a>
285-
Centerline Velocities</h2>
286-
<div class="image">
287-
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
288-
<div class="caption">
289-
Centerline Velocities</div></div>
290-
<h1><a class="anchor" id="autotoc_md64"></a>
206+
<h1><a class="anchor" id="autotoc_md44"></a>
291207
Lax shock tube problem (1D)</h1>
292208
<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>
293-
<h2><a class="anchor" id="autotoc_md65"></a>
209+
<h2><a class="anchor" id="autotoc_md45"></a>
294210
Initial Condition</h2>
295211
<div class="image">
296212
<img src="initial-1D_laxshocktube-example.png" alt=""/>
297213
<div class="caption">
298214
Initial Condition</div></div>
299-
<h2><a class="anchor" id="autotoc_md66"></a>
215+
<h2><a class="anchor" id="autotoc_md46"></a>
300216
Result</h2>
301217
<div class="image">
302218
<img src="result-1D_laxshocktube-example.png" alt=""/>
303219
<div class="caption">
304220
Result</div></div>
305-
<h1><a class="anchor" id="autotoc_md67"></a>
221+
<h1><a class="anchor" id="autotoc_md47"></a>
222+
IBM Bow Shock (3D)</h1>
223+
<h2><a class="anchor" id="autotoc_md48"></a>
224+
Final Condition</h2>
225+
<div class="image">
226+
<img src="result-3D_ibm_bowshock-example.png" alt=""/>
227+
<div class="caption">
228+
Density</div></div>
229+
<h1><a class="anchor" id="autotoc_md49"></a>
230+
Strong- &amp; Weak-scaling</h1>
231+
<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>
232+
<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>
233+
<h2><a class="anchor" id="autotoc_md50"></a>
234+
Weak Scaling</h2>
235+
<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>
236+
<h2><a class="anchor" id="autotoc_md51"></a>
237+
Strong Scaling</h2>
238+
<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>
239+
<h2><a class="anchor" id="autotoc_md52"></a>
240+
Example</h2>
241+
<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>
242+
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
243+
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
244+
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
245+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md53"></a>
246+
Shock Droplet (2D)</h1>
247+
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
248+
<h2><a class="anchor" id="autotoc_md54"></a>
249+
Initial Condition</h2>
250+
<div class="image">
251+
<img src="initial-2D_shockdroplet-example.png" alt=""/>
252+
<div class="caption">
253+
Initial Condition</div></div>
254+
<h2><a class="anchor" id="autotoc_md55"></a>
255+
Result</h2>
256+
<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/> </p>
257+
<h1><a class="anchor" id="autotoc_md56"></a>
258+
Rayleigh-Taylor Instability (2D)</h1>
259+
<h2><a class="anchor" id="autotoc_md57"></a>
260+
Final Condition</h2>
261+
<div class="image">
262+
<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
263+
<div class="caption">
264+
Final Condition</div></div>
265+
<h2><a class="anchor" id="autotoc_md58"></a>
266+
Centerline Velocities</h2>
267+
<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
268+
<h1><a class="anchor" id="autotoc_md59"></a>
306269
2D Hardcodied IC Example</h1>
307-
<h2><a class="anchor" id="autotoc_md68"></a>
270+
<h2><a class="anchor" id="autotoc_md60"></a>
308271
Initial Condition</h2>
309272
<div class="image">
310273
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
311274
<div class="caption">
312275
Initial Condition</div></div>
313-
<h2><a class="anchor" id="autotoc_md69"></a>
276+
<h2><a class="anchor" id="autotoc_md61"></a>
314277
Result</h2>
278+
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
279+
<h1><a class="anchor" id="autotoc_md62"></a>
280+
Taylor-Green Vortex (3D)</h1>
281+
<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>
282+
<h2><a class="anchor" id="autotoc_md63"></a>
283+
Final Condition</h2>
284+
<p>This figure shows the isosurface with zero q-criterion. <img src="result-3D_TaylorGreenVortex-example.png" alt="" class="inline" title="Density"/> </p>
285+
<h1><a class="anchor" id="autotoc_md64"></a>
286+
Lid-Driven Cavity Problem (2D)</h1>
287+
<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>
288+
<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>
289+
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
290+
<h2><a class="anchor" id="autotoc_md65"></a>
291+
Final Condition</h2>
315292
<div class="image">
316-
<img src="result-2D_hardcodied_ic-example.png" alt=""/>
293+
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
317294
<div class="caption">
318-
Result</div></div>
295+
Final Condition</div></div>
296+
<h2><a class="anchor" id="autotoc_md66"></a>
297+
Centerline Velocities</h2>
298+
<div class="image">
299+
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
300+
<div class="caption">
301+
Centerline Velocities</div></div>
302+
<h1><a class="anchor" id="autotoc_md67"></a>
303+
Rayleigh-Taylor Instability (3D)</h1>
304+
<h2><a class="anchor" id="autotoc_md68"></a>
305+
Final Condition</h2>
306+
<div class="image">
307+
<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
308+
<div class="caption">
309+
Final Condition</div></div>
310+
<h2><a class="anchor" id="autotoc_md69"></a>
311+
Centerline Velocities</h2>
312+
<div class="image">
313+
<img src="linear_theory-3D_rayleigh_taylor-example.png" alt=""/>
314+
<div class="caption">
315+
Linear Theory Comparison</div></div>
319316
</div></div><!-- contents -->
320317
</div><!-- PageDoc -->
321318
</div><!-- doc-content -->

0 commit comments

Comments
 (0)