Skip to content

Commit 735148b

Browse files
author
MFC Action
committed
Docs @ daa8e85
1 parent 3b56d78 commit 735148b

File tree

131 files changed

+14809
-11486
lines changed

Some content is hidden

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

131 files changed

+14809
-11486
lines changed

‎documentation/doxygen_crawl.html‎

Lines changed: 37 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@
2222
<a href="doxygen_crawl.html"/>
2323
<a href="pages.html"/>
2424
<a href="index.html"/>
25-
<a href="index.html#autotoc_md72"/>
26-
<a href="index.html#autotoc_md73"/>
25+
<a href="index.html#autotoc_md79"/>
26+
<a href="index.html#autotoc_md80"/>
2727
<a href="md_authors.html"/>
2828
<a href="md_case.html"/>
2929
<a href="md_case.html#autotoc_md10"/>
@@ -45,6 +45,7 @@
4545
<a href="md_case.html#autotoc_md25"/>
4646
<a href="md_case.html#autotoc_md26"/>
4747
<a href="md_case.html#autotoc_md27"/>
48+
<a href="md_case.html#autotoc_md28"/>
4849
<a href="md_case.html#autotoc_md3"/>
4950
<a href="md_case.html#autotoc_md4"/>
5051
<a href="md_case.html#autotoc_md5"/>
@@ -53,7 +54,6 @@
5354
<a href="md_case.html#autotoc_md8"/>
5455
<a href="md_case.html#autotoc_md9"/>
5556
<a href="md_examples.html"/>
56-
<a href="md_examples.html#autotoc_md29"/>
5757
<a href="md_examples.html#autotoc_md30"/>
5858
<a href="md_examples.html#autotoc_md31"/>
5959
<a href="md_examples.html#autotoc_md32"/>
@@ -78,41 +78,48 @@
7878
<a href="md_examples.html#autotoc_md51"/>
7979
<a href="md_examples.html#autotoc_md52"/>
8080
<a href="md_examples.html#autotoc_md53"/>
81+
<a href="md_examples.html#autotoc_md54"/>
82+
<a href="md_examples.html#autotoc_md55"/>
83+
<a href="md_examples.html#autotoc_md56"/>
84+
<a href="md_examples.html#autotoc_md57"/>
85+
<a href="md_examples.html#autotoc_md58"/>
86+
<a href="md_examples.html#autotoc_md59"/>
87+
<a href="md_examples.html#autotoc_md60"/>
8188
<a href="md_expectedPerformance.html"/>
82-
<a href="md_expectedPerformance.html#autotoc_md55"/>
83-
<a href="md_expectedPerformance.html#autotoc_md56"/>
84-
<a href="md_expectedPerformance.html#autotoc_md57"/>
85-
<a href="md_expectedPerformance.html#autotoc_md58"/>
86-
<a href="md_expectedPerformance.html#autotoc_md59"/>
87-
<a href="md_expectedPerformance.html#autotoc_md60"/>
88-
<a href="md_expectedPerformance.html#autotoc_md61"/>
8989
<a href="md_expectedPerformance.html#autotoc_md62"/>
9090
<a href="md_expectedPerformance.html#autotoc_md63"/>
9191
<a href="md_expectedPerformance.html#autotoc_md64"/>
92+
<a href="md_expectedPerformance.html#autotoc_md65"/>
93+
<a href="md_expectedPerformance.html#autotoc_md66"/>
94+
<a href="md_expectedPerformance.html#autotoc_md67"/>
95+
<a href="md_expectedPerformance.html#autotoc_md68"/>
96+
<a href="md_expectedPerformance.html#autotoc_md69"/>
97+
<a href="md_expectedPerformance.html#autotoc_md70"/>
98+
<a href="md_expectedPerformance.html#autotoc_md71"/>
9299
<a href="md_getting-started.html"/>
93-
<a href="md_getting-started.html#autotoc_md66"/>
94-
<a href="md_getting-started.html#autotoc_md67"/>
95-
<a href="md_getting-started.html#autotoc_md68"/>
96-
<a href="md_getting-started.html#autotoc_md69"/>
97-
<a href="md_getting-started.html#autotoc_md70"/>
100+
<a href="md_getting-started.html#autotoc_md73"/>
101+
<a href="md_getting-started.html#autotoc_md74"/>
102+
<a href="md_getting-started.html#autotoc_md75"/>
103+
<a href="md_getting-started.html#autotoc_md76"/>
104+
<a href="md_getting-started.html#autotoc_md77"/>
98105
<a href="md_references.html"/>
99106
<a href="md_running.html"/>
100-
<a href="md_running.html#autotoc_md76"/>
101-
<a href="md_running.html#autotoc_md77"/>
102-
<a href="md_running.html#autotoc_md78"/>
103-
<a href="md_running.html#autotoc_md79"/>
104-
<a href="md_running.html#autotoc_md80"/>
105-
<a href="md_running.html#autotoc_md81"/>
106-
<a href="md_running.html#autotoc_md82"/>
107+
<a href="md_running.html#autotoc_md83"/>
108+
<a href="md_running.html#autotoc_md84"/>
109+
<a href="md_running.html#autotoc_md85"/>
110+
<a href="md_running.html#autotoc_md86"/>
111+
<a href="md_running.html#autotoc_md87"/>
112+
<a href="md_running.html#autotoc_md88"/>
113+
<a href="md_running.html#autotoc_md89"/>
107114
<a href="md_testing.html"/>
108-
<a href="md_testing.html#autotoc_md84"/>
109-
<a href="md_testing.html#autotoc_md85"/>
115+
<a href="md_testing.html#autotoc_md91"/>
116+
<a href="md_testing.html#autotoc_md92"/>
110117
<a href="md_visualization.html"/>
111-
<a href="md_visualization.html#autotoc_md87"/>
112-
<a href="md_visualization.html#autotoc_md88"/>
113-
<a href="md_visualization.html#autotoc_md89"/>
114-
<a href="md_visualization.html#autotoc_md90"/>
115-
<a href="md_visualization.html#autotoc_md91"/>
116-
<a href="md_visualization.html#autotoc_md92"/>
118+
<a href="md_visualization.html#autotoc_md94"/>
119+
<a href="md_visualization.html#autotoc_md95"/>
120+
<a href="md_visualization.html#autotoc_md96"/>
121+
<a href="md_visualization.html#autotoc_md97"/>
122+
<a href="md_visualization.html#autotoc_md98"/>
123+
<a href="md_visualization.html#autotoc_md99"/>
117124
</body>
118125
</html>

‎documentation/final_condition-2D_rayleigh_taylor-example.png‎

166 KB
Loading

‎documentation/final_condition-3D_rayleigh_taylor-example.png‎

230 KB
Loading

‎documentation/index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@
135135
</div><!--header-->
136136
<div class="contents">
137137
<div class="textblock"><p><a class="anchor" id="md_readme"></a> </p>
138-
<h1><a class="anchor" id="autotoc_md72"></a>
138+
<h1><a class="anchor" id="autotoc_md79"></a>
139139
User Documentation</h1>
140140
<ul>
141141
<li><a class="el" href="md_getting-started.html">Getting Started</a></li>
@@ -148,7 +148,7 @@ <h1><a class="anchor" id="autotoc_md72"></a>
148148
<li><a class="el" href="md_authors.html">MFC's Authors</a></li>
149149
<li><a class="el" href="md_references.html">References</a></li>
150150
</ul>
151-
<h1><a class="anchor" id="autotoc_md73"></a>
151+
<h1><a class="anchor" id="autotoc_md80"></a>
152152
Code/API Documentation</h1>
153153
<p>MFC's three codes have their own documentation:</p>
154154
<ul>

‎documentation/index.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
var index =
22
[
3-
[ "User Documentation", "index.html#autotoc_md72", null ],
4-
[ "Code/API Documentation", "index.html#autotoc_md73", null ]
3+
[ "User Documentation", "index.html#autotoc_md79", null ],
4+
[ "Code/API Documentation", "index.html#autotoc_md80", null ]
55
];

‎documentation/md_case.html‎

Lines changed: 27 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -748,11 +748,30 @@ <h2><a class="anchor" id="autotoc_md20"></a>
748748
<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>
749749
</table>
750750
<ul>
751-
<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>
751+
<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>). i 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>
752752
</ul>
753-
<h1><a class="anchor" id="autotoc_md21"></a>
753+
<h2><a class="anchor" id="autotoc_md21"></a>
754+
13. Body Forces</h2>
755+
<table class="markdownTable">
756+
<tr class="markdownTableHead">
757+
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
758+
<tr class="markdownTableRowOdd">
759+
<td class="markdownTableBodyRight"><code>bf_x[y,z]</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable body forces in the x[y,z] direction </td></tr>
760+
<tr class="markdownTableRowEven">
761+
<td class="markdownTableBodyRight"><code>k_x[y,y]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Magnitude of oscillating acceleration </td></tr>
762+
<tr class="markdownTableRowOdd">
763+
<td class="markdownTableBodyRight"><code>w_x[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Frequency of oscillating acceleration </td></tr>
764+
<tr class="markdownTableRowEven">
765+
<td class="markdownTableBodyRight"><code>p_x[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Phase shift of oscillating acceleration </td></tr>
766+
<tr class="markdownTableRowOdd">
767+
<td class="markdownTableBodyRight"><code>g_x[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Magnitude of bacground acceleration </td></tr>
768+
</table>
769+
<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>
770+
<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>
771+
<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>
772+
<h1><a class="anchor" id="autotoc_md22"></a>
754773
Enumerations</h1>
755-
<h2><a class="anchor" id="autotoc_md22"></a>
774+
<h2><a class="anchor" id="autotoc_md23"></a>
756775
Boundary conditions</h2>
757776
<table class="markdownTable">
758777
<tr class="markdownTableHead">
@@ -790,7 +809,7 @@ <h2><a class="anchor" id="autotoc_md22"></a>
790809
</table>
791810
<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>
792811
<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>
793-
<h2><a class="anchor" id="autotoc_md23"></a>
812+
<h2><a class="anchor" id="autotoc_md24"></a>
794813
Patch types</h2>
795814
<table class="markdownTable">
796815
<tr class="markdownTableHead">
@@ -839,7 +858,7 @@ <h2><a class="anchor" id="autotoc_md23"></a>
839858
<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>
840859
</table>
841860
<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>
842-
<h2><a class="anchor" id="autotoc_md24"></a>
861+
<h2><a class="anchor" id="autotoc_md25"></a>
843862
Immersed Boundary Patch Types</h2>
844863
<table class="markdownTable">
845864
<tr class="markdownTableHead">
@@ -857,7 +876,7 @@ <h2><a class="anchor" id="autotoc_md24"></a>
857876
<tr class="markdownTableRowEven">
858877
<td class="markdownTableBodyRight">11 </td><td class="markdownTableBodyCenter">3D Airfoil </td><td class="markdownTableBodyLeft">3 </td></tr>
859878
</table>
860-
<h2><a class="anchor" id="autotoc_md25"></a>
879+
<h2><a class="anchor" id="autotoc_md26"></a>
861880
Monopole supports</h2>
862881
<table class="markdownTable">
863882
<tr class="markdownTableHead">
@@ -876,7 +895,7 @@ <h2><a class="anchor" id="autotoc_md25"></a>
876895
<td class="markdownTableBodyNone">6 </td><td class="markdownTableBodyNone">Cyl_coord along axial-dir </td></tr>
877896
</table>
878897
<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>
879-
<h2><a class="anchor" id="autotoc_md26"></a>
898+
<h2><a class="anchor" id="autotoc_md27"></a>
880899
Conservative Variables Ordering</h2>
881900
<table class="markdownTable">
882901
<tr class="markdownTableHead">
@@ -902,7 +921,7 @@ <h2><a class="anchor" id="autotoc_md26"></a>
902921
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
903922
</table>
904923
<p>The above variables correspond to optional physics.</p>
905-
<h2><a class="anchor" id="autotoc_md27"></a>
924+
<h2><a class="anchor" id="autotoc_md28"></a>
906925
Primitive Variables Ordering</h2>
907926
<table class="markdownTable">
908927
<tr class="markdownTableHead">

0 commit comments

Comments
 (0)