Docs @ 7827d8f

Author: MFC Action

…entation/initial-1D_shuosher-example.png …tion/initial-1D_shuosher_old-example.pngdocumentation/initial-1D_shuosher-example.png renamed to documentation/initial-1D_shuosher_old-example.png documentation/initial-1D_shuosher-example.png renamed to documentation/initial-1D_shuosher_old-example.png

@@ -456,20 +456,26 @@ <h2><a class="anchor" id="autotoc_md14"></a>
 <tr class="markdownTableRowOdd">
 <td class="markdownTableBodyRight"><code>weno_eps</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero)    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><code>mapped_weno</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">WENO with mapping of nonlinear weights    </td></tr>
+<td class="markdownTableBodyRight"><code>mapped_weno</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">WENO-M (WENO with mapping of nonlinear weights)    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><code>null_weights</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries    </td></tr>
+<td class="markdownTableBodyRight"><code>wenoz</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">WENO-Z    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><code>mp_weno</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO    </td></tr>
+<td class="markdownTableBodyRight"><code>teno</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">TENO (Targeted ENO)    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><code>riemann_solver</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact*    </td></tr>
+<td class="markdownTableBodyRight"><code>teno_CT</code>   </td><td class="markdownTableBodyCenter">Real   </td><td class="markdownTableBodyLeft">TENO threshold for smoothness detection    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><code>avg_state</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Averaged state evaluation method: [1] Roe averagen*; [2] Arithmetic mean    </td></tr>
+<td class="markdownTableBodyRight"><code>null_weights</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries    </td></tr>
 <tr class="markdownTableRowOdd">
-<td class="markdownTableBodyRight"><code>wave_speeds</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Wave-speed estimation: [1] Direct (Batten et al. 1997); [2] Pressure-velocity* (Toro 1999)    </td></tr>
+<td class="markdownTableBodyRight"><code>mp_weno</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO    </td></tr>
 <tr class="markdownTableRowEven">
-<td class="markdownTableBodyRight"><code>weno_Re_flux</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Compute velocity gradient using scaler divergence theorem    </td></tr>
+<td class="markdownTableBodyRight"><code>riemann_solver</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact*    </td></tr>
 <tr class="markdownTableRowOdd">
+<td class="markdownTableBodyRight"><code>avg_state</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Averaged state evaluation method: [1] Roe averagen*; [2] Arithmetic mean    </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyRight"><code>wave_speeds</code>   </td><td class="markdownTableBodyCenter">Integer   </td><td class="markdownTableBodyLeft">Wave-speed estimation: [1] Direct (Batten et al. 1997); [2] Pressure-velocity* (Toro 1999)    </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyRight"><code>weno_Re_flux</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Compute velocity gradient using scaler divergence theorem    </td></tr>
+<tr class="markdownTableRowEven">
 <td class="markdownTableBodyRight"><code>weno_avg</code>   </td><td class="markdownTableBodyCenter">Logical   </td><td class="markdownTableBodyLeft">Arithmetic mean of left and right, WENO-reconstructed, cell-boundary values   </td></tr>
 </table>
 <ul>
@@ -496,7 +502,10 @@ <h2><a class="anchor" id="autotoc_md14"></a>
 <li><code>adap_dt</code> activates the Strang operator splitting scheme which splits flux and source terms in time marching, and an adaptive time stepping strategy is implemented for the source term. It requires &lsquo;bubbles = 'T&rsquo;<code>,</code>polytropic = 'T'<code>,</code>adv_n = 'T'<code>and</code>time_stepper = 3`.</li>
 <li><code>weno_order</code> specifies the order of WENO scheme that is used for spatial reconstruction of variables by an integer of 1, 3, and 5, that correspond to the 1st, 3rd, and 5th order, respectively.</li>
 <li><code>weno_eps</code> specifies the lower bound of the WENO nonlinear weights. Practically, <code>weno_eps</code> $&lt;10^{-6}$ is used.</li>
-<li><code>mapped_weno</code> activates mapping of the nonlinear WENO weights to the more accurate nonlinear weights in order to reinstate the optimal order of accuracy of the reconstruction in the proximity of critical points (<a href="references.md#Henrick05">Henrick et al., 2005</a>).</li>
+<li><code>mapped_weno</code> activates the WENO-M scheme in place of the default WENO-JS scheme (<a href="references.md#Henrick05">Henrick et al., 2005</a>). WENO-M a variant of the WENO scheme that remaps the nonlinear WENO-JS weights by assigning larger weights to non-smooth stencils, reducing dissipation compared to the default WENO-JS scheme, at the expense of higher computational cost. Only one of <code>mapped_weno</code>, <code>wenoz</code>, and <code>teno</code> can be activated.</li>
+<li><code>wenoz</code> activates the WENO-Z scheme in place of the default WENO-JS scheme (<a href="references.md#Borges08">Borges et al., 2008</a>). WENO-Z is a variant of the WENO scheme that further reduces the dissipation compared to the WENO-M scheme. It has similar computational cost to the WENO-JS scheme.</li>
+<li><code>teno</code> activates the TENO scheme in place of the default WENO-JS scheme (<a href="references.md#Fu16">Fu et al., 2016</a>). TENO is a variant of the ENO scheme that is the least dissipative, but could be less robust for extreme cases. It uses a threshold to identify smooth and non-smooth stencils, and applies optimal weights to the smooth stencils. Only available for <code>weno_order = 5</code>. Requires <code>teno_CT</code> to be set.</li>
+<li><code>teno_CT</code> specifies the threshold for the TENO scheme. This dimensionless constant, also known as $C_T$, sets a threshold to identify smooth and non-smooth stencils. Larger values make the scheme more robust but also more dissipative. A recommended value for teno_CT is <code>1e-6</code>. When adjusting this parameter, it is recommended to try values like <code>1e-5</code> or <code>1e-7</code>.</li>
 <li><code>null_weights</code> activates nullification of the nonlinear WENO weights at the buffer regions outside the domain boundaries when the Riemann extrapolation boundary condition is specified (<code>bc_[x,y,z]\beg[end]} = -4</code>).</li>
 <li><code>mp_weno</code> activates monotonicity preservation in the WENO reconstruction (MPWENO) such that the values of reconstructed variables do not reside outside the range spanned by WENO stencil (<a href="references.md#Balsara00">Balsara and Shu, 2000</a>; <a href="references.md#Suresh97">Suresh and Huynh, 1997</a>).</li>
 <li><code>riemann_solver</code> specifies the choice of the Riemann solver that is used in simulation by an integer from 1 through 3. <code>riemann_solver = 1</code>, <code>2</code>, and <code>3</code> correspond to HLL, HLLC, and Exact Riemann solver, respectively (<a href="references.md#Toro13">Toro, 2013</a>).</li>

documentation/md_case.html

@@ -136,88 +136,88 @@
 <div class="contents">
 <div class="textblock"><p><a class="anchor" id="autotoc_md29"></a></p>
 <h1><a class="anchor" id="autotoc_md30"></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_md31"></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_md32"></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_md33"></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_md31"></a>
+<h2><a class="anchor" id="autotoc_md34"></a>
 Density Initial Condition</h2>
 <div class="image">
 <img src="alpha_rho1_initial-2D_riemann_test-example.png" alt=""/>
 <div class="caption">
 Density</div></div>
-    <h2><a class="anchor" id="autotoc_md32"></a>
+    <h2><a class="anchor" id="autotoc_md35"></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_md33"></a>
+    <h1><a class="anchor" id="autotoc_md36"></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_md34"></a>
+<h2><a class="anchor" id="autotoc_md37"></a>
 Initial Condition</h2>
 <div class="image">
 <img src="initial-1D_titarevtorro-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md35"></a>
+    <h2><a class="anchor" id="autotoc_md38"></a>
 Result</h2>
 <div class="image">
 <img src="result-1D_titarevtorro-example.png" alt=""/>
 <div class="caption">
 Result</div></div>
-    <h1><a class="anchor" id="autotoc_md36"></a>
+    <h1><a class="anchor" id="autotoc_md39"></a>
 Rayleigh-Taylor Instability (2D)</h1>
-<h2><a class="anchor" id="autotoc_md37"></a>
+<h2><a class="anchor" id="autotoc_md40"></a>
 Final Condition</h2>
 <div class="image">
 <img src="final_condition-2D_rayleigh_taylor-example.png" alt=""/>
 <div class="caption">
 Final Condition</div></div>
-    <h2><a class="anchor" id="autotoc_md38"></a>
+    <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_md39"></a>
+<h1><a class="anchor" id="autotoc_md42"></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_md40"></a>
+<h2><a class="anchor" id="autotoc_md43"></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_md41"></a>
+    <h2><a class="anchor" id="autotoc_md44"></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_md42"></a>
+    <h1><a class="anchor" id="autotoc_md45"></a>
 2D Hardcodied IC Example</h1>
-<h2><a class="anchor" id="autotoc_md43"></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>
-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>
-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_md46"></a>
 Initial Condition</h2>
 <div class="image">
-<img src="initial-1D_shuosher-example.png" alt=""/>
+<img src="initial-2D_hardcodied_ic-example.png" alt=""/>
 <div class="caption">
 Initial Condition</div></div>
     <h2><a class="anchor" id="autotoc_md47"></a>
 Result</h2>
-<div class="image">
-<img src="result-1D_shuosher-example.png" alt=""/>
-<div class="caption">
-Result</div></div>
-    <h1><a class="anchor" id="autotoc_md48"></a>
+<p><img src="result-2D_hardcodied_ic-example.png" alt="" class="inline" title="Result"/>    </p>
+<h1><a class="anchor" id="autotoc_md48"></a>
 Rayleigh-Taylor Instability (3D)</h1>
 <h2><a class="anchor" id="autotoc_md49"></a>
 Final Condition</h2>

documentation/md_examples.html

@@ -166,6 +166,12 @@
 <li><a class="anchor" id="Henrick05"></a>Henrick, A. K., Aslam, T. D., and Powers, J. M. (2005). Mapped weighted essentially nonoscillatory schemes: achieving optimal order near critical points. Journal of Computational Physics, 207(2):542–567.</li>
 </ul>
 <ul>
+<li><a class="anchor" id="Borges08"></a>Borges, R., Carmona, M., Costa, B., and Don, W. S. (2008). An improved weighted essentially non-oscillatory scheme for hyperbolic conservation laws. Journal of computational physics, 227(6):3191–3211.</li>
+</ul>
+<ul>
+<li><a class="anchor" id="Fu16"></a>Fu, L., Hu, X. Y., and Adams, N. A. (2016). A family of high-order targeted ENO schemes for compressible-fluid simulations. Journal of Computational Physics, 305:333–359.</li>
+</ul>
+<ul>
 <li><a class="anchor" id="Johnsen08"></a>Johnsen, E. (2008). Numerical simulations of non-spherical bubble collapse: With applications to shockwave lithotripsy. PhD thesis, California Institute of Technology.</li>
 </ul>
 <ul>

documentation/md_references.html

@@ -61,27 +61,27 @@ var NAVTREE =
       ] ]
     ] ],
     [ "Example Cases", "md_examples.html", [
-      [ "2D Riemann Test (2D)", "md_examples.html#autotoc_md30", [
-        [ "Density Initial Condition", "md_examples.html#autotoc_md31", null ],
-        [ "Density Final Condition", "md_examples.html#autotoc_md32", null ]
+      [ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md30", [
+        [ "Initial Condition", "md_examples.html#autotoc_md31", null ],
+        [ "Result", "md_examples.html#autotoc_md32", null ]
       ] ],
-      [ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md33", [
-        [ "Initial Condition", "md_examples.html#autotoc_md34", null ],
-        [ "Result", "md_examples.html#autotoc_md35", null ]
+      [ "2D Riemann Test (2D)", "md_examples.html#autotoc_md33", [
+        [ "Density Initial Condition", "md_examples.html#autotoc_md34", null ],
+        [ "Density Final Condition", "md_examples.html#autotoc_md35", null ]
       ] ],
-      [ "Rayleigh-Taylor Instability (2D)", "md_examples.html#autotoc_md36", [
-        [ "Final Condition", "md_examples.html#autotoc_md37", null ],
-        [ "Centerline Velocities", "md_examples.html#autotoc_md38", null ]
+      [ "Titarev-Toro problem (1D)", "md_examples.html#autotoc_md36", [
+        [ "Initial Condition", "md_examples.html#autotoc_md37", null ],
+        [ "Result", "md_examples.html#autotoc_md38", null ]
       ] ],
-      [ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md39", [
-        [ "Density", "md_examples.html#autotoc_md40", null ],
-        [ "Density Norms", "md_examples.html#autotoc_md41", null ]
+      [ "Rayleigh-Taylor Instability (2D)", "md_examples.html#autotoc_md39", [
+        [ "Final Condition", "md_examples.html#autotoc_md40", null ],
+        [ "Centerline Velocities", "md_examples.html#autotoc_md41", 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 ]
+      [ "Isentropic vortex problem (2D)", "md_examples.html#autotoc_md42", [
+        [ "Density", "md_examples.html#autotoc_md43", null ],
+        [ "Density Norms", "md_examples.html#autotoc_md44", null ]
       ] ],
-      [ "Shu-Osher problem (1D)", "md_examples.html#autotoc_md45", [
+      [ "2D Hardcodied IC Example", "md_examples.html#autotoc_md45", [
         [ "Initial Condition", "md_examples.html#autotoc_md46", null ],
         [ "Result", "md_examples.html#autotoc_md47", null ]
       ] ],

documentation/navtreedata.js

@@ -7,5 +7,5 @@ var searchData=
   ['13_20body_20forces_4',['13. Body Forces',['../md_case.html#autotoc_md21',1,'']]],
   ['16m_20grid_20points_5',['16M Grid Points',['../md_expectedPerformance.html#autotoc_md72',1,'']]],
   ['1_3a_20setting_20up_20your_20environment_6',['Step 1: Setting up your Environment',['../md_visualization.html#autotoc_md100',1,'']]],
-  ['1d_7',['1D',['../md_examples.html#autotoc_md58',1,'Lax shock tube problem (1D)'],['../md_examples.html#autotoc_md45',1,'Shu-Osher problem (1D)'],['../md_examples.html#autotoc_md33',1,'Titarev-Toro problem (1D)']]]
+  ['1d_7',['1D',['../md_examples.html#autotoc_md58',1,'Lax shock tube problem (1D)'],['../md_examples.html#autotoc_md30',1,'Shu-Osher problem (1D)'],['../md_examples.html#autotoc_md36',1,'Titarev-Toro problem (1D)']]]
 ];

…mentation/result-1D_shuosher-example.png …ation/result-1D_shuosher_old-example.pngdocumentation/result-1D_shuosher-example.png renamed to documentation/result-1D_shuosher_old-example.png documentation/result-1D_shuosher-example.png renamed to documentation/result-1D_shuosher_old-example.png

@@ -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_md101',1,'']]],
-  ['2d_2',['2D',['../md_examples.html#autotoc_md30',1,'2D Riemann Test (2D)'],['../md_examples.html#autotoc_md39',1,'Isentropic vortex problem (2D)'],['../md_examples.html#autotoc_md55',1,'Lid-Driven Cavity Problem (2D)'],['../md_examples.html#autotoc_md36',1,'Rayleigh-Taylor Instability (2D)'],['../md_examples.html#autotoc_md61',1,'Shock Droplet (2D)']]],
-  ['2d_20hardcodied_20ic_20example_3',['2D Hardcodied IC Example',['../md_examples.html#autotoc_md42',1,'']]],
-  ['2d_20riemann_20test_202d_4',['2D Riemann Test (2D)',['../md_examples.html#autotoc_md30',1,'']]]
+  ['2d_2',['2D',['../md_examples.html#autotoc_md33',1,'2D Riemann Test (2D)'],['../md_examples.html#autotoc_md42',1,'Isentropic vortex problem (2D)'],['../md_examples.html#autotoc_md55',1,'Lid-Driven Cavity Problem (2D)'],['../md_examples.html#autotoc_md39',1,'Rayleigh-Taylor Instability (2D)'],['../md_examples.html#autotoc_md61',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_md33',1,'']]]
 ];

documentation/search/all_0.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_md65',1,'']]]
 ];