Skip to content

Commit effbf12

Browse files
author
MFC Action
committed
Docs @ 8aaf0d6
1 parent d2fb55e commit effbf12

40 files changed

+514
-460
lines changed

documentation/doxygen_crawl.html

+10-7
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
<a href="md_case.html#autotoc_md26"/>
3636
<a href="md_case.html#autotoc_md27"/>
3737
<a href="md_case.html#autotoc_md28"/>
38+
<a href="md_case.html#autotoc_md29"/>
3839
<a href="md_case.html#autotoc_md3"/>
3940
<a href="md_case.html#autotoc_md4"/>
4041
<a href="md_case.html#autotoc_md5"/>
@@ -43,7 +44,6 @@
4344
<a href="md_case.html#autotoc_md8"/>
4445
<a href="md_case.html#autotoc_md9"/>
4546
<a href="md_examples.html"/>
46-
<a href="md_examples.html#autotoc_md30"/>
4747
<a href="md_examples.html#autotoc_md31"/>
4848
<a href="md_examples.html#autotoc_md32"/>
4949
<a href="md_examples.html#autotoc_md33"/>
@@ -90,8 +90,8 @@
9090
<a href="md_examples.html#autotoc_md74"/>
9191
<a href="md_examples.html#autotoc_md75"/>
9292
<a href="md_examples.html#autotoc_md76"/>
93+
<a href="md_examples.html#autotoc_md77"/>
9394
<a href="md_expectedPerformance.html"/>
94-
<a href="md_expectedPerformance.html#autotoc_md78"/>
9595
<a href="md_expectedPerformance.html#autotoc_md79"/>
9696
<a href="md_expectedPerformance.html#autotoc_md80"/>
9797
<a href="md_expectedPerformance.html#autotoc_md81"/>
@@ -101,35 +101,38 @@
101101
<a href="md_expectedPerformance.html#autotoc_md85"/>
102102
<a href="md_expectedPerformance.html#autotoc_md86"/>
103103
<a href="md_expectedPerformance.html#autotoc_md87"/>
104+
<a href="md_expectedPerformance.html#autotoc_md88"/>
104105
<a href="md_getting-started.html"/>
105-
<a href="md_getting-started.html#autotoc_md89"/>
106106
<a href="md_getting-started.html#autotoc_md90"/>
107107
<a href="md_getting-started.html#autotoc_md91"/>
108108
<a href="md_getting-started.html#autotoc_md92"/>
109109
<a href="md_getting-started.html#autotoc_md93"/>
110+
<a href="md_getting-started.html#autotoc_md94"/>
110111
<a href="md_papers.html"/>
111112
<a href="md_readme.html"/>
112-
<a href="md_readme.html#autotoc_md96"/>
113113
<a href="md_readme.html#autotoc_md97"/>
114+
<a href="md_readme.html#autotoc_md98"/>
114115
<a href="md_references.html"/>
115116
<a href="md_running.html"/>
116-
<a href="md_running.html#autotoc_md100"/>
117117
<a href="md_running.html#autotoc_md101"/>
118118
<a href="md_running.html#autotoc_md102"/>
119119
<a href="md_running.html#autotoc_md103"/>
120120
<a href="md_running.html#autotoc_md104"/>
121121
<a href="md_running.html#autotoc_md105"/>
122122
<a href="md_running.html#autotoc_md106"/>
123+
<a href="md_running.html#autotoc_md107"/>
123124
<a href="md_testing.html"/>
124-
<a href="md_testing.html#autotoc_md108"/>
125125
<a href="md_testing.html#autotoc_md109"/>
126+
<a href="md_testing.html#autotoc_md110"/>
126127
<a href="md_visualization.html"/>
127-
<a href="md_visualization.html#autotoc_md111"/>
128128
<a href="md_visualization.html#autotoc_md112"/>
129129
<a href="md_visualization.html#autotoc_md113"/>
130130
<a href="md_visualization.html#autotoc_md114"/>
131131
<a href="md_visualization.html#autotoc_md115"/>
132132
<a href="md_visualization.html#autotoc_md116"/>
133+
<a href="md_visualization.html#autotoc_md117"/>
134+
<a href="md_visualization.html#autotoc_md118"/>
135+
<a href="md_visualization.html#autotoc_md119"/>
133136
<a href="pages.html"/>
134137
</body>
135138
</html>

documentation/md_case.html

+23-10
Original file line numberDiff line numberDiff line change
@@ -781,7 +781,7 @@ <h2><a class="anchor" id="autotoc_md19"></a>
781781
<tr class="markdownTableHead">
782782
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
783783
<tr class="markdownTableRowOdd">
784-
<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>
784+
<td class="markdownTableBodyRight"><code>perturb_flow</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Perturb the initial velocity field by random noise </td></tr>
785785
<tr class="markdownTableRowEven">
786786
<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>
787787
<tr class="markdownTableRowOdd">
@@ -802,7 +802,7 @@ <h2><a class="anchor" id="autotoc_md19"></a>
802802
<p>The table lists velocity field parameters. The parameters are optionally used to define initial velocity profiles and perturbations.</p>
803803
<ul>
804804
<li><code>perturb_flow</code> activates the perturbation of initial velocity by random noise.</li>
805-
<li><code>perturb_flow_fluid</code> specifies the fluid component whose flow is to be perturbed.</li>
805+
<li><code>perturb_flow_fluid</code> specifies the fluid component whose flow will be perturbed.</li>
806806
<li><code>perturb_flow</code> activates the perturbation of initial velocity by random noise.</li>
807807
<li><code>perturb_sph</code> activates the perturbation of initial partial density by random noise.</li>
808808
<li><code>perturb_sph_fluid</code> specifies the fluid component whose partial density is to be perturbed.</li>
@@ -843,7 +843,7 @@ <h2><a class="anchor" id="autotoc_md21"></a>
843843
<td class="markdownTableBodyRight"><code>pi_fac</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Ratio of artificial and true <code>pi_\infty</code> values </td></tr>
844844
</table>
845845
<ul>
846-
<li><code>pi_fac</code> specifies the ratio of artificial and true <code>pi_\infty</code> values (<code>=</code> artificial <code>pi_\infty</code> / true <code>pi_\infty</code>). This parameter enables the use of true <code>pi_\infty</code> in bubble dynamics models, when the <code>pi_\infty</code> given in the <code>case.py</code> file is an artificial value.</li>
846+
<li><code>pi_fac</code> specifies the ratio of artificial and true <code>pi_\infty</code> values (<code>=</code> artificial <code>pi_\infty</code> / true <code>pi_\infty</code>). This parameter enables the use of true <code>pi_\infty</code> in bubble dynamics models when the <code>pi_\infty</code> given in the <code>case.py</code> file is an artificial value.</li>
847847
</ul>
848848
<h2><a class="anchor" id="autotoc_md22"></a>
849849
13. Body Forces</h2>
@@ -863,10 +863,23 @@ <h2><a class="anchor" id="autotoc_md22"></a>
863863
</table>
864864
<p><code>k_x[y,z]</code>, <code>w_x[y,z]</code>, <code>p_x[y,z]</code>, and <code>g_x[y,z]</code> define an oscillating acceleration in the <code>x[y,z]</code> direction with the form</p>
865865
<p>$$ a_{x[y,z]} = g_{x[y,z]} + k_{x[y,z]}\sin\left(w_{x[y,z]}t + p_{x[y,z]}\right). $$</p>
866-
<p>Positive accelerations are in the <code>x[y,z]</code> direction are in the positive <code>x[y,z]</code> direction by convention.</p>
867-
<h1><a class="anchor" id="autotoc_md23"></a>
866+
<p>By convention, positive accelerations in the <code>x[y,z]</code> direction are in the positive <code>x[y,z]</code> direction.</p>
867+
<h2><a class="anchor" id="autotoc_md23"></a>
868+
14. Cylindrical Coordinates</h2>
869+
<p>When <code>cyl_coord = 'T'</code> is set in 3D the following constraints must be met:</p>
870+
<ul>
871+
<li><code>bc_ybeg = -14</code> enables the axis boundary condition</li>
872+
<li><code>bc_zbeg = bc_zend = -1</code> enables periodic boundary conditions in the azimuthal direction</li>
873+
<li><code>z_domainbeg = 0</code> sets the azimuthal starting point to 0</li>
874+
<li><code>z_comainend = 2*math.pi</code> to set the azimuthal ending point to $2\pi$ (note, requires <code>import math</code> in the case file)</li>
875+
</ul>
876+
<p>When <code>cyl_coord = 'T'</code> is set in 2D the following constraints must be met:</p>
877+
<ul>
878+
<li><code>bc_ybeg = -2</code> to enable reflective boundary conditions</li>
879+
</ul>
880+
<h1><a class="anchor" id="autotoc_md24"></a>
868881
Enumerations</h1>
869-
<h2><a class="anchor" id="autotoc_md24"></a>
882+
<h2><a class="anchor" id="autotoc_md25"></a>
870883
Boundary conditions</h2>
871884
<table class="markdownTable">
872885
<tr class="markdownTableHead">
@@ -904,7 +917,7 @@ <h2><a class="anchor" id="autotoc_md24"></a>
904917
</table>
905918
<p>*: This boundary condition is only used for <code>bc_y%beg</code> when using cylindrical coordinates (<code>cyl_coord = 'T'</code> and 3D). For axisymmetric problems, use <code>bc_y%beg = -2</code> with <code>cyl_coord = 'T'</code> in 2D.</p>
906919
<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>
907-
<h2><a class="anchor" id="autotoc_md25"></a>
920+
<h2><a class="anchor" id="autotoc_md26"></a>
908921
Patch types</h2>
909922
<table class="markdownTable">
910923
<tr class="markdownTableHead">
@@ -953,7 +966,7 @@ <h2><a class="anchor" id="autotoc_md25"></a>
953966
<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>model%filepath</code>. </td></tr>
954967
</table>
955968
<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>
956-
<h2><a class="anchor" id="autotoc_md26"></a>
969+
<h2><a class="anchor" id="autotoc_md27"></a>
957970
Immersed Boundary Patch Types</h2>
958971
<table class="markdownTable">
959972
<tr class="markdownTableHead">
@@ -1015,7 +1028,7 @@ <h2><a class="anchor" id="acoustic-supports"></a>
10151028
<li><code>%support = 10</code> specifies an annular transducer array in 2D axisymmetric simulation. It is identical to <code>%support = 9</code> in terms of simulation parameters. It physically represents the a annulus obtained by revolving the arc in <code>%support = 9</code> around the x-axis.</li>
10161029
<li><code>%support = 11</code> specifies a circular transducer array in 3D simulation. The total aperture of the array is <code>%aperture</code>, which is similar to <code>%support = 7</code>. The parameters <code>%num_elements</code>, <code>%element_polygon_ratio</code>, and <code>%rotate_angle</code> specify the number of transducer elements, the ratio of the polygon side length to the transducer element radius, and the rotation angle of the array. The polygon side length is calculated by using the total aperture as the circumcicle diameter, and the number of sides of the polygon as <code>%num_elements</code>. The ratio is used specify the aperture size of each transducer element in the array, as a ratio of the total aperture. The rotation angle is optional and defaults to 0. Physically it represents a circular ring of transducer elements.</li>
10171030
</ul>
1018-
<h2><a class="anchor" id="autotoc_md27"></a>
1031+
<h2><a class="anchor" id="autotoc_md28"></a>
10191032
Conservative Variables Ordering</h2>
10201033
<table class="markdownTable">
10211034
<tr class="markdownTableHead">
@@ -1041,7 +1054,7 @@ <h2><a class="anchor" id="autotoc_md27"></a>
10411054
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
10421055
</table>
10431056
<p>The above variables correspond to optional physics.</p>
1044-
<h2><a class="anchor" id="autotoc_md28"></a>
1057+
<h2><a class="anchor" id="autotoc_md29"></a>
10451058
Primitive Variables Ordering</h2>
10461059
<table class="markdownTable">
10471060
<tr class="markdownTableHead">

0 commit comments

Comments
 (0)