Skip to content

Commit b119c34

Browse files
author
MFC Action
committed
Docs @ 4d841aa
1 parent 77b554e commit b119c34

File tree

1 file changed

+22
-13
lines changed

1 file changed

+22
-13
lines changed

documentation/md_case.html

Lines changed: 22 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -365,19 +365,28 @@ <h2><a class="anchor" id="autotoc_md11"></a>
365365
4. Immersed Boundary Patches</h2>
366366
<table class="markdownTable">
367367
<tr class="markdownTableHead">
368-
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadCenter">Analytical Definition Description </th></tr>
368+
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
369+
<tr class="markdownTableRowOdd">
370+
<td class="markdownTableBodyRight"><code>geometry</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Geometry configuration of the patch. </td></tr>
371+
<tr class="markdownTableRowEven">
372+
<td class="markdownTableBodyRight"><code>x[y,z]_centroid</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Centroid of the applied geometry in the [x,y,z]-direction. </td></tr>
369373
<tr class="markdownTableRowOdd">
370-
<td class="markdownTableBodyRight"><code>geometry</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyCenter">Geometry configuration of the patch. </td></tr>
374+
<td class="markdownTableBodyRight"><code>length_x[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Length, if applicable, in the [x,y,z]-direction. </td></tr>
371375
<tr class="markdownTableRowEven">
372-
<td class="markdownTableBodyRight"><code>x[y,z]_centroid</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Centroid of the applied geometry in the [x,y,z]-direction. </td></tr>
376+
<td class="markdownTableBodyRight"><code>radius</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Radius, if applicable, of the applied geometry. </td></tr>
373377
<tr class="markdownTableRowOdd">
374-
<td class="markdownTableBodyRight"><code>length_x[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Length, if applicable, in the [x,y,z]-direction. </td></tr>
378+
<td class="markdownTableBodyRight"><code>theta</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Angle of attach applied to airfoil IB patches </td></tr>
375379
<tr class="markdownTableRowEven">
376-
<td class="markdownTableBodyRight"><code>radius</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Radius, if applicable, of the applied geometry. </td></tr>
380+
<td class="markdownTableBodyRight"><code>c</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">NACA airfoil parameters (see below) </td></tr>
377381
<tr class="markdownTableRowOdd">
378-
<td class="markdownTableBodyRight"><code>theta</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyCenter">Angle of attach applied to airfoil IB patches </td></tr>
382+
<td class="markdownTableBodyRight"><code>t</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">NACA airfoil parameters (see below) </td></tr>
383+
<tr class="markdownTableRowEven">
384+
<td class="markdownTableBodyRight"><code>m</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">NACA airfoil parameters (see below) </td></tr>
385+
<tr class="markdownTableRowOdd">
386+
<td class="markdownTableBodyRight"><code>p</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">NACA airfoil parameters (see below) </td></tr>
387+
<tr class="markdownTableRowEven">
388+
<td class="markdownTableBodyRight"><code>slip</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Apply a slip boundary </td></tr>
379389
</table>
380-
<p>| <code>c</code> | Real | | <code>t</code> | Real | | <code>m</code> | Real | | <code>p</code> | Real | | <code>slip</code> | Logical | Apply a slip boundary |</p>
381390
<p>These parameters should be prepended with <code>patch_ib(j)%</code> where $j$ is the patch index.</p>
382391
<h3><a class="anchor" id="autotoc_md12"></a>
383392
Parameter Descriptions</h3>
@@ -480,8 +489,8 @@ <h2><a class="anchor" id="autotoc_md14"></a>
480489
</table>
481490
<ul>
482491
<li>* Options that work only with <code>model_eqns =2</code>.</li>
483-
<li>† Options that work only with &lsquo;cyl_coord = 'F&rsquo;<code>.</code></li>
484-
<li><code>‡ Options that work only with</code>bc_[x,y,z]%[beg,end] = -15<code>and/or</code>bc_[x,y,z]%[beg,end] = -16`</li>
492+
<li>† Options that work only with <code>cyl_coord = 'F'</code>.</li>
493+
<li>‡ Options that work only with <code>bc_[x,y,z]%[beg,end] = -15</code> and/or <code>bc_[x,y,z]%[beg,end] = -16</code></li>
485494
</ul>
486495
<p>The table lists simulation algorithm parameters. The parameters are used to specify options in algorithms that are used to integrate the governing equations of the multi-component flow based on the initial condition. Models and assumptions that are used to formulate and discritize the governing equations are described in <a href="references.md#Bryngelson19">Bryngelson et al. (2019)</a>. Details of the simulation algorithms and implementation of the WENO scheme can be found in <a href="references.md#Coralic15">Coralic (2015)</a>.</p>
487496
<ul>
@@ -493,13 +502,13 @@ <h2><a class="anchor" id="autotoc_md14"></a>
493502
<li><code>adv_alphan</code> activates the advection equations of all the components of fluid. If this parameter is set false, the void fraction of $N$-th component is computed as the residual of the void fraction of the other components at each cell:</li>
494503
</ul>
495504
<p>$$ \alpha_N=1-\sum^{N-1}_{i=1} \alpha_i $$</p>
496-
<p>where $\alpha_i$ is the void fraction of $i$-th component. When a single-component flow is simulated, it requires that &lsquo;adv_alphan = 'T&rsquo;`.</p>
505+
<p>where $\alpha_i$ is the void fraction of $i$-th component. When a single-component flow is simulated, it requires that <code>adv_alphan = 'T'</code>.</p>
497506
<ul>
498507
<li><code>adv_n</code> activates the direct computation of number density by the Riemann solver instead of computing number density from the void fraction in the method of classes.</li>
499508
<li><code>mpp_lim</code> activates correction of solutions to avoid a negative void fraction of each component in each grid cell, such that $\alpha_i&gt;\varepsilon$ is satisfied at each time step.</li>
500509
<li><code>mixture_err</code> activates correction of solutions to avoid imaginary speed of sound at each grid cell.</li>
501510
<li><code>time_stepper</code> specifies the order of the Runge-Kutta (RK) time integration scheme that is used for temporal integration in simulation, from the 1st to 5th order by corresponding integer. Note that <code>time_stepper = 3</code> specifies the total variation diminishing (TVD), third order RK scheme (<a href="references.md#Gottlieb98">Gottlieb and Shu, 1998</a>).</li>
502-
<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>
511+
<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 <code>bubbles = 'T'</code>, <code>polytropic = 'T'</code>, <code>adv_n = 'T'</code> and <code>time_stepper = 3</code>.</li>
503512
<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>
504513
<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>
505514
<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>
@@ -730,7 +739,7 @@ <h2><a class="anchor" id="autotoc_md18"></a>
730739
<li><code>perturb_sph</code> activates the perturbation of initial partial density by random noise.</li>
731740
<li><code>perturb_sph_fluid</code> specifies the fluid component whose partial density is to be perturbed.</li>
732741
<li><code>vel_profile</code> activates setting the mean streamwise velocity to hyperbolic tangent profile. This option works only for 2D and 3D cases.</li>
733-
<li><code>instability_wave</code> activates the perturbation of initial velocity by instability waves obtained from linear stability analysis for a mixing layer with hyperbolic tangent mean streamwise velocity profile. This option only works for <code>n &gt; 0</code>, <code>bc_y%[beg,end] = -5</code>, and &lsquo;vel_profile = 'T&rsquo;`.</li>
742+
<li><code>instability_wave</code> activates the perturbation of initial velocity by instability waves obtained from linear stability analysis for a mixing layer with hyperbolic tangent mean streamwise velocity profile. This option only works for <code>n &gt; 0</code>, <code>bc_y%[beg,end] = -5</code>, and <code>vel_profile = 'T'</code>.</li>
734743
</ul>
735744
<h2><a class="anchor" id="autotoc_md19"></a>
736745
11. Phase Change Model</h2>
@@ -820,7 +829,7 @@ <h2><a class="anchor" id="autotoc_md23"></a>
820829
<tr class="markdownTableRowOdd">
821830
<td class="markdownTableBodyRight">-16 </td><td class="markdownTableBodyCenter">Normal </td><td class="markdownTableBodyLeft">No-slip wall </td></tr>
822831
</table>
823-
<p>*: This boundary condition is only used for <code>bc_ybeg</code> when using cylindrical coordinates (&lsquo;cyl_coord = 'T&rsquo;<code>and 3D). For axisymmetric problems, use</code>bc_ybeg = -2<code>with</code>cyl_coord = 'T'` in 2D.</p>
832+
<p>*: This boundary condition is only used for <code>bc_ybeg</code> when using cylindrical coordinates (<code>cyl_coord = 'T'</code> and 3D). For axisymmetric problems, use <code>bc_ybeg = -2</code> with <code>cyl_coord = 'T'</code> in 2D.</p>
824833
<p>The boundary condition supported by the MFC are listed in table Boundary Conditions. Their number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>bc_[x,y,z]%[beg,end]</code> (see table Simulation Algorithm Parameters). The entries labeled "Characteristic." are characteristic boundary conditions based on <a href="references.md#Thompson87">Thompson (1987)</a> and <a href="references.md#Thompson90">Thompson (1990)</a>.</p>
825834
<h2><a class="anchor" id="autotoc_md24"></a>
826835
Patch types</h2>

0 commit comments

Comments
 (0)