You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<p>We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
128
128
<p>We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.</p>
129
-
<h1><aclass="anchor" id="autotoc_md25"></a>
129
+
<h1><aclass="anchor" id="autotoc_md26"></a>
130
130
Our Standards</h1>
131
131
<p>Examples of behavior that contributes to a positive environment for our community include:</p>
<li>Publishing others' private information, such as a physical or email address, without their explicit permission</li>
145
145
<li>Other conduct which could reasonably be considered inappropriate in a professional setting</li>
146
146
</ul>
147
-
<h1><aclass="anchor" id="autotoc_md26"></a>
147
+
<h1><aclass="anchor" id="autotoc_md27"></a>
148
148
Enforcement Responsibilities</h1>
149
149
<p>Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.</p>
150
150
<p>Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.</p>
151
-
<h1><aclass="anchor" id="autotoc_md27"></a>
151
+
<h1><aclass="anchor" id="autotoc_md28"></a>
152
152
Scope</h1>
153
153
<p>This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.</p>
154
-
<h1><aclass="anchor" id="autotoc_md28"></a>
154
+
<h1><aclass="anchor" id="autotoc_md29"></a>
155
155
Enforcement</h1>
156
156
<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at <ahref="#" onclick="location.href='mai'+'lto:'+'shb'+'@g'+'ate'+'ch'+'.ed'+'u'; return false;">shb@g<spanclass="obfuscator">.nosp@m.</span>atec<spanclass="obfuscator">.nosp@m.</span>h.edu</a>. All complaints will be reviewed and investigated promptly and fairly.</p>
157
157
<p>All community leaders are obligated to respect the privacy and security of the reporter of any incident.</p>
158
-
<h1><aclass="anchor" id="autotoc_md29"></a>
158
+
<h1><aclass="anchor" id="autotoc_md30"></a>
159
159
Enforcement Guidelines</h1>
160
160
<p>Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:</p>
161
-
<h2><aclass="anchor" id="autotoc_md30"></a>
161
+
<h2><aclass="anchor" id="autotoc_md31"></a>
162
162
1. Correction</h2>
163
163
<p><b>Community Impact</b>: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.</p>
164
164
<p><b>Consequence</b>: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.</p>
165
-
<h2><aclass="anchor" id="autotoc_md31"></a>
165
+
<h2><aclass="anchor" id="autotoc_md32"></a>
166
166
2. Warning</h2>
167
167
<p><b>Community Impact</b>: A violation through a single incident or series of actions.</p>
168
168
<p><b>Consequence</b>: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.</p>
169
-
<h2><aclass="anchor" id="autotoc_md32"></a>
169
+
<h2><aclass="anchor" id="autotoc_md33"></a>
170
170
3. Temporary Ban</h2>
171
171
<p><b>Community Impact</b>: A serious violation of community standards, including sustained inappropriate behavior.</p>
172
172
<p><b>Consequence</b>: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.</p>
173
-
<h2><aclass="anchor" id="autotoc_md33"></a>
173
+
<h2><aclass="anchor" id="autotoc_md34"></a>
174
174
4. Permanent Ban</h2>
175
175
<p><b>Community Impact</b>: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.</p>
176
176
<p><b>Consequence</b>: A permanent ban from any sort of public interaction within the community.</p>
177
-
<h1><aclass="anchor" id="autotoc_md34"></a>
177
+
<h1><aclass="anchor" id="autotoc_md35"></a>
178
178
Attribution</h1>
179
179
<p>This Code of Conduct is adapted from the <ahref="https://www.contributor-covenant.org">Contributor Covenant</a>, version 2.0, available at <ahref="https://www.contributor-covenant.org/version/2/0/code_of_conduct.html">https://www.contributor-covenant.org/version/2/0/code_of_conduct.html</a>.</p>
180
180
<p>Community Impact Guidelines were inspired by <ahref="https://github.com/mozilla/diversity">Mozilla's code of conduct enforcement ladder</a>.</p>
<li>(Optional) Ensemble-Averaged Bubble Model Parameters</li>
171
171
<li>(Optional) Velocity Field Setup Parameters</li>
172
+
<li>(Optional) Phase Change Parameters</li>
172
173
</ol>
173
-
<p>Items 7, 8, and 9 are optional sets of parameters that activate the acoustic source model, ensemble-averaged bubble model, and initial velocity field setup, respectively. Definition of the parameters is described in the following subsections.</p>
174
+
<p>Items 7, 8, 9, and 10 are optional sets of parameters that activate the acoustic source model, ensemble-averaged bubble model, initial velocity field setup, and phase change, respectively. Definition of the parameters is described in the following subsections.</p>
<tdclass="markdownTableBodyRight"><code>Re(1)</code> * </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Shear viscosity of fluid. </td></tr>
351
352
<trclass="markdownTableRowEven">
352
-
<tdclass="markdownTableBodyRight"><code>Re(2)</code> * </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Volume viscosity of fluid. </td></tr>
353
+
<tdclass="markdownTableBodyRight"><code>Re(2)</code> * </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Volume viscosity of fluid. </td></tr>
354
+
<trclass="markdownTableRowOdd">
355
+
<tdclass="markdownTableBodyRight"><code>cv</code> ** </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Sffened-gas parameter $c_v$ of fluid. </td></tr>
356
+
<trclass="markdownTableRowEven">
357
+
<tdclass="markdownTableBodyRight"><code>qv</code> ** </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Stiffened-gas parameter $q$ of fluid. </td></tr>
358
+
<trclass="markdownTableRowOdd">
359
+
<tdclass="markdownTableBodyRight"><code>qvp</code> ** </td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">Stiffened-gas parameter $q'$ of fluid. </td></tr>
353
360
</table>
354
361
<p>Fluid material's parameters. All parameters should be prepended with <code>fluid_pp(i)</code> where $i$ is the fluid index.</p>
355
362
<p>*: Parameters that work only with <code>model_eqns</code>=2.</p>
363
+
<p>**: Parameters that work only with <code>model_eqns</code>=3.</p>
356
364
<p>The table lists the fluid material's parameters. The parameters define material's property of compressible fluids that are used in simulation.</p>
357
365
<ul>
358
366
<li><code>fluid_pp(i)gamma</code> and <code>fluid_pp(i)pi_inf</code> define $\Gamma$ and $\Pi$ as parameters of $i$-th fluid that are used in stiffened gas equation of state.</li>
359
-
<li><code>fluid_pp(i)Re(1)</code> and <code>fluid_pp(i)Re(2)</code> define the shear and volume viscosities of $i$-th fluid, respectively. When these parameters are undefined, fluids are treated as inviscid. Details of implementation of viscosity in MFC can be found in <ahref="references.md#Coralic15">Coralic (2015)</a>.</li>
367
+
<li><code>fluid_pp(i)Re(1)</code> and <code>fluid_pp(i)Re(2)</code> define the shear and volume viscosities of $i$-th fluid, respectively.</li>
368
+
</ul>
369
+
<p>When these parameters are undefined, fluids are treated as inviscid. Details of implementation of viscosity in MFC can be found in <ahref="references.md#Coralic15">Coralic (2015)</a>.</p>
370
+
<ul>
371
+
<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>
<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>
642
654
<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>
<tdclass="markdownTableBodyRight"><code>palpha_eps</code></td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">tolerance of the Newton Solver to activate pT-equilibrium </td></tr>
667
+
<trclass="markdownTableRowEven">
668
+
<tdclass="markdownTableBodyRight"><code>ptgalpha_eps</code></td><tdclass="markdownTableBodyCenter">Real </td><tdclass="markdownTableBodyLeft">tolerance of the Newton Solver to activate pTg-equilibrium </td></tr>
669
+
</table>
670
+
<ul>
671
+
<li><code>relax</code> Activates the Phase Change model.</li>
672
+
<li><code>relax_model</code> Specifies the phase change model to be used: [5] enables pT-equilibrium, while [6] activates pTg-equilibrium (if criteria are met).</li>
673
+
<li><code>palpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pT-equilibrium model.</li>
674
+
<li><code>ptgalpha_eps</code> Specifies the tolerance used for the Newton Solvers used in the pTg-equilibrium model.</li>
<p>*: This boundary condition is only used for <code>bc_ybeg</code> when using cylindrical coordinates (‘cyl_coord = 'T’<code>and 3d). For axisymmetric problems, use</code>bc_ybeg = -2<code>with</code>cyl_coord = 'T'` in 2D.</p>
683
715
<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 <ahref="references.md#Thompson87">Thompson (1987)</a> and <ahref="references.md#Thompson90">Thompson (1990)</a>.</p>
<tdclass="markdownTableBodyRight">21 </td><tdclass="markdownTableBodyCenter">Model </td><tdclass="markdownTableBodyCenter">2 & 3 </td><tdclass="markdownTableBodyCenter">Y </td><tdclass="markdownTableBodyLeft">Imports a Model (STL/OBJ). Requires <code>modelfilepath</code>. </td></tr>
731
763
</table>
732
764
<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>
<tdclass="markdownTableBodyNone">6 </td><tdclass="markdownTableBodyNone">Cyl_coord along axial-dir </td></tr>
750
782
</table>
751
783
<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>
0 commit comments