<div class="contents">

<div class="textblock"><p><a class="anchor" id="md_readme"></a> </p>

User Documentation</h1>

<li><a class="el" href="md_getting-started.html">Getting Started</a></li>

<li><a class="el" href="md_authors.html">MFC's Authors</a></li>

<li><a class="el" href="md_references.html">References</a></li>

Code/API Documentation</h1>

<p>MFC's three codes have their own documentation:</p>

var index =

<li>'modelscale', 'modelrotate<code>and</code>modeltranslate<code>define how the model should be transformed to domain-space by first scaling by</code>modelscale<code>, then rotating about the Z, X, and Y axes (using</code>modelrotate<code>), and finally translating by</code>modeltranslate`.</li>

<h2><a class="anchor" id="autotoc_md11"></a>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<li><code>fluid_pp(i)cv</code>, <code>fluid_pp(i)qv</code>, and <code>fluid_pp(i)qvp</code> define $c_v$, $q$, and $q'$ as parameters of $i$-th fluid that are used in stiffened gas equation of state.</li>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<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>

<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>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<li><code>fd_order</code> specifies the order of the finite difference scheme that is used to compute the vorticity from the velocity field and the numerical schlieren from the density field by an integer of 1, 2, and 4. <code>fd_order</code> $=$ 1, 2, and 4 correspond to the first, second, and fourth-order finite difference schemes, respectively.</li>

<li><code>probe_wrt</code> activates output of state variables at coordinates specified by <code>probe(i)%[x;y,z]</code>.</li>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<li><code>Mono(i)support</code> specifies the choice of the geometry of acoustic source distribution of $i$-th source plane by an integer from 1 through 3:\ <code>Mono(i)support</code> $=1$ specifies an infinite source plane that is normal to the $x$-axis and intersects with the axis at $x=$ <code>Mono(i)loc(1)</code> in 1-D simulation.\ <code>Mono(i)support</code> $=2$ specifies a semi-infinite source plane in 2-D simulation. The $i$-th source plane is determined by the point at [<code>Mono(i)loc(1)</code>, <code>Mono(i)loc(2)</code>] and the normal vector [$\mathrm{cos}$(<code>Mono(i)dir</code>), $\mathrm{sin}$(<code>Mono(i)dir</code>)] that consists of this point. The source plane is defined in the finite region of the domain: $x\in[-\infty,\infty]$ and $y\in$[-<code>mymono_length</code>/2, <code>mymono_length</code>/2].\ <code>Mono(i)support</code> $=3$ specifies a semi-infinite source plane in 3-D simulation. The $i$-th source plane is determined by the point at [<code>Mono(i)loc(1)</code>, <code>Mono(i)loc(2)</code>, <code>Mono(i)loc(3)</code>] and the normal vector [$\mathrm{cos}$(<code>Mono(i)dir</code>), $\mathrm{sin}$(<code>Mono(i)dir</code>), 1] that consists of this point. The source plane is defined in the finite region of the domain: $x\in[-\infty,\infty]$ and $y,z\in$[-<code>mymono_length</code>/2, <code>mymono_length</code>/2]. There are a few additional spatial support types available for special source types and coordinate systems tabulated in Monopole supports.</li>

<li><code>Mono(i)support_width</code> defines how many cell width the monopole support function extended by. Large <code>Mono(i)support_width</code> is preferred when <code>Mono(i)mag</code> is large.</li>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<li><code>rhoRV</code> specifies the correlation coefficient of the joint PDF of bubble radius and bubble velocity required in qbmm. <br />

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<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>

<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 2D and 3D cases, together with <code>vel_profile = TRUE</code>.</li>

<table class="markdownTable">

<tr class="markdownTableHead">

<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>

<li><code>palpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pT-equilibrium model.</li>

<li><code>ptgalpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pTg-equilibrium model.</li>

Enumerations</h1>

Boundary conditions</h2>

<table class="markdownTable">

<tr class="markdownTableHead">

<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>

<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>

Patch types</h2>

<table class="markdownTable">

<tr class="markdownTableHead">

<td class="markdownTableBodyRight">21 </td><td class="markdownTableBodyCenter">Model </td><td class="markdownTableBodyCenter">2 &amp; 3 </td><td class="markdownTableBodyCenter">Y </td><td class="markdownTableBodyLeft">Imports a Model (STL/OBJ). Requires <code>modelfilepath</code>. </td></tr>

<p>The patch types supported by the MFC are listed in table Patch Types. This includes types exclusive to one-, two-, and three-dimensional problems. The patch type number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>patch_icpp(j)geometry</code> where $j$ is the patch index. Each patch requires a different set of parameters, which are also listed in this table.</p>

Monopole supports</h2>

<table class="markdownTable">

<tr class="markdownTableHead">

<td class="markdownTableBodyNone">6 </td><td class="markdownTableBodyNone">Cyl_coord along axial-dir </td></tr>

<p>The monopole support types available in MFC are listed in table Monopole supports. This includes types exclusive to one-, two-, and three-dimensional problems with special sauce geometry like transducers as well as coordinate systems such as cylindrical coordinates. The monopole support number (<code>#</code>) corresponds to the input value in <code>input.py</code> labeled <code>Mono(i)support</code> where $i$ is the monopole source index.</p>

Conservative Variables Ordering</h2>

<table class="markdownTable">

<tr class="markdownTableHead">

<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>

<p>The above variables correspond to optional physics.</p>

Primitive Variables Ordering</h2>

<table class="markdownTable">

<tr class="markdownTableHead">