Skip to content

Commit 97df843

Browse files
author
MFC Action
committed
Docs @ a8df793
1 parent 465103b commit 97df843

File tree

137 files changed

+6615
-5155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

137 files changed

+6615
-5155
lines changed

documentation/doxygen_crawl.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@
3737
<a href="md_case.html#autotoc_md28"/>
3838
<a href="md_case.html#autotoc_md29"/>
3939
<a href="md_case.html#autotoc_md3"/>
40+
<a href="md_case.html#autotoc_md30"/>
4041
<a href="md_case.html#autotoc_md4"/>
4142
<a href="md_case.html#autotoc_md5"/>
4243
<a href="md_case.html#autotoc_md6"/>
4344
<a href="md_case.html#autotoc_md7"/>
4445
<a href="md_case.html#autotoc_md8"/>
4546
<a href="md_case.html#autotoc_md9"/>
4647
<a href="md_examples.html"/>
47-
<a href="md_examples.html#autotoc_md31"/>
4848
<a href="md_examples.html#autotoc_md32"/>
4949
<a href="md_examples.html#autotoc_md33"/>
5050
<a href="md_examples.html#autotoc_md34"/>
@@ -91,8 +91,8 @@
9191
<a href="md_examples.html#autotoc_md75"/>
9292
<a href="md_examples.html#autotoc_md76"/>
9393
<a href="md_examples.html#autotoc_md77"/>
94+
<a href="md_examples.html#autotoc_md78"/>
9495
<a href="md_expectedPerformance.html"/>
95-
<a href="md_expectedPerformance.html#autotoc_md79"/>
9696
<a href="md_expectedPerformance.html#autotoc_md80"/>
9797
<a href="md_expectedPerformance.html#autotoc_md81"/>
9898
<a href="md_expectedPerformance.html#autotoc_md82"/>
@@ -102,37 +102,38 @@
102102
<a href="md_expectedPerformance.html#autotoc_md86"/>
103103
<a href="md_expectedPerformance.html#autotoc_md87"/>
104104
<a href="md_expectedPerformance.html#autotoc_md88"/>
105+
<a href="md_expectedPerformance.html#autotoc_md89"/>
105106
<a href="md_getting-started.html"/>
106-
<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"/>
110110
<a href="md_getting-started.html#autotoc_md94"/>
111+
<a href="md_getting-started.html#autotoc_md95"/>
111112
<a href="md_papers.html"/>
112113
<a href="md_readme.html"/>
113-
<a href="md_readme.html#autotoc_md97"/>
114114
<a href="md_readme.html#autotoc_md98"/>
115+
<a href="md_readme.html#autotoc_md99"/>
115116
<a href="md_references.html"/>
116117
<a href="md_running.html"/>
117-
<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"/>
123123
<a href="md_running.html#autotoc_md107"/>
124+
<a href="md_running.html#autotoc_md108"/>
124125
<a href="md_testing.html"/>
125-
<a href="md_testing.html#autotoc_md109"/>
126126
<a href="md_testing.html#autotoc_md110"/>
127+
<a href="md_testing.html#autotoc_md111"/>
127128
<a href="md_visualization.html"/>
128-
<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"/>
133133
<a href="md_visualization.html#autotoc_md117"/>
134134
<a href="md_visualization.html#autotoc_md118"/>
135135
<a href="md_visualization.html#autotoc_md119"/>
136+
<a href="md_visualization.html#autotoc_md120"/>
136137
<a href="pages.html"/>
137138
</body>
138139
</html>

documentation/md_case.html

Lines changed: 28 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -935,6 +935,31 @@ <h2><a class="anchor" id="autotoc_md25"></a>
935935
<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>
936936
<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>
937937
<h2><a class="anchor" id="autotoc_md26"></a>
938+
Generalized Characteristic Boundary conditions</h2>
939+
<table class="markdownTable">
940+
<tr class="markdownTableHead">
941+
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
942+
<tr class="markdownTableRowOdd">
943+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]grcbc_in</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable grcbc for subsonic inflow </td></tr>
944+
<tr class="markdownTableRowEven">
945+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]grcbc_out</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable grcbc for subsonic outflow (pressure) </td></tr>
946+
<tr class="markdownTableRowOdd">
947+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]grcbc_vel_out</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable grcbc for subsonic outflow (pressure + normal velocity) </td></tr>
948+
<tr class="markdownTableRowEven">
949+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]vel_in</code> </td><td class="markdownTableBodyCenter">Real Array </td><td class="markdownTableBodyLeft">Inflow velocities in x, y and z directions </td></tr>
950+
<tr class="markdownTableRowOdd">
951+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]vel_out</code> </td><td class="markdownTableBodyCenter">Real Array </td><td class="markdownTableBodyLeft">Outflow velocities in x, y and z directions </td></tr>
952+
<tr class="markdownTableRowEven">
953+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]pres_in</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Inflow pressure </td></tr>
954+
<tr class="markdownTableRowOdd">
955+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]pres_out</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Outflow pressure </td></tr>
956+
<tr class="markdownTableRowEven">
957+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]alpha_rho_in</code> </td><td class="markdownTableBodyCenter">Real Array </td><td class="markdownTableBodyLeft">Inflow density </td></tr>
958+
<tr class="markdownTableRowOdd">
959+
<td class="markdownTableBodyRight"><code>bc_[x,y,z]alpha_in</code> </td><td class="markdownTableBodyCenter">Real Array </td><td class="markdownTableBodyLeft">Inflow void fraction </td></tr>
960+
</table>
961+
<p>This boundary condition can be used for subsonic inflow (<code>bc_[x,y,z]%[beg,end]</code> = -7) and subsonic outflow (<code>bc_[x,y,z]%[beg,end]</code> = -8) characteristic boundary conditions. These are based on <a href="references.md#Pirozzoli13">Pirozzoli (2013)</a>. This enables to provide inflow and outflow conditions outside the computational domain.</p>
962+
<h2><a class="anchor" id="autotoc_md27"></a>
938963
Patch types</h2>
939964
<table class="markdownTable">
940965
<tr class="markdownTableHead">
@@ -983,7 +1008,7 @@ <h2><a class="anchor" id="autotoc_md26"></a>
9831008
<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>
9841009
</table>
9851010
<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>
986-
<h2><a class="anchor" id="autotoc_md27"></a>
1011+
<h2><a class="anchor" id="autotoc_md28"></a>
9871012
Immersed Boundary Patch Types</h2>
9881013
<table class="markdownTable">
9891014
<tr class="markdownTableHead">
@@ -1045,7 +1070,7 @@ <h2><a class="anchor" id="acoustic-supports"></a>
10451070
<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>
10461071
<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>
10471072
</ul>
1048-
<h2><a class="anchor" id="autotoc_md28"></a>
1073+
<h2><a class="anchor" id="autotoc_md29"></a>
10491074
Conservative Variables Ordering</h2>
10501075
<table class="markdownTable">
10511076
<tr class="markdownTableHead">
@@ -1071,7 +1096,7 @@ <h2><a class="anchor" id="autotoc_md28"></a>
10711096
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
10721097
</table>
10731098
<p>The above variables correspond to optional physics.</p>
1074-
<h2><a class="anchor" id="autotoc_md29"></a>
1099+
<h2><a class="anchor" id="autotoc_md30"></a>
10751100
Primitive Variables Ordering</h2>
10761101
<table class="markdownTable">
10771102
<tr class="markdownTableHead">

0 commit comments

Comments
 (0)