Skip to content

Commit 28208f7

Browse files
author
MFC Action
committed
Docs @ b3761e3
1 parent 6ac6e1b commit 28208f7

26 files changed

+262
-181
lines changed

‎documentation/doxygen_crawl.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -109,5 +109,9 @@
109109
<a href="md_visualization.html"/>
110110
<a href="md_visualization.html#autotoc_md86"/>
111111
<a href="md_visualization.html#autotoc_md87"/>
112+
<a href="md_visualization.html#autotoc_md88"/>
113+
<a href="md_visualization.html#autotoc_md89"/>
114+
<a href="md_visualization.html#autotoc_md90"/>
115+
<a href="md_visualization.html#autotoc_md91"/>
112116
</body>
113117
</html>

‎documentation/md_examples.html

Lines changed: 64 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -136,86 +136,86 @@
136136
<div class="contents">
137137
<div class="textblock"><p><a class="anchor" id="autotoc_md27"></a> </p>
138138
<h1><a class="anchor" id="autotoc_md28"></a>
139-
3D Weak Scaling</h1>
140-
<p>The <a href="case.py"><b>3D_weak_scaling</b></a> case depends on two parameters:</p>
141-
<ul>
142-
<li><b>The number of MPI ranks</b> (<em>procs</em>): As <em>procs</em> increases, the problem size per rank remains constant. <em>procs</em> is determined using information provided to the case file by <code>mfc.sh run</code>.</li>
143-
<li><b>GPU memory usage per rank</b> (<em>gbpp</em>): As <em>gbpp</em> increases, the problem size per rank increases and the number of timesteps decreases so that wall times consistent. <em>gbpp</em> is a user-defined optional argument to the <a href="case.py">case.py</a> file. It can be specified right after the case filepath when invoking <code>mfc.sh run</code>.</li>
144-
</ul>
145-
<p>Weak scaling benchmarks can be produced by keeping <em>gbpp</em> constant and varying <em>procs</em>.</p>
146-
<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>
147-
<div class="fragment"><div class="line">./mfc.sh run examples/3D_weak_scaling/case.py 4 -t pre_process simulation \</div>
148-
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
149-
<div class="line"> --case-optimization -j 32</div>
150-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md29"></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_md29"></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_md30"></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_md31"></a>
151151
2D Riemann Test (2D)</h1>
152152
<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>
153-
<h2><a class="anchor" id="autotoc_md30"></a>
153+
<h2><a class="anchor" id="autotoc_md32"></a>
154154
Density Initial Condition</h2>
155155
<div class="image">
156156
<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
157157
<div class="caption">
158158
Density</div></div>
159-
<h2><a class="anchor" id="autotoc_md31"></a>
159+
<h2><a class="anchor" id="autotoc_md33"></a>
160160
Density Final Condition</h2>
161161
<div class="image">
162162
<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
163163
<div class="caption">
164164
Density Norms</div></div>
165-
<h1><a class="anchor" id="autotoc_md32"></a>
166-
2D Hardcodied IC Example</h1>
167-
<h2><a class="anchor" id="autotoc_md33"></a>
168-
Initial Condition</h2>
169-
<div class="image">
170-
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
171-
<div class="caption">
172-
Initial Condition</div></div>
173-
<h2><a class="anchor" id="autotoc_md34"></a>
174-
Result</h2>
175-
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
176-
<h1><a class="anchor" id="autotoc_md35"></a>
177-
Shock Droplet (2D)</h1>
178-
<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
165+
<h1><a class="anchor" id="autotoc_md34"></a>
166+
3D Weak Scaling</h1>
167+
<p>The <a href="case.py"><b>3D_weak_scaling</b></a> case depends on two parameters:</p>
168+
<ul>
169+
<li><b>The number of MPI ranks</b> (<em>procs</em>): As <em>procs</em> increases, the problem size per rank remains constant. <em>procs</em> is determined using information provided to the case file by <code>mfc.sh run</code>.</li>
170+
<li><b>GPU memory usage per rank</b> (<em>gbpp</em>): As <em>gbpp</em> increases, the problem size per rank increases and the number of timesteps decreases so that wall times consistent. <em>gbpp</em> is a user-defined optional argument to the <a href="case.py">case.py</a> file. It can be specified right after the case filepath when invoking <code>mfc.sh run</code>.</li>
171+
</ul>
172+
<p>Weak scaling benchmarks can be produced by keeping <em>gbpp</em> constant and varying <em>procs</em>.</p>
173+
<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>
174+
<div class="fragment"><div class="line">./mfc.sh run examples/3D_weak_scaling/case.py 4 -t pre_process simulation \</div>
175+
<div class="line"> -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
176+
<div class="line"> --case-optimization -j 32</div>
177+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md35"></a>
178+
Shu-Osher problem (1D)</h1>
179+
<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>
179180
<h2><a class="anchor" id="autotoc_md36"></a>
180181
Initial Condition</h2>
181182
<div class="image">
182-
<img src="initial-2D_shockdroplet-example.png" alt=""/>
183+
<img src="initial-1D_shuosher-example.png" alt=""/>
183184
<div class="caption">
184185
Initial Condition</div></div>
185186
<h2><a class="anchor" id="autotoc_md37"></a>
186187
Result</h2>
187-
<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/> </p>
188-
<h1><a class="anchor" id="autotoc_md38"></a>
189-
Isentropic vortex problem (2D)</h1>
190-
<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>
191-
<h2><a class="anchor" id="autotoc_md39"></a>
192-
Density</h2>
193-
<div class="image">
194-
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
195-
<div class="caption">
196-
Density</div></div>
197-
<h2><a class="anchor" id="autotoc_md40"></a>
198-
Density Norms</h2>
199188
<div class="image">
200-
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
189+
<img src="result-1D_shuosher-example.png" alt=""/>
201190
<div class="caption">
202-
Density Norms</div></div>
203-
<h1><a class="anchor" id="autotoc_md41"></a>
191+
Result</div></div>
192+
<h1><a class="anchor" id="autotoc_md38"></a>
204193
Titarev-Toro problem (1D)</h1>
205194
<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>
206-
<h2><a class="anchor" id="autotoc_md42"></a>
195+
<h2><a class="anchor" id="autotoc_md39"></a>
207196
Initial Condition</h2>
208197
<div class="image">
209198
<img src="initial-1D_titarevtorro-example.png" alt=""/>
210199
<div class="caption">
211200
Initial Condition</div></div>
212-
<h2><a class="anchor" id="autotoc_md43"></a>
201+
<h2><a class="anchor" id="autotoc_md40"></a>
213202
Result</h2>
214203
<div class="image">
215204
<img src="result-1D_titarevtorro-example.png" alt=""/>
216205
<div class="caption">
217206
Result</div></div>
218-
<h1><a class="anchor" id="autotoc_md44"></a>
207+
<h1><a class="anchor" id="autotoc_md41"></a>
208+
2D Hardcodied IC Example</h1>
209+
<h2><a class="anchor" id="autotoc_md42"></a>
210+
Initial Condition</h2>
211+
<div class="image">
212+
<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
213+
<div class="caption">
214+
Initial Condition</div></div>
215+
<h2><a class="anchor" id="autotoc_md43"></a>
216+
Result</h2>
217+
<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/> </p>
218+
<h1><a class="anchor" id="autotoc_md44"></a>
219219
Lax shock tube problem (1D)</h1>
220220
<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>
221221
<h2><a class="anchor" id="autotoc_md45"></a>
@@ -231,37 +231,37 @@ <h2><a class="anchor" id="autotoc_md46"></a>
231231
<div class="caption">
232232
Result</div></div>
233233
<h1><a class="anchor" id="autotoc_md47"></a>
234+
Isentropic vortex problem (2D)</h1>
235+
<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>
236+
<h2><a class="anchor" id="autotoc_md48"></a>
237+
Density</h2>
238+
<div class="image">
239+
<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
240+
<div class="caption">
241+
Density</div></div>
242+
<h2><a class="anchor" id="autotoc_md49"></a>
243+
Density Norms</h2>
244+
<div class="image">
245+
<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
246+
<div class="caption">
247+
Density Norms</div></div>
248+
<h1><a class="anchor" id="autotoc_md50"></a>
234249
Lid-Driven Cavity Problem (2D)</h1>
235250
<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>
236251
<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>
237252
<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
238-
<h2><a class="anchor" id="autotoc_md48"></a>
253+
<h2><a class="anchor" id="autotoc_md51"></a>
239254
Final Condition</h2>
240255
<div class="image">
241256
<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
242257
<div class="caption">
243258
Final Condition</div></div>
244-
<h2><a class="anchor" id="autotoc_md49"></a>
259+
<h2><a class="anchor" id="autotoc_md52"></a>
245260
Centerline Velocities</h2>
246261
<div class="image">
247262
<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
248263
<div class="caption">
249264
Centerline Velocities</div></div>
250-
<h1><a class="anchor" id="autotoc_md50"></a>
251-
Shu-Osher problem (1D)</h1>
252-
<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>
253-
<h2><a class="anchor" id="autotoc_md51"></a>
254-
Initial Condition</h2>
255-
<div class="image">
256-
<img src="initial-1D_shuosher-example.png" alt=""/>
257-
<div class="caption">
258-
Initial Condition</div></div>
259-
<h2><a class="anchor" id="autotoc_md52"></a>
260-
Result</h2>
261-
<div class="image">
262-
<img src="result-1D_shuosher-example.png" alt=""/>
263-
<div class="caption">
264-
Result</div></div>
265265
</div></div><!-- contents -->
266266
</div><!-- PageDoc -->
267267
</div><!-- doc-content -->

0 commit comments

Comments
 (0)