Skip to content

Commit 9d3b95f

Browse files
author
MFC Action
committed
Docs @ b9e6875
1 parent 0e3d156 commit 9d3b95f

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

documentation/md_case.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,7 @@ <h2><a class="anchor" id="autotoc_md7"></a>
296296
<h3><a class="anchor" id="autotoc_md8"></a>
297297
Analytical Definition of Primitive Variables</h3>
298298
<p>Some parameters, as described above, can be defined by analytical functions in the input file. For example, one can define the following patch:</p>
299-
<div class="fragment"><div class="line">&#39;patch_icpp(2)%geometry&#39; : 15,</div>
299+
<div class="fragment"><div class="line">&#39;patch_icpp(2)%geometry&#39; : 1,</div>
300300
<div class="line">&#39;patch_icpp(2)%x_centroid&#39; : 0.25,</div>
301301
<div class="line">&#39;patch_icpp(2)%length_x&#39; : 9.5,</div>
302302
<div class="line">&#39;patch_icpp(2)%vel(1)&#39; : 0.,</div>
@@ -331,7 +331,7 @@ <h3><a class="anchor" id="autotoc_md8"></a>
331331
<div class="fragment"><div class="line">90</div>
332332
<div class="line"> <span class="keywordflow">case</span>(200)</div>
333333
<div class="line"> ! primitive variables assignment</div>
334-
</div><!-- fragment --><p>and use <code>patch_icpp(i)%geometry = 7</code> and <code>patch_icpp(i)%hcid = 200</code> in the input file. Additional variables can be declared in <code>Hardcoded1[2,3]DVariables</code> and used in <code>hardcoded1[2,3]D</code>. As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indites the number of dimensions.</p>
334+
</div><!-- fragment --><p>and use <code>patch_icpp(i)%geometry = 7</code> and <code>patch_icpp(i)%hcid = 200</code> in the input file. Additional variables can be declared in <code>Hardcoded1[2,3]DVariables</code> and used in <code>hardcoded1[2,3]D</code>. As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indicates the number of dimensions.</p>
335335
<h3><a class="anchor" id="autotoc_md10"></a>
336336
Parameter Descriptions</h3>
337337
<ul>
@@ -467,11 +467,11 @@ <h2><a class="anchor" id="autotoc_md14"></a>
467467
<tr class="markdownTableRowEven">
468468
<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>
469469
<tr class="markdownTableRowOdd">
470-
<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>
470+
<td class="markdownTableBodyRight"><code>avg_state</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Averaged state evaluation method: [1] Roe average*; [2] Arithmetic mean </td></tr>
471471
<tr class="markdownTableRowEven">
472472
<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>
473473
<tr class="markdownTableRowOdd">
474-
<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>
474+
<td class="markdownTableBodyRight"><code>weno_Re_flux</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Compute velocity gradient using scalar divergence theorem </td></tr>
475475
<tr class="markdownTableRowEven">
476476
<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>
477477
<tr class="markdownTableRowOdd">
@@ -526,7 +526,7 @@ <h2><a class="anchor" id="autotoc_md14"></a>
526526
<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="references.md#Thornber08">Thornber et al., 2008</a>). This feature requires <code>riemann_solver = 2</code> and <code>model_eqns = 2</code>.</li>
527527
<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>
528528
<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>
529-
<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>
529+
<li><code>weno_Re_flux</code> activates the scalar 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>
530530
<li><code>weno_avg</code> it activates the arithmetic average of the left and right, WENO-reconstructed, cell-boundary values. This option requires <code>weno_Re_flux</code> to be true because cell boundary values are only utilized when employing the scalar divergence method in the computation of velocity gradients.</li>
531531
</ul>
532532
<h3><a class="anchor" id="autotoc_md15"></a>
@@ -689,7 +689,7 @@ <h2><a class="anchor" id="acoustic-source"></a>
689689
<li><code>%aperture</code> specifies the aperture of the transducer. It is the diameter of the projection of the transducer arc onto the y-axis (2D) or spherical cap onto the y-z plane (3D). To simulate a transducer enclosing half of the circle/sphere, set the aperture to double the focal length. For transducer array, it is the total aperture of the array.</li>
690690
<li><code>%num_elements</code> specifies the number of transducer elements in a transducer array.</li>
691691
<li><code>%element_on</code> specifies the element number of the transducer array that is on. The element number starts from 1. If all elements are on, set <code>%element_on</code> to 0.</li>
692-
<li><code>%element_spacing_angle</code> specifies the spacing angle between adjacent transducer in radian. The total aperture (<code>%aperture</code>) is set, so each transducer element is smaller if <code>%element_spacing_angle</code> is larger.</li>
692+
<li><code>%element_spacing_angle</code> specifies the spacing angle between adjacent transducer in radians. The total aperture (<code>%aperture</code>) is set, so each transducer element is smaller if <code>%element_spacing_angle</code> is larger.</li>
693693
<li><code>%element_polygon_ratio</code> specifies the ratio of the polygon side length to the aperture diameter of each transducer element in a circular 3D transducer array. The polygon side length is calculated by using the total aperture (<code>%aperture</code>) as the circumcicle diameter, and <code>%num_elements</code> as the number of sides of the polygon. The ratio is used specify the aperture size of each transducer element in the array, as a ratio of the total aperture.</li>
694694
<li><code>%rotate_angle</code> specifies the rotation angle of the 3D circular transducer array along the x-axis (principal axis). It is optional and defaults to 0.</li>
695695
</ul>
@@ -777,7 +777,7 @@ <h2><a class="anchor" id="autotoc_md19"></a>
777777
<tr class="markdownTableHead">
778778
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
779779
<tr class="markdownTableRowOdd">
780-
<td class="markdownTableBodyRight"><code>perturb_flow</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Perturb the initlal velocity field by random noise </td></tr>
780+
<td class="markdownTableBodyRight"><code>perturb_flow</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Perturb the initlial velocity field by random noise </td></tr>
781781
<tr class="markdownTableRowEven">
782782
<td class="markdownTableBodyRight"><code>perturb_flow_fluid</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Fluid density whose flow is to be perturbed </td></tr>
783783
<tr class="markdownTableRowOdd">
@@ -918,7 +918,7 @@ <h2><a class="anchor" id="autotoc_md25"></a>
918918
<tr class="markdownTableRowEven">
919919
<td class="markdownTableBodyRight">6 </td><td class="markdownTableBodyCenter">N/A </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">No longer exists. Empty. </td></tr>
920920
<tr class="markdownTableRowOdd">
921-
<td class="markdownTableBodyRight">7 </td><td class="markdownTableBodyCenter">2D analytical </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions. </td></tr>
921+
<td class="markdownTableBodyRight">7 </td><td class="markdownTableBodyCenter">2D Hardcoded </td><td class="markdownTableBodyCenter">2 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions. </td></tr>
922922
<tr class="markdownTableRowEven">
923923
<td class="markdownTableBodyRight">8 </td><td class="markdownTableBodyCenter">Sphere </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code> and <code>radius</code> </td></tr>
924924
<tr class="markdownTableRowOdd">
@@ -930,11 +930,11 @@ <h2><a class="anchor" id="autotoc_md25"></a>
930930
<tr class="markdownTableRowEven">
931931
<td class="markdownTableBodyRight">12 </td><td class="markdownTableBodyCenter">Ellipsoid </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code> and <code>radii(i)</code>. </td></tr>
932932
<tr class="markdownTableRowOdd">
933-
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">3D analytical </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
933+
<td class="markdownTableBodyRight">13 </td><td class="markdownTableBodyCenter">3D Hardcoded </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
934934
<tr class="markdownTableRowEven">
935935
<td class="markdownTableBodyRight">14 </td><td class="markdownTableBodyCenter">Spherical Harmonic </td><td class="markdownTableBodyCenter">3 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Requires <code>[x,y,z]_centroid</code>, <code>radius</code>, <code>epsilon</code>, <code>beta</code> </td></tr>
936936
<tr class="markdownTableRowOdd">
937-
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyCenter">1D analytical </td><td class="markdownTableBodyCenter">1 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
937+
<td class="markdownTableBodyRight">15 </td><td class="markdownTableBodyCenter">1D Hardcoded </td><td class="markdownTableBodyCenter">1 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Assigns the primitive variables as analytical functions </td></tr>
938938
<tr class="markdownTableRowEven">
939939
<td class="markdownTableBodyRight">16 </td><td class="markdownTableBodyCenter">1D bubble pulse </td><td class="markdownTableBodyCenter">1 </td><td class="markdownTableBodyCenter">N </td><td class="markdownTableBodyLeft">Requires <code>x_centroid</code>, <code>length_x</code> </td></tr>
940940
<tr class="markdownTableRowOdd">

0 commit comments

Comments
 (0)