Skip to content

Commit 181457d

Browse files
author
MFC Action
committed
Docs @ 55dfcf5
1 parent 271d948 commit 181457d

File tree

21 files changed

+198
-201
lines changed

21 files changed

+198
-201
lines changed

‎documentation/md_examples.html‎

Lines changed: 94 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -136,161 +136,158 @@
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+
Strong- &amp; Weak-scaling</h1>
140+
<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>
141+
<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>
142+
<h2><a class="anchor" id="autotoc_md31"></a>
143+
Weak Scaling</h2>
144+
<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>
145+
<h2><a class="anchor" id="autotoc_md32"></a>
146+
Strong Scaling</h2>
147+
<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>
148+
<h2><a class="anchor" id="autotoc_md33"></a>
149+
Example</h2>
150+
<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>
151+
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
152+
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
153+
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
154+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md34"></a>
155+
Lid-Driven Cavity Problem (2D)</h1>
156+
<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>
157+
<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>
158+
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
159+
<h2><a class="anchor" id="autotoc_md35"></a>
160+
Final Condition</h2>
161+
<div class="image">
162+
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
163+
<div class="caption">
164+
Final Condition</div></div>
165+
<h2><a class="anchor" id="autotoc_md36"></a>
166+
Centerline Velocities</h2>
167+
<div class="image">
168+
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
169+
<div class="caption">
170+
Centerline Velocities</div></div>
171+
<h1><a class="anchor" id="autotoc_md37"></a>
172+
Lax shock tube problem (1D)</h1>
173+
<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>
174+
<h2><a class="anchor" id="autotoc_md38"></a>
175+
Initial Condition</h2>
176+
<div class="image">
177+
<img src="initial-1D_laxshocktube-example.png" alt=""/>
178+
<div class="caption">
179+
Initial Condition</div></div>
180+
<h2><a class="anchor" id="autotoc_md39"></a>
181+
Result</h2>
182+
<div class="image">
183+
<img src="result-1D_laxshocktube-example.png" alt=""/>
184+
<div class="caption">
185+
Result</div></div>
186+
<h1><a class="anchor" id="autotoc_md40"></a>
139187
Shu-Osher problem (1D)</h1>
140188
<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>
141-
<h2><a class="anchor" id="autotoc_md31"></a>
189+
<h2><a class="anchor" id="autotoc_md41"></a>
142190
Initial Condition</h2>
143191
<div class="image">
144192
<img src="initial-1D_shuosher_old-example.png" alt=""/>
145193
<div class="caption">
146194
Initial Condition</div></div>
147-
<h2><a class="anchor" id="autotoc_md32"></a>
195+
<h2><a class="anchor" id="autotoc_md42"></a>
148196
Result</h2>
149197
<div class="image">
150198
<img src="result-1D_shuosher_old-example.png" alt=""/>
151199
<div class="caption">
152200
Result</div></div>
153-
<h1><a class="anchor" id="autotoc_md33"></a>
154-
2D Riemann Test (2D)</h1>
155-
<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>
156-
<h2><a class="anchor" id="autotoc_md34"></a>
157-
Density Initial Condition</h2>
158-
<div class="image">
159-
<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
160-
<div class="caption">
161-
Density</div></div>
162-
<h2><a class="anchor" id="autotoc_md35"></a>
163-
Density Final Condition</h2>
201+
<h1><a class="anchor" id="autotoc_md43"></a>
202+
Shock Droplet (2D)</h1>
203+
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
204+
<h2><a class="anchor" id="autotoc_md44"></a>
205+
Initial Condition</h2>
164206
<div class="image">
165-
<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
207+
<img src="initial-2D_shockdroplet-example.png" alt=""/>
166208
<div class="caption">
167-
Density Norms</div></div>
168-
<h1><a class="anchor" id="autotoc_md36"></a>
209+
Initial Condition</div></div>
210+
<h2><a class="anchor" id="autotoc_md45"></a>
211+
Result</h2>
212+
<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/> </p>
213+
<h1><a class="anchor" id="autotoc_md46"></a>
169214
Titarev-Toro problem (1D)</h1>
170215
<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>
171-
<h2><a class="anchor" id="autotoc_md37"></a>
216+
<h2><a class="anchor" id="autotoc_md47"></a>
172217
Initial Condition</h2>
173218
<div class="image">
174219
<img src="initial-1D_titarevtorro-example.png" alt=""/>
175220
<div class="caption">
176221
Initial Condition</div></div>
177-
<h2><a class="anchor" id="autotoc_md38"></a>
222+
<h2><a class="anchor" id="autotoc_md48"></a>
178223
Result</h2>
179224
<div class="image">
180225
<img src="result-1D_titarevtorro-example.png" alt=""/>
181226
<div class="caption">
182227
Result</div></div>
183-
<h1><a class="anchor" id="autotoc_md39"></a>
184-
Rayleigh-Taylor Instability (2D)</h1>
185-
<h2><a class="anchor" id="autotoc_md40"></a>
228+
<h1><a class="anchor" id="autotoc_md49"></a>
229+
Rayleigh-Taylor Instability (3D)</h1>
230+
<h2><a class="anchor" id="autotoc_md50"></a>
186231
Final Condition</h2>
187232
<div class="image">
188-
<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
233+
<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
189234
<div class="caption">
190235
Final Condition</div></div>
191-
<h2><a class="anchor" id="autotoc_md41"></a>
236+
<h2><a class="anchor" id="autotoc_md51"></a>
192237
Centerline Velocities</h2>
193238
<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
194-
<h1><a class="anchor" id="autotoc_md42"></a>
195-
Isentropic vortex problem (2D)</h1>
196-
<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>
197-
<h2><a class="anchor" id="autotoc_md43"></a>
198-
Density</h2>
199-
<div class="image">
200-
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
201-
<div class="caption">
202-
Density</div></div>
203-
<h2><a class="anchor" id="autotoc_md44"></a>
204-
Density Norms</h2>
205-
<div class="image">
206-
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
207-
<div class="caption">
208-
Density Norms</div></div>
209-
<h1><a class="anchor" id="autotoc_md45"></a>
210-
2D Hardcodied IC Example</h1>
211-
<h2><a class="anchor" id="autotoc_md46"></a>
212-
Initial Condition</h2>
213-
<div class="image">
214-
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
215-
<div class="caption">
216-
Initial Condition</div></div>
217-
<h2><a class="anchor" id="autotoc_md47"></a>
218-
Result</h2>
219-
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
220-
<h1><a class="anchor" id="autotoc_md48"></a>
221-
Rayleigh-Taylor Instability (3D)</h1>
222-
<h2><a class="anchor" id="autotoc_md49"></a>
239+
<h1><a class="anchor" id="autotoc_md52"></a>
240+
Rayleigh-Taylor Instability (2D)</h1>
241+
<h2><a class="anchor" id="autotoc_md53"></a>
223242
Final Condition</h2>
224243
<div class="image">
225-
<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
244+
<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
226245
<div class="caption">
227246
Final Condition</div></div>
228-
<h2><a class="anchor" id="autotoc_md50"></a>
247+
<h2><a class="anchor" id="autotoc_md54"></a>
229248
Centerline Velocities</h2>
230249
<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
231-
<h1><a class="anchor" id="autotoc_md51"></a>
232-
Strong- &amp; Weak-scaling</h1>
233-
<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>
234-
<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>
235-
<h2><a class="anchor" id="autotoc_md52"></a>
236-
Weak Scaling</h2>
237-
<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>
238-
<h2><a class="anchor" id="autotoc_md53"></a>
239-
Strong Scaling</h2>
240-
<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>
241-
<h2><a class="anchor" id="autotoc_md54"></a>
242-
Example</h2>
243-
<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>
244-
<div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation \</div>
245-
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
246-
<div class="line"> --case-optimization -j 32 -- --scaling weak --memory 4</div>
247-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md55"></a>
248-
Lid-Driven Cavity Problem (2D)</h1>
249-
<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>
250-
<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>
251-
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
250+
<h1><a class="anchor" id="autotoc_md55"></a>
251+
2D Riemann Test (2D)</h1>
252+
<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>
252253
<h2><a class="anchor" id="autotoc_md56"></a>
253-
Final Condition</h2>
254+
Density Initial Condition</h2>
254255
<div class="image">
255-
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
256+
<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
256257
<div class="caption">
257-
Final Condition</div></div>
258+
Density</div></div>
258259
<h2><a class="anchor" id="autotoc_md57"></a>
259-
Centerline Velocities</h2>
260+
Density Final Condition</h2>
260261
<div class="image">
261-
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
262+
<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
262263
<div class="caption">
263-
Centerline Velocities</div></div>
264+
Density Norms</div></div>
264265
<h1><a class="anchor" id="autotoc_md58"></a>
265-
Lax shock tube problem (1D)</h1>
266-
<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>
266+
2D Hardcodied IC Example</h1>
267267
<h2><a class="anchor" id="autotoc_md59"></a>
268268
Initial Condition</h2>
269269
<div class="image">
270-
<img src="initial-1D_laxshocktube-example.png" alt=""/>
270+
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
271271
<div class="caption">
272272
Initial Condition</div></div>
273273
<h2><a class="anchor" id="autotoc_md60"></a>
274274
Result</h2>
275-
<div class="image">
276-
<img src="result-1D_laxshocktube-example.png" alt=""/>
277-
<div class="caption">
278-
Result</div></div>
279-
<h1><a class="anchor" id="autotoc_md61"></a>
280-
Shock Droplet (2D)</h1>
281-
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
275+
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
276+
<h1><a class="anchor" id="autotoc_md61"></a>
277+
Isentropic vortex problem (2D)</h1>
278+
<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>
282279
<h2><a class="anchor" id="autotoc_md62"></a>
283-
Initial Condition</h2>
280+
Density</h2>
284281
<div class="image">
285-
<img src="initial-2D_shockdroplet-example.png" alt=""/>
282+
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
286283
<div class="caption">
287-
Initial Condition</div></div>
284+
Density</div></div>
288285
<h2><a class="anchor" id="autotoc_md63"></a>
289-
Result</h2>
286+
Density Norms</h2>
290287
<div class="image">
291-
<img src="result-2D_shockdroplet-example.png" alt=""/>
288+
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
292289
<div class="caption">
293-
Result</div></div>
290+
Density Norms</div></div>
294291
</div></div><!-- contents -->
295292
</div><!-- PageDoc -->
296293
</div><!-- doc-content -->

‎documentation/navtreedata.js‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -61,50 +61,50 @@ var NAVTREE =
6161
] ]
6262
] ],
6363
[ "Example Cases", "md_examples.html", [
64-
[ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md30", [
65-
[ "Initial Condition", "md_examples.html#autotoc_md31", null ],
66-
[ "Result", "md_examples.html#autotoc_md32", null ]
64+
[ "Strong- & Weak-scaling", "md_examples.html#autotoc_md30", [
65+
[ "Weak Scaling", "md_examples.html#autotoc_md31", null ],
66+
[ "Strong Scaling", "md_examples.html#autotoc_md32", null ],
67+
[ "Example", "md_examples.html#autotoc_md33", null ]
6768
] ],
68-
[ "2D Riemann Test (2D)", "md_examples.html#autotoc_md33", [
69-
[ "Density Initial Condition", "md_examples.html#autotoc_md34", null ],
70-
[ "Density Final Condition", "md_examples.html#autotoc_md35", null ]
69+
[ "Lid-Driven Cavity Problem (2D)", "md_examples.html#autotoc_md34", [
70+
[ "Final Condition", "md_examples.html#autotoc_md35", null ],
71+
[ "Centerline Velocities", "md_examples.html#autotoc_md36", null ]
7172
] ],
72-
[ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md36", [
73-
[ "Initial Condition", "md_examples.html#autotoc_md37", null ],
74-
[ "Result", "md_examples.html#autotoc_md38", null ]
73+
[ "Lax shock tube problem (1D)", "md_examples.html#autotoc_md37", [
74+
[ "Initial Condition", "md_examples.html#autotoc_md38", null ],
75+
[ "Result", "md_examples.html#autotoc_md39", null ]
7576
] ],
76-
[ "Rayleigh-Taylor Instability (2D)", "md_examples.html#autotoc_md39", [
77-
[ "Final Condition", "md_examples.html#autotoc_md40", null ],
78-
[ "Centerline Velocities", "md_examples.html#autotoc_md41", null ]
77+
[ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md40", [
78+
[ "Initial Condition", "md_examples.html#autotoc_md41", null ],
79+
[ "Result", "md_examples.html#autotoc_md42", null ]
7980
] ],
80-
[ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md42", [
81-
[ "Density", "md_examples.html#autotoc_md43", null ],
82-
[ "Density Norms", "md_examples.html#autotoc_md44", null ]
81+
[ "Shock Droplet (2D)", "md_examples.html#autotoc_md43", [
82+
[ "Initial Condition", "md_examples.html#autotoc_md44", null ],
83+
[ "Result", "md_examples.html#autotoc_md45", null ]
8384
] ],
84-
[ "2D Hardcodied IC Example", "md_examples.html#autotoc_md45", [
85-
[ "Initial Condition", "md_examples.html#autotoc_md46", null ],
86-
[ "Result", "md_examples.html#autotoc_md47", null ]
85+
[ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md46", [
86+
[ "Initial Condition", "md_examples.html#autotoc_md47", null ],
87+
[ "Result", "md_examples.html#autotoc_md48", null ]
8788
] ],
88-
[ "Rayleigh-Taylor Instability (3D)", "md_examples.html#autotoc_md48", [
89-
[ "Final Condition", "md_examples.html#autotoc_md49", null ],
90-
[ "Centerline Velocities", "md_examples.html#autotoc_md50", null ]
89+
[ "Rayleigh-Taylor Instability (3D)", "md_examples.html#autotoc_md49", [
90+
[ "Final Condition", "md_examples.html#autotoc_md50", null ],
91+
[ "Centerline Velocities", "md_examples.html#autotoc_md51", null ]
9192
] ],
92-
[ "Strong- & Weak-scaling", "md_examples.html#autotoc_md51", [
93-
[ "Weak Scaling", "md_examples.html#autotoc_md52", null ],
94-
[ "Strong Scaling", "md_examples.html#autotoc_md53", null ],
95-
[ "Example", "md_examples.html#autotoc_md54", null ]
93+
[ "Rayleigh-Taylor Instability (2D)", "md_examples.html#autotoc_md52", [
94+
[ "Final Condition", "md_examples.html#autotoc_md53", null ],
95+
[ "Centerline Velocities", "md_examples.html#autotoc_md54", null ]
9696
] ],
97-
[ "Lid-Driven Cavity Problem (2D)", "md_examples.html#autotoc_md55", [
98-
[ "Final Condition", "md_examples.html#autotoc_md56", null ],
99-
[ "Centerline Velocities", "md_examples.html#autotoc_md57", null ]
97+
[ "2D Riemann Test (2D)", "md_examples.html#autotoc_md55", [
98+
[ "Density Initial Condition", "md_examples.html#autotoc_md56", null ],
99+
[ "Density Final Condition", "md_examples.html#autotoc_md57", null ]
100100
] ],
101-
[ "Lax shock tube problem (1D)", "md_examples.html#autotoc_md58", [
101+
[ "2D Hardcodied IC Example", "md_examples.html#autotoc_md58", [
102102
[ "Initial Condition", "md_examples.html#autotoc_md59", null ],
103103
[ "Result", "md_examples.html#autotoc_md60", null ]
104104
] ],
105-
[ "Shock Droplet (2D)", "md_examples.html#autotoc_md61", [
106-
[ "Initial Condition", "md_examples.html#autotoc_md62", null ],
107-
[ "Result", "md_examples.html#autotoc_md63", null ]
105+
[ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md61", [
106+
[ "Density", "md_examples.html#autotoc_md62", null ],
107+
[ "Density Norms", "md_examples.html#autotoc_md63", null ]
108108
] ]
109109
] ],
110110
[ "Performance Results", "md_expectedPerformance.html", [

0 commit comments

Comments
 (0)