Docs @ b49ff72

Author: MFC Action

documentation/md_examples.html

@@ -137,183 +137,186 @@
 <div class="contents">
 <div class="textblock"><p><a class="anchor" id="autotoc_md29"></a></p>
 <h1><a class="anchor" id="autotoc_md30"></a>
-2D Riemann Test (2D)</h1>
-<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>
+Isentropic vortex problem (2D)</h1>
+<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>
 <h2><a class="anchor" id="autotoc_md31"></a>
-Density Initial Condition</h2>
+Density</h2>
 <div class="image">
-<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
+<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
 <div class="caption">
 Density</div></div>
     <h2><a class="anchor" id="autotoc_md32"></a>
-Density Final Condition</h2>
+Density Norms</h2>
 <div class="image">
-<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
+<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
 <div class="caption">
 Density Norms</div></div>
     <h1><a class="anchor" id="autotoc_md33"></a>
-Titarev-Toro problem (1D)</h1>
-<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>
+Lid-Driven Cavity Problem (2D)</h1>
+<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>
+<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>
+<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
 <h2><a class="anchor" id="autotoc_md34"></a>
-Initial Condition</h2>
+Final Condition</h2>
 <div class="image">
-<img src="initial-1D_titarevtorro-example.png" alt=""/>
+<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
 <div class="caption">
-Initial Condition</div></div>
+Final Condition</div></div>
     <h2><a class="anchor" id="autotoc_md35"></a>
-Result</h2>
+Centerline Velocities</h2>
 <div class="image">
-<img src="result-1D_titarevtorro-example.png" alt=""/>
+<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
 <div class="caption">
-Result</div></div>
+Centerline Velocities</div></div>
     <h1><a class="anchor" id="autotoc_md36"></a>
-2D IBM CFL dt (2D)</h1>
-<h2><a class="anchor" id="autotoc_md37"></a>
-Result</h2>
-<div class="image">
-<img src="result-2D_ibm_cfl_dt-example.png" alt=""/>
-<div class="caption">
-Result</div></div>
-    <h1><a class="anchor" id="autotoc_md38"></a>
 Shu-Osher problem (1D)</h1>
 <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>
-<h2><a class="anchor" id="autotoc_md39"></a>
+<h2><a class="anchor" id="autotoc_md37"></a>
 Initial Condition</h2>
 <div class="image">
 <img src="initial-1D_shuosher_old-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md40"></a>
+    <h2><a class="anchor" id="autotoc_md38"></a>
 Result</h2>
 <div class="image">
 <img src="result-1D_shuosher_old-example.png" alt=""/>
 <div class="caption">
 Result</div></div>
-    <h1><a class="anchor" id="autotoc_md41"></a>
-Isentropic vortex problem (2D)</h1>
-<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>
-<h2><a class="anchor" id="autotoc_md42"></a>
-Density</h2>
-<div class="image">
-<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
-<div class="caption">
-Density</div></div>
-    <h2><a class="anchor" id="autotoc_md43"></a>
-Density Norms</h2>
+    <h1><a class="anchor" id="autotoc_md39"></a>
+Rayleigh-Taylor Instability (2D)</h1>
+<h2><a class="anchor" id="autotoc_md40"></a>
+Final Condition</h2>
 <div class="image">
-<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
+<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
 <div class="caption">
-Density Norms</div></div>
-    <h1><a class="anchor" id="autotoc_md44"></a>
-Lax shock tube problem (1D)</h1>
-<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>
+Final Condition</div></div>
+    <h2><a class="anchor" id="autotoc_md41"></a>
+Centerline Velocities</h2>
+<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
+<h1><a class="anchor" id="autotoc_md42"></a>
+Taylor-Green Vortex (3D)</h1>
+<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>
+<h2><a class="anchor" id="autotoc_md43"></a>
+Final Condition</h2>
+<p>This figure shows the isosurface with zero q-criterion. <img src="result-3D_TaylorGreenVortex-example.png" alt="" class="inline" title="Density"/>    </p>
+<h1><a class="anchor" id="autotoc_md44"></a>
+Titarev-Toro problem (1D)</h1>
+<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>
 <h2><a class="anchor" id="autotoc_md45"></a>
 Initial Condition</h2>
 <div class="image">
-<img src="initial-1D_laxshocktube-example.png" alt=""/>
+<img src="initial-1D_titarevtorro-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
     <h2><a class="anchor" id="autotoc_md46"></a>
 Result</h2>
 <div class="image">
-<img src="result-1D_laxshocktube-example.png" alt=""/>
+<img src="result-1D_titarevtorro-example.png" alt=""/>
 <div class="caption">
 Result</div></div>
     <h1><a class="anchor" id="autotoc_md47"></a>
-IBM Bow Shock (3D)</h1>
-<h2><a class="anchor" id="autotoc_md48"></a>
-Final Condition</h2>
-<div class="image">
-<img src="result-3D_ibm_bowshock-example.png" alt=""/>
-<div class="caption">
-Density</div></div>
-    <h1><a class="anchor" id="autotoc_md49"></a>
 Strong- &amp; Weak-scaling</h1>
 <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>
 <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>
-<h2><a class="anchor" id="autotoc_md50"></a>
+<h2><a class="anchor" id="autotoc_md48"></a>
 Weak Scaling</h2>
 <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>
-<h2><a class="anchor" id="autotoc_md51"></a>
+<h2><a class="anchor" id="autotoc_md49"></a>
 Strong Scaling</h2>
 <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>
-<h2><a class="anchor" id="autotoc_md52"></a>
+<h2><a class="anchor" id="autotoc_md50"></a>
 Example</h2>
 <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>
 <div class="fragment"><div class="line">./mfc.sh run examples/scaling/case.py -t pre_process simulation                    \</div>
 <div class="line">             -e batch -p mypartition -N 8 -n 2 -w &quot;01:00:00&quot; -# &quot;MFC Weak Scaling&quot; \</div>
 <div class="line">             --case-optimization -j 32 -- --scaling weak --memory 4</div>
-</div><!-- fragment --><h1><a class="anchor" id="autotoc_md53"></a>
-Shock Droplet (2D)</h1>
-<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
-<h2><a class="anchor" id="autotoc_md54"></a>
-Initial Condition</h2>
+</div><!-- fragment --><h1><a class="anchor" id="autotoc_md51"></a>
+2D Riemann Test (2D)</h1>
+<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>
+<h2><a class="anchor" id="autotoc_md52"></a>
+Density Initial Condition</h2>
 <div class="image">
-<img src="initial-2D_shockdroplet-example.png" alt=""/>
+<img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
 <div class="caption">
-Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md55"></a>
-Result</h2>
-<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/>    </p>
-<h1><a class="anchor" id="autotoc_md56"></a>
-Rayleigh-Taylor Instability (2D)</h1>
+Density</div></div>
+    <h2><a class="anchor" id="autotoc_md53"></a>
+Density Final Condition</h2>
+<div class="image">
+<img src="alpha_rho1_final-2D_riemann_test-example.png" alt=""/>
+<div class="caption">
+Density Norms</div></div>
+    <h1><a class="anchor" id="autotoc_md54"></a>
+IBM Bow Shock (3D)</h1>
+<h2><a class="anchor" id="autotoc_md55"></a>
+Final Condition</h2>
+<div class="image">
+<img src="result-3D_ibm_bowshock-example.png" alt=""/>
+<div class="caption">
+Density</div></div>
+    <h1><a class="anchor" id="autotoc_md56"></a>
+Rayleigh-Taylor Instability (3D)</h1>
 <h2><a class="anchor" id="autotoc_md57"></a>
 Final Condition</h2>
 <div class="image">
-<img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
+<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
 <div class="caption">
 Final Condition</div></div>
     <h2><a class="anchor" id="autotoc_md58"></a>
 Centerline Velocities</h2>
-<p><img src="linear_theory.jpg" alt="Linear Theory Comparison" class="inline"/></p>
-<h1><a class="anchor" id="autotoc_md59"></a>
-2D Hardcodied IC Example</h1>
+<div class="image">
+<img src="linear_theory-3D_rayleigh_taylor-example.png" alt=""/>
+<div class="caption">
+Linear Theory Comparison</div></div>
+    <h1><a class="anchor" id="autotoc_md59"></a>
+2D IBM CFL dt (2D)</h1>
 <h2><a class="anchor" id="autotoc_md60"></a>
+Result</h2>
+<div class="image">
+<img src="result-2D_ibm_cfl_dt-example.png" alt=""/>
+<div class="caption">
+Result</div></div>
+    <h1><a class="anchor" id="autotoc_md61"></a>
+2D Hardcodied IC Example</h1>
+<h2><a class="anchor" id="autotoc_md62"></a>
 Initial Condition</h2>
 <div class="image">
 <img src="initial-2D_hardcodied_ic-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md61"></a>
+    <h2><a class="anchor" id="autotoc_md63"></a>
 Result</h2>
 <p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/>    </p>
-<h1><a class="anchor" id="autotoc_md62"></a>
-Taylor-Green Vortex (3D)</h1>
-<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>
-<h2><a class="anchor" id="autotoc_md63"></a>
-Final Condition</h2>
-<p>This figure shows the isosurface with zero q-criterion. <img src="result-3D_TaylorGreenVortex-example.png" alt="" class="inline" title="Density"/>    </p>
 <h1><a class="anchor" id="autotoc_md64"></a>
-Lid-Driven Cavity Problem (2D)</h1>
-<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>
-<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>
-<p>Video: <a href="https://youtube.com/shorts/JEP28scZrBM?feature=share">https://youtube.com/shorts/JEP28scZrBM?feature=share</a></p>
+Lax shock tube problem (1D)</h1>
+<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>
 <h2><a class="anchor" id="autotoc_md65"></a>
-Final Condition</h2>
+Initial Condition</h2>
 <div class="image">
-<img src="final_condition-2D_lid_driven_cavity-example.png" alt=""/>
+<img src="initial-1D_laxshocktube-example.png" alt=""/>
 <div class="caption">
-Final Condition</div></div>
+Initial Condition</div></div>
     <h2><a class="anchor" id="autotoc_md66"></a>
-Centerline Velocities</h2>
+Result</h2>
 <div class="image">
-<img src="centerline_velocities-2D_lid_driven_cavity-example.png" alt=""/>
+<img src="result-1D_laxshocktube-example.png" alt=""/>
 <div class="caption">
-Centerline Velocities</div></div>
+Result</div></div>
     <h1><a class="anchor" id="autotoc_md67"></a>
-Rayleigh-Taylor Instability (3D)</h1>
+Shock Droplet (2D)</h1>
+<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
 <h2><a class="anchor" id="autotoc_md68"></a>
-Final Condition</h2>
+Initial Condition</h2>
 <div class="image">
-<img src="final_condition-3D_rayleigh_taylor-example.png" alt=""/>
+<img src="initial-2D_shockdroplet-example.png" alt=""/>
 <div class="caption">
-Final Condition</div></div>
+Initial Condition</div></div>
     <h2><a class="anchor" id="autotoc_md69"></a>
-Centerline Velocities</h2>
+Result</h2>
 <div class="image">
-<img src="linear_theory-3D_rayleigh_taylor-example.png" alt=""/>
+<img src="result-2D_shockdroplet-example.png" alt=""/>
 <div class="caption">
-Linear Theory Comparison</div></div>
+Result</div></div>
      </div></div><!-- contents -->
 </div><!-- PageDoc -->
 </div><!-- doc-content -->