Skip to content

Commit 3e2cd11

Browse files
author
MFC Action
committed
Docs @ 6e8ded8
1 parent e3ecff4 commit 3e2cd11

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

documentation/md_case.html

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -479,12 +479,14 @@ <h2><a class="anchor" id="autotoc_md14"></a>
479479
<tr class="markdownTableRowEven">
480480
<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>
481481
<tr class="markdownTableRowOdd">
482-
<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>
482+
<td class="markdownTableBodyRight"><code>low_Mach</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Low Mach number correction for HLLC Riemann solver: [0] None; [1] Pressure (Chen et al. 2022); [2] Velocity (Thornber et al. 2008) </td></tr>
483483
<tr class="markdownTableRowEven">
484-
<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>
484+
<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>
485485
<tr class="markdownTableRowOdd">
486-
<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>
486+
<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>
487487
<tr class="markdownTableRowEven">
488+
<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>
489+
<tr class="markdownTableRowOdd">
488490
<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>
489491
</table>
490492
<ul>
@@ -518,6 +520,7 @@ <h2><a class="anchor" id="autotoc_md14"></a>
518520
<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>
519521
<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>
520522
<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>
523+
<li><code>low_Mach</code> specifies the choice of the low Mach number correction scheme for the HLLC Riemann solver. <code>low_Mach = 0</code> is default value and does not apply any correction scheme. <code>low_Mach = 1</code> and <code>2</code> apply the anti-dissipation pressure correction method (<a href="references.md#Chen22">Chen et al., 2022</a>) and the improved velocity reconstruction method (<a href="reference.md#Thornber08">Thornber et al., 2008</a>). This feature requires <code>riemann_solver = 2</code> and <code>model_eqns = 2</code>.</li>
521524
<li><code>avg_state</code> specifies the choice of the method to compute averaged variables at the cell-boundaries from the left and the right states in the Riemann solver by an integer of 1 or 2. <code>avg_state = 1</code> and <code>2</code> correspond to Roe- and arithmetic averages, respectively.</li>
522525
<li><code>wave_speeds</code> specifies the choice of the method to compute the left, right, and middle wave speeds in the Riemann solver by an integer of 1 and 2. <code>wave_speeds = 1</code> and <code>2</code> correspond to the direct method (<a href="references.md#Batten97">Batten et al., 1997</a>), and indirect method that approximates the pressures and velocity (<a href="references.md#Toro13">Toro, 2013</a>), respectively.</li>
523526
<li><code>weno_Re_flux</code> activates the scaler divergence theorem in computing the velocity gradients using WENO-reconstructed cell boundary values. If this option is false, velocity gradient is computed using finite difference scheme of order 2 which is independent of the WENO order.</li>

documentation/md_references.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,9 @@
151151
<li><a class="anchor" id="Bryngelson19"></a>Bryngelson, S. H., Schmidmayer, K., Coralic, V., Meng, J. C., Maeda, K., and Colonius, T. (2019). Mfc: An open-source high-order multi-component, multi-phase, and multi-scale compressible flow solver. arXiv preprint arXiv:1907.10512.</li>
152152
</ul>
153153
<ul>
154+
<li><a class="anchor" id="Chen22"></a>Chen, S. S., Li, J. P., Li, Z., Yuan, W., &amp; Gao, Z. H. (2022). Anti-dissipation pressure correction under low Mach numbers for Godunov-type schemes. Journal of Computational Physics, 456, 111027. </li>
155+
</ul>
156+
<ul>
154157
<li><a class="anchor" id="Childs12"></a>Childs, H., Brugger, E., Whitlock, B., Meredith, J., Ahern, S., Pugmire, D., Biagas, K., Miller, M., Harrison, C., Weber, G. H., Krishnan, H., Fogal, T., Sanderson, A., Garth, C., Bethel, E. W., Camp, D., R¨ubel, O., Durant, M., Favre, J. M., and Navr´atil, P. (2012). VisIt: An End-User Tool For Visualizing and Analyzing Very Large Data. In High Performance Visualization–Enabling Extreme-Scale Scientific Insight, pages 357–372.</li>
155158
</ul>
156159
<ul>
@@ -199,6 +202,9 @@
199202
<li><a class="anchor" id="Thompson90"></a>Thompson, K. W. (1990). Time-dependent boundary conditions for hyperbolic systems, ii. Journal of computational physics, 89(2):439–461.</li>
200203
</ul>
201204
<ul>
205+
<li><a class="anchor" id="Thornber08"></a>Thornber, B., Mosedale, A., Drikakis, D., Youngs, D., &amp; Williams, R. J. (2008). An improved reconstruction method for compressible flows with low Mach number features. Journal of computational Physics, 227(10), 4873-4894.</li>
206+
</ul>
207+
<ul>
202208
<li><a class="anchor" id="Titarev04"></a>Titarev, V. A. and Toro, E. F. (2004). Finite-volume weno schemes for three-dimensional conservation laws. Journal of Computational Physics, 201(1):238–260.</li>
203209
</ul>
204210
<ul>

0 commit comments

Comments
 (0)