Docs @ c208d59

Author: MFC Action

documentation/dynsections.js

@@ -23,6 +23,10 @@
  @licend  The above is the entire license notice for the JavaScript code in this file
  */
 
+function toggleVisibility(linkObj) {
+  return dynsection.toggleVisibility(linkObj);
+}
+
 let dynsection = {
 
   // helper function

documentation/md_examples.html

@@ -136,18 +136,21 @@
 <div class="contents">
 <div class="textblock"><p><a class="anchor" id="autotoc_md28"></a> </p>
 <h1><a class="anchor" id="autotoc_md29"></a>
-Shock Droplet (2D)</h1>
-<p>Reference: Panchal et. al., A Seven-Equation Diffused Interface Method for Resolved Multiphase Flows, JCP, 475 (2023)</p>
+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_md30"></a>
 Initial Condition</h2>
 <div class="image">
-<img src="initial-2D_shockdroplet-example.png" alt=""/>
+<img src="initial-1D_shuosher-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
     <h2><a class="anchor" id="autotoc_md31"></a>
 Result</h2>
-<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/>     </p>
-<h1><a class="anchor" id="autotoc_md32"></a>
+<div class="image">
+<img src="result-1D_shuosher-example.png" alt=""/>
+<div class="caption">
+Result</div></div>
+    <h1><a class="anchor" id="autotoc_md32"></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_md33"></a>
@@ -163,88 +166,85 @@ <h2><a class="anchor" id="autotoc_md34"></a>
 <div class="caption">
 Density Norms</div></div>
     <h1><a class="anchor" id="autotoc_md35"></a>
-3D Weak Scaling</h1>
-<p>The <a href="case.py"><b>3D_weak_scaling</b></a> case depends on two parameters:</p>
-<ul>
-<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>
-<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>
-</ul>
-<p>Weak scaling benchmarks can be produced by keeping <em>gbpp</em> constant and varying <em>procs</em>.</p>
-<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/3D_weak_scaling/case.py 4 -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</div>
-</div><!-- fragment --><h1><a class="anchor" id="autotoc_md36"></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_md37"></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_md36"></a>
 Initial Condition</h2>
 <div class="image">
-<img src="initial-1D_shuosher-example.png" alt=""/>
+<img src="initial-2D_shockdroplet-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md38"></a>
+    <h2><a class="anchor" id="autotoc_md37"></a>
 Result</h2>
+<p><img src="result-2D_shockdroplet-example.png" alt="" class="inline" title="Result"/>     </p>
+<h1><a class="anchor" id="autotoc_md38"></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_md39"></a>
+Density</h2>
 <div class="image">
-<img src="result-1D_shuosher-example.png" alt=""/>
+<img src="alpha_rho1-2D_isentropicvortex-example.png" alt=""/>
 <div class="caption">
-Result</div></div>
-    <h1><a class="anchor" id="autotoc_md39"></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_md40"></a>
+Density</div></div>
+    <h2><a class="anchor" id="autotoc_md40"></a>
+Density Norms</h2>
+<div class="image">
+<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
+<div class="caption">
+Density Norms</div></div>
+    <h1><a class="anchor" id="autotoc_md41"></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>
+<h2><a class="anchor" id="autotoc_md42"></a>
 Initial Condition</h2>
 <div class="image">
-<img src="initial-1D_titarevtorro-example.png" alt=""/>
+<img src="initial-1D_laxshocktube-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md41"></a>
+    <h2><a class="anchor" id="autotoc_md43"></a>
 Result</h2>
 <div class="image">
-<img src="result-1D_titarevtorro-example.png" alt=""/>
+<img src="result-1D_laxshocktube-example.png" alt=""/>
 <div class="caption">
 Result</div></div>
-    <h1><a class="anchor" id="autotoc_md42"></a>
+    <h1><a class="anchor" id="autotoc_md44"></a>
+3D Weak Scaling</h1>
+<p>The <a href="case.py"><b>3D_weak_scaling</b></a> case depends on two parameters:</p>
+<ul>
+<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>
+<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>
+</ul>
+<p>Weak scaling benchmarks can be produced by keeping <em>gbpp</em> constant and varying <em>procs</em>.</p>
+<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/3D_weak_scaling/case.py 4 -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</div>
+</div><!-- fragment --><h1><a class="anchor" id="autotoc_md45"></a>
 2D Hardcodied IC Example</h1>
-<h2><a class="anchor" id="autotoc_md43"></a>
+<h2><a class="anchor" id="autotoc_md46"></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_md44"></a>
+    <h2><a class="anchor" id="autotoc_md47"></a>
 Result</h2>
 <p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/>     </p>
-<h1><a class="anchor" id="autotoc_md45"></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>
-<h2><a class="anchor" id="autotoc_md46"></a>
+<h1><a class="anchor" id="autotoc_md48"></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_md49"></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_md47"></a>
+    <h2><a class="anchor" id="autotoc_md50"></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_md48"></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_md49"></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_md50"></a>
-Density Norms</h2>
-<div class="image">
-<img src="density_norms-2D_isentropicvortex-example.png" alt=""/>
-<div class="caption">
-Density Norms</div></div>
     <h1><a class="anchor" id="autotoc_md51"></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>

documentation/navtreedata.js

@@ -60,34 +60,34 @@ var NAVTREE =
       ] ]
     ] ],
     [ "Example Cases", "md_examples.html", [
-      [ "Shock Droplet (2D)", "md_examples.html#autotoc_md29", [
+      [ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md29", [
         [ "Initial Condition", "md_examples.html#autotoc_md30", null ],
         [ "Result", "md_examples.html#autotoc_md31", null ]
       ] ],
       [ "2D Riemann Test (2D)", "md_examples.html#autotoc_md32", [
         [ "Density Initial Condition", "md_examples.html#autotoc_md33", null ],
         [ "Density Final Condition", "md_examples.html#autotoc_md34", null ]
       ] ],
-      [ "3D Weak Scaling", "md_examples.html#autotoc_md35", null ],
-      [ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md36", [
-        [ "Initial Condition", "md_examples.html#autotoc_md37", null ],
-        [ "Result", "md_examples.html#autotoc_md38", null ]
+      [ "Shock Droplet (2D)", "md_examples.html#autotoc_md35", [
+        [ "Initial Condition", "md_examples.html#autotoc_md36", null ],
+        [ "Result", "md_examples.html#autotoc_md37", null ]
       ] ],
-      [ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md39", [
-        [ "Initial Condition", "md_examples.html#autotoc_md40", null ],
-        [ "Result", "md_examples.html#autotoc_md41", null ]
+      [ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md38", [
+        [ "Density", "md_examples.html#autotoc_md39", null ],
+        [ "Density Norms", "md_examples.html#autotoc_md40", null ]
       ] ],
-      [ "2D Hardcodied IC Example", "md_examples.html#autotoc_md42", [
-        [ "Initial Condition", "md_examples.html#autotoc_md43", null ],
-        [ "Result", "md_examples.html#autotoc_md44", null ]
+      [ "Lax shock tube problem (1D)", "md_examples.html#autotoc_md41", [
+        [ "Initial Condition", "md_examples.html#autotoc_md42", null ],
+        [ "Result", "md_examples.html#autotoc_md43", null ]
       ] ],
-      [ "Lax shock tube problem (1D)", "md_examples.html#autotoc_md45", [
+      [ "3D Weak Scaling", "md_examples.html#autotoc_md44", null ],
+      [ "2D Hardcodied IC Example", "md_examples.html#autotoc_md45", [
         [ "Initial Condition", "md_examples.html#autotoc_md46", null ],
         [ "Result", "md_examples.html#autotoc_md47", null ]
       ] ],
-      [ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md48", [
-        [ "Density", "md_examples.html#autotoc_md49", null ],
-        [ "Density Norms", "md_examples.html#autotoc_md50", null ]
+      [ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md48", [
+        [ "Initial Condition", "md_examples.html#autotoc_md49", null ],
+        [ "Result", "md_examples.html#autotoc_md50", null ]
       ] ],
       [ "Lid-Driven Cavity Problem (2D)", "md_examples.html#autotoc_md51", [
         [ "Final Condition", "md_examples.html#autotoc_md52", null ],

documentation/navtreeindex0.js

@@ -1,7 +1,7 @@
 var NAVTREEINDEX0 =
 {
-"index.html":[0],
 "index.html":[],
+"index.html":[0],
 "index.html#autotoc_md72":[0,0],
 "index.html#autotoc_md73":[0,1],
 "md_authors.html":[1],
@@ -40,15 +40,15 @@ var NAVTREEINDEX0 =
 "md_examples.html#autotoc_md33":[3,1,0],
 "md_examples.html#autotoc_md34":[3,1,1],
 "md_examples.html#autotoc_md35":[3,2],
-"md_examples.html#autotoc_md36":[3,3],
-"md_examples.html#autotoc_md37":[3,3,0],
-"md_examples.html#autotoc_md38":[3,3,1],
-"md_examples.html#autotoc_md39":[3,4],
-"md_examples.html#autotoc_md40":[3,4,0],
-"md_examples.html#autotoc_md41":[3,4,1],
-"md_examples.html#autotoc_md42":[3,5],
-"md_examples.html#autotoc_md43":[3,5,0],
-"md_examples.html#autotoc_md44":[3,5,1],
+"md_examples.html#autotoc_md36":[3,2,0],
+"md_examples.html#autotoc_md37":[3,2,1],
+"md_examples.html#autotoc_md38":[3,3],
+"md_examples.html#autotoc_md39":[3,3,0],
+"md_examples.html#autotoc_md40":[3,3,1],
+"md_examples.html#autotoc_md41":[3,4],
+"md_examples.html#autotoc_md42":[3,4,0],
+"md_examples.html#autotoc_md43":[3,4,1],
+"md_examples.html#autotoc_md44":[3,5],
 "md_examples.html#autotoc_md45":[3,6],
 "md_examples.html#autotoc_md46":[3,6,0],
 "md_examples.html#autotoc_md47":[3,6,1],

documentation/search/all_0.js

@@ -6,5 +6,5 @@ var searchData=
   ['12_20artificial_20mach_20number_3',['12. Artificial Mach Number',['../md_case.html#autotoc_md20',1,'']]],
   ['16m_20grid_20points_4',['16M Grid Points',['../md_expectedPerformance.html#autotoc_md62',1,'']]],
   ['1_3a_20setting_20up_20your_20environment_5',['Step 1: Setting up your Environment',['../md_visualization.html#autotoc_md90',1,'']]],
-  ['1d_6',['1D',['../md_examples.html#autotoc_md45',1,'Lax shock tube problem (1D)'],['../md_examples.html#autotoc_md36',1,'Shu-Osher problem (1D)'],['../md_examples.html#autotoc_md39',1,'Titarev-Toro problem (1D)']]]
+  ['1d_6',['1D',['../md_examples.html#autotoc_md41',1,'Lax shock tube problem (1D)'],['../md_examples.html#autotoc_md29',1,'Shu-Osher problem (1D)'],['../md_examples.html#autotoc_md48',1,'Titarev-Toro problem (1D)']]]
 ];

documentation/search/all_1.js

@@ -2,7 +2,7 @@ var searchData=
 [
   ['2_20computational_20domain_0',['2. Computational Domain',['../md_case.html#autotoc_md6',1,'']]],
   ['2_3a_20customizing_20the_20script_1',['Step 2: Customizing the script',['../md_visualization.html#autotoc_md91',1,'']]],
-  ['2d_2',['2D',['../md_examples.html#autotoc_md32',1,'2D Riemann Test (2D)'],['../md_examples.html#autotoc_md48',1,'Isentropic vortex problem (2D)'],['../md_examples.html#autotoc_md51',1,'Lid-Driven Cavity Problem (2D)'],['../md_examples.html#autotoc_md29',1,'Shock Droplet (2D)']]],
-  ['2d_20hardcodied_20ic_20example_3',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md42',1,'']]],
+  ['2d_2',['2D',['../md_examples.html#autotoc_md32',1,'2D Riemann Test (2D)'],['../md_examples.html#autotoc_md38',1,'Isentropic vortex problem (2D)'],['../md_examples.html#autotoc_md51',1,'Lid-Driven Cavity Problem (2D)'],['../md_examples.html#autotoc_md35',1,'Shock Droplet (2D)']]],
+  ['2d_20hardcodied_20ic_20example_3',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md45',1,'']]],
   ['2d_20riemann_20test_202d_4',['2D Riemann Test (2D)',['../md_examples.html#autotoc_md32',1,'']]]
 ];

documentation/search/all_10.js

@@ -1,6 +1,6 @@
 var searchData=
 [
   ['hard_20coded_20patches_0',['Hard Coded Patches',['../md_case.html#autotoc_md9',1,'']]],
-  ['hardcodied_20ic_20example_1',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md42',1,'']]],
+  ['hardcodied_20ic_20example_1',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md45',1,'']]],
   ['hour_2',['Expected time-steps/hour',['../md_expectedPerformance.html#autotoc_md55',1,'']]]
 ];

documentation/search/all_11.js

@@ -1,10 +1,10 @@
 var searchData=
 [
   ['ibm_20power9_20cpu_0',['IBM Power9 CPU',['../md_expectedPerformance.html#autotoc_md59',1,'IBM Power9 CPU'],['../md_expectedPerformance.html#autotoc_md64',1,'IBM Power9 CPU']]],
-  ['ic_20example_1',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md42',1,'']]],
+  ['ic_20example_1',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md45',1,'']]],
   ['immersed_20boundary_20patch_20types_2',['Immersed Boundary Patch Types',['../md_case.html#autotoc_md24',1,'']]],
   ['immersed_20boundary_20patches_3',['4. Immersed Boundary Patches',['../md_case.html#autotoc_md11',1,'']]],
-  ['initial_20condition_4',['Initial Condition',['../md_examples.html#autotoc_md33',1,'Density Initial Condition'],['../md_examples.html#autotoc_md30',1,'Initial Condition'],['../md_examples.html#autotoc_md37',1,'Initial Condition'],['../md_examples.html#autotoc_md40',1,'Initial Condition'],['../md_examples.html#autotoc_md43',1,'Initial Condition'],['../md_examples.html#autotoc_md46',1,'Initial Condition']]],
+  ['initial_20condition_4',['Initial Condition',['../md_examples.html#autotoc_md33',1,'Density Initial Condition'],['../md_examples.html#autotoc_md30',1,'Initial Condition'],['../md_examples.html#autotoc_md36',1,'Initial Condition'],['../md_examples.html#autotoc_md42',1,'Initial Condition'],['../md_examples.html#autotoc_md46',1,'Initial Condition'],['../md_examples.html#autotoc_md49',1,'Initial Condition']]],
   ['interactive_20execution_5',['Interactive Execution',['../md_running.html#autotoc_md76',1,'']]],
-  ['isentropic_20vortex_20problem_202d_6',['Isentropic vortex problem (2D)',['../md_examples.html#autotoc_md48',1,'']]]
+  ['isentropic_20vortex_20problem_202d_6',['Isentropic vortex problem (2D)',['../md_examples.html#autotoc_md38',1,'']]]
 ];

documentation/search/all_12.js

@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['lax_20shock_20tube_20problem_201d_0',['Lax shock tube problem (1D)',['../md_examples.html#autotoc_md45',1,'']]],
+  ['lax_20shock_20tube_20problem_201d_0',['Lax shock tube problem (1D)',['../md_examples.html#autotoc_md41',1,'']]],
   ['lid_20driven_20cavity_20problem_202d_1',['Lid-Driven Cavity Problem (2D)',['../md_examples.html#autotoc_md51',1,'']]],
   ['line_20arguments_2',['(Optional) Accepting command line arguments',['../md_case.html#autotoc_md3',1,'']]]
 ];

documentation/search/all_14.js

@@ -1,6 +1,6 @@
 var searchData=
 [
-  ['norms_0',['Density Norms',['../md_examples.html#autotoc_md50',1,'']]],
+  ['norms_0',['Density Norms',['../md_examples.html#autotoc_md40',1,'']]],
   ['number_1',['12. Artificial Mach Number',['../md_case.html#autotoc_md20',1,'']]],
   ['nvidia_20gpus_2',['NVIDIA GPUs',['../md_running.html#autotoc_md79',1,'']]],
   ['nvidia_20v100_20gpu_3',['NVIDIA V100 GPU',['../md_expectedPerformance.html#autotoc_md58',1,'NVIDIA V100 GPU'],['../md_expectedPerformance.html#autotoc_md61',1,'NVIDIA V100 GPU']]]