Skip to content

Commit 2f2ff34

Browse files
author
MFC Action
committed
Docs @ 4298db0
1 parent 61408ec commit 2f2ff34

File tree

804 files changed

+58361
-36608
lines changed

Some content is hidden

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

804 files changed

+58361
-36608
lines changed

documentation/doxygen_crawl.html

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,14 @@
4141
<a href="md_case.html#autotoc_md31"/>
4242
<a href="md_case.html#autotoc_md32"/>
4343
<a href="md_case.html#autotoc_md33"/>
44+
<a href="md_case.html#autotoc_md34"/>
4445
<a href="md_case.html#autotoc_md4"/>
4546
<a href="md_case.html#autotoc_md5"/>
4647
<a href="md_case.html#autotoc_md6"/>
4748
<a href="md_case.html#autotoc_md7"/>
4849
<a href="md_case.html#autotoc_md8"/>
4950
<a href="md_case.html#autotoc_md9"/>
5051
<a href="md_examples.html"/>
51-
<a href="md_examples.html#autotoc_md35"/>
5252
<a href="md_examples.html#autotoc_md36"/>
5353
<a href="md_examples.html#autotoc_md37"/>
5454
<a href="md_examples.html#autotoc_md38"/>
@@ -93,8 +93,8 @@
9393
<a href="md_examples.html#autotoc_md77"/>
9494
<a href="md_examples.html#autotoc_md78"/>
9595
<a href="md_examples.html#autotoc_md79"/>
96+
<a href="md_examples.html#autotoc_md80"/>
9697
<a href="md_expectedPerformance.html"/>
97-
<a href="md_expectedPerformance.html#autotoc_md81"/>
9898
<a href="md_expectedPerformance.html#autotoc_md82"/>
9999
<a href="md_expectedPerformance.html#autotoc_md83"/>
100100
<a href="md_expectedPerformance.html#autotoc_md84"/>
@@ -104,37 +104,38 @@
104104
<a href="md_expectedPerformance.html#autotoc_md88"/>
105105
<a href="md_expectedPerformance.html#autotoc_md89"/>
106106
<a href="md_expectedPerformance.html#autotoc_md90"/>
107+
<a href="md_expectedPerformance.html#autotoc_md91"/>
107108
<a href="md_getting-started.html"/>
108-
<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"/>
111111
<a href="md_getting-started.html#autotoc_md95"/>
112112
<a href="md_getting-started.html#autotoc_md96"/>
113+
<a href="md_getting-started.html#autotoc_md97"/>
113114
<a href="md_papers.html"/>
114115
<a href="md_readme.html"/>
115116
<a href="md_readme.html#autotoc_md100"/>
116-
<a href="md_readme.html#autotoc_md99"/>
117+
<a href="md_readme.html#autotoc_md101"/>
117118
<a href="md_references.html"/>
118119
<a href="md_running.html"/>
119-
<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"/>
124124
<a href="md_running.html#autotoc_md108"/>
125125
<a href="md_running.html#autotoc_md109"/>
126+
<a href="md_running.html#autotoc_md110"/>
126127
<a href="md_testing.html"/>
127-
<a href="md_testing.html#autotoc_md111"/>
128128
<a href="md_testing.html#autotoc_md112"/>
129+
<a href="md_testing.html#autotoc_md113"/>
129130
<a href="md_visualization.html"/>
130-
<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"/>
136136
<a href="md_visualization.html#autotoc_md120"/>
137137
<a href="md_visualization.html#autotoc_md121"/>
138+
<a href="md_visualization.html#autotoc_md122"/>
138139
<a href="pages.html"/>
139140
</body>
140141
</html>

documentation/md_case.html

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,7 @@ <h2><a class="anchor" id="autotoc_md15"></a>
486486
<tr class="markdownTableRowOdd">
487487
<td class="markdownTableBodyRight"><code>mp_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO </td></tr>
488488
<tr class="markdownTableRowEven">
489-
<td class="markdownTableBodyRight"><code>riemann_solver</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact* </td></tr>
489+
<td class="markdownTableBodyRight"><code>riemann_solver</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Riemann solver algorithm: [1] HLL*; [2] HLLC; [3] Exact*; [4] HLLD (only for MHD) </td></tr>
490490
<tr class="markdownTableRowOdd">
491491
<td class="markdownTableBodyRight"><code>low_Mach</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Low Mach number correction for HLLC Riemann solver: [0] None; [1] Pressure (Chen et al. 2022); [2] Velocity (Thornber et al. 2008) </td></tr>
492492
<tr class="markdownTableRowEven">
@@ -550,7 +550,7 @@ <h2><a class="anchor" id="autotoc_md15"></a>
550550
<li><code>teno_CT</code> specifies the threshold for the TENO scheme. This dimensionless constant, also known as $C_T$, sets a threshold to identify smooth and non-smooth stencils. Larger values make the scheme more robust but also more dissipative. A recommended value for teno_CT is <code>1e-6</code>. When adjusting this parameter, it is recommended to try values like <code>1e-5</code> or <code>1e-7</code> for TENO5. A smaller value can be used for TENO7.</li>
551551
<li><code>null_weights</code> activates nullification of the nonlinear WENO weights at the buffer regions outside the domain boundaries when the Riemann extrapolation boundary condition is specified (<code>bc_[x,y,z]%beg[end]} = -4</code>).</li>
552552
<li><code>mp_weno</code> activates monotonicity preservation in the WENO reconstruction (MPWENO) such that the values of reconstructed variables do not reside outside the range spanned by WENO stencil (<a href="references.md#Balsara00">Balsara and Shu, 2000</a>; <a href="references.md#Suresh97">Suresh and Huynh, 1997</a>).</li>
553-
<li><code>riemann_solver</code> specifies the choice of the Riemann solver that is used in simulation by an integer from 1 through 3. <code>riemann_solver = 1</code>, <code>2</code>, and <code>3</code> correspond to HLL, HLLC, and Exact Riemann solver, respectively (<a href="references.md#Toro13">Toro, 2013</a>).</li>
553+
<li><code>riemann_solver</code> specifies the choice of the Riemann solver that is used in simulation by an integer from 1 through 3. <code>riemann_solver = 1</code>, <code>2</code>, and <code>3</code> correspond to HLL, HLLC, and Exact Riemann solver, respectively (<a href="references.md#Toro13">Toro, 2013</a>). <code>riemann_solver = 4</code> is only for MHD simulations. It resolves 5 of the full seven-wave structure of the MHD equations (<a href="references.md#Miyoshi05">Miyoshi and Kusano, 2005</a>).</li>
554554
<li><code>low_Mach</code> specifies the choice of the low Mach number correction scheme for the HLLC Riemann solver. <code>low_Mach = 0</code> is default value and does not apply any correction scheme. <code>low_Mach = 1</code> and <code>2</code> apply the anti-dissipation pressure correction method (<a href="references.md#Chen22">Chen et al., 2022</a>) and the improved velocity reconstruction method (<a href="references.md#Thornber08">Thornber et al., 2008</a>). This feature requires <code>riemann_solver = 2</code> and <code>model_eqns = 2</code>.</li>
555555
<li><code>avg_state</code> specifies the choice of the method to compute averaged variables at the cell-boundaries from the left and the right states in the Riemann solver by an integer of 1 or 2. <code>avg_state = 1</code> and <code>2</code> correspond to Roe- and arithmetic averages, respectively.</li>
556556
<li><code>wave_speeds</code> specifies the choice of the method to compute the left, right, and middle wave speeds in the Riemann solver by an integer of 1 and 2. <code>wave_speeds = 1</code> and <code>2</code> correspond to the direct method (<a href="references.md#Batten97">Batten et al., 1997</a>), and indirect method that approximates the pressures and velocity (<a href="references.md#Toro13">Toro, 2013</a>), respectively.</li>
@@ -980,7 +980,35 @@ <h2><a class="anchor" id="autotoc_md25"></a>
980980
<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>
981981
<p>By convention, positive accelerations in the <code>x[y,z]</code> direction are in the positive <code>x[y,z]</code> direction.</p>
982982
<h2><a class="anchor" id="autotoc_md26"></a>
983-
14. Cylindrical Coordinates</h2>
983+
14. Magnetohydrodynamics (MHD)</h2>
984+
<table class="markdownTable">
985+
<tr class="markdownTableHead">
986+
<th class="markdownTableHeadRight">Parameter </th><th class="markdownTableHeadCenter">Type </th><th class="markdownTableHeadLeft">Description </th></tr>
987+
<tr class="markdownTableRowOdd">
988+
<td class="markdownTableBodyRight"><code>mhd</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable ideal MHD simulation </td></tr>
989+
<tr class="markdownTableRowEven">
990+
<td class="markdownTableBodyRight"><code>relativity</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable relativistic MHD simulation </td></tr>
991+
<tr class="markdownTableRowOdd">
992+
<td class="markdownTableBodyRight"><code>powell</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Enable Powell's method for solenoidal constraint </td></tr>
993+
<tr class="markdownTableRowEven">
994+
<td class="markdownTableBodyRight"><code>fd_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Finite difference order for Powell's method </td></tr>
995+
<tr class="markdownTableRowOdd">
996+
<td class="markdownTableBodyRight"><code>Bx[y,z]</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Initial magnetic field in the x[y,z] direction </td></tr>
997+
<tr class="markdownTableRowEven">
998+
<td class="markdownTableBodyRight"><code>Bx0</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Constant magnetic field in the x direction (1D only) </td></tr>
999+
</table>
1000+
<ul>
1001+
<li><code>mhd</code> is currently only available for single-component flows and 5-equation model. Its compatibility with most other features is work in progress.</li>
1002+
<li><code>relativity</code> only works for <code>mhd</code> enabled and activates relativistic MHD (RMHD) simulation.</li>
1003+
<li><code>powell</code> activates Powell's eight-wave method to impose the solenoidal constraint in the MHD simulation <a href="references.md#Powell94">Powell (1994)</a>. It should not be used in conjunction with HLLD (<code>riemann_solver = 4</code>).</li>
1004+
<li><code>fd_order</code> specifies the finite difference order for computing the RHS of the Powell's method. <code>fd_order = 1</code>, <code>2</code>, and <code>4</code> are allowed.</li>
1005+
<li><code>Bx0</code> is only used in 1D simulations to specify the constant magnetic field in the x direction. It must be specified in 1D simulations. <code>Bx</code> must not be used in 1D simulations.</li>
1006+
<li><code>Bx</code>, <code>By</code>, and <code>Bz</code> are used to specify the initial magnetic field in the x, y, and z directions, respectively. They must be specified in all 1D/2D/3D MHD simulations, with the exception of <code>Bx</code> in 1D simulations.</li>
1007+
</ul>
1008+
<p>Note: In 1D/2D/3D simulations, all three velocity components are treated as state variables and must be specified in the case file.</p>
1009+
<p>Note: For relativistic flow, the conservative and primitive densities are different. <code>rho_wrt</code> outputs the primitive (rest mass) density.</p>
1010+
<h2><a class="anchor" id="autotoc_md27"></a>
1011+
15. Cylindrical Coordinates</h2>
9841012
<p>When <code>cyl_coord = 'T'</code> is set in 3D the following constraints must be met:</p>
9851013
<ul>
9861014
<li><code>bc_ybeg = -14</code> enables the axis boundary condition</li>
@@ -992,9 +1020,9 @@ <h2><a class="anchor" id="autotoc_md26"></a>
9921020
<ul>
9931021
<li><code>bc_ybeg = -2</code> to enable reflective boundary conditions</li>
9941022
</ul>
995-
<h1><a class="anchor" id="autotoc_md27"></a>
1023+
<h1><a class="anchor" id="autotoc_md28"></a>
9961024
Enumerations</h1>
997-
<h2><a class="anchor" id="autotoc_md28"></a>
1025+
<h2><a class="anchor" id="autotoc_md29"></a>
9981026
Boundary conditions</h2>
9991027
<table class="markdownTable">
10001028
<tr class="markdownTableHead">
@@ -1032,7 +1060,7 @@ <h2><a class="anchor" id="autotoc_md28"></a>
10321060
</table>
10331061
<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>
10341062
<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>
1035-
<h2><a class="anchor" id="autotoc_md29"></a>
1063+
<h2><a class="anchor" id="autotoc_md30"></a>
10361064
Generalized Characteristic Boundary conditions</h2>
10371065
<table class="markdownTable">
10381066
<tr class="markdownTableHead">
@@ -1057,7 +1085,7 @@ <h2><a class="anchor" id="autotoc_md29"></a>
10571085
<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>
10581086
</table>
10591087
<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>
1060-
<h2><a class="anchor" id="autotoc_md30"></a>
1088+
<h2><a class="anchor" id="autotoc_md31"></a>
10611089
Patch types</h2>
10621090
<table class="markdownTable">
10631091
<tr class="markdownTableHead">
@@ -1106,7 +1134,7 @@ <h2><a class="anchor" id="autotoc_md30"></a>
11061134
<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>
11071135
</table>
11081136
<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>
1109-
<h2><a class="anchor" id="autotoc_md31"></a>
1137+
<h2><a class="anchor" id="autotoc_md32"></a>
11101138
Immersed Boundary Patch Types</h2>
11111139
<table class="markdownTable">
11121140
<tr class="markdownTableHead">
@@ -1168,7 +1196,7 @@ <h2><a class="anchor" id="acoustic-supports"></a>
11681196
<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>
11691197
<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>
11701198
</ul>
1171-
<h2><a class="anchor" id="autotoc_md32"></a>
1199+
<h2><a class="anchor" id="autotoc_md33"></a>
11721200
Conservative Variables Ordering</h2>
11731201
<table class="markdownTable">
11741202
<tr class="markdownTableHead">
@@ -1194,7 +1222,7 @@ <h2><a class="anchor" id="autotoc_md32"></a>
11941222
<td class="markdownTableBodyNone">hypoelastic variables </td><td class="markdownTableBodyNone">N/A </td></tr>
11951223
</table>
11961224
<p>The above variables correspond to optional physics.</p>
1197-
<h2><a class="anchor" id="autotoc_md33"></a>
1225+
<h2><a class="anchor" id="autotoc_md34"></a>
11981226
Primitive Variables Ordering</h2>
11991227
<table class="markdownTable">
12001228
<tr class="markdownTableHead">

0 commit comments

Comments
 (0)