Skip to content

Commit dc41994

Browse files
author
MFC Action
committed
Docs @ a1d1576
1 parent 12d7b35 commit dc41994

File tree

294 files changed

+16579
-12445
lines changed

Some content is hidden

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

294 files changed

+16579
-12445
lines changed

documentation/md_case.html

Lines changed: 26 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -483,27 +483,39 @@ <h2><a class="anchor" id="autotoc_md15"></a>
483483
<tr class="markdownTableRowEven">
484484
<td class="markdownTableBodyRight"><code>adap_dt</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Strang splitting scheme with adaptive time stepping </td></tr>
485485
<tr class="markdownTableRowOdd">
486-
<td class="markdownTableBodyRight"><code>adap_dt_tol</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Tolerance for adaptive time stepping in Strang splitting scheme </td></tr>
486+
<td class="markdownTableBodyRight"><code>recon_type</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Reconstruction Type: [1] WENO; [2] MUSCL </td></tr>
487487
<tr class="markdownTableRowEven">
488-
<td class="markdownTableBodyRight"><code>adap_dt_max_iters</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Max iteration for adaptive time stepping in Strang splitting scheme </td></tr>
488+
<td class="markdownTableBodyRight"><code>adap_dt_tol</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Tolerance for adaptive time stepping in Strang splitting scheme </td></tr>
489489
<tr class="markdownTableRowOdd">
490-
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
490+
<td class="markdownTableBodyRight"><code>adap_dt_max_iters</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">Max iteration for adaptive time stepping in Strang splitting scheme </td></tr>
491491
<tr class="markdownTableRowEven">
492-
<td class="markdownTableBodyRight"><code>weno_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero) </td></tr>
492+
<td class="markdownTableBodyRight"><code>weno_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">WENO order [1,3,5] </td></tr>
493493
<tr class="markdownTableRowOdd">
494-
<td class="markdownTableBodyRight"><code>mapped_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-M (WENO with mapping of nonlinear weights) </td></tr>
494+
<td class="markdownTableBodyRight"><code>weno_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO perturbation (avoid division by zero) </td></tr>
495495
<tr class="markdownTableRowEven">
496-
<td class="markdownTableBodyRight"><code>wenoz</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-Z </td></tr>
496+
<td class="markdownTableBodyRight"><code>mapped_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-M (WENO with mapping of nonlinear weights) </td></tr>
497497
<tr class="markdownTableRowOdd">
498-
<td class="markdownTableBodyRight"><code>wenoz_q</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO-Z power parameter q (only for WENO7) </td></tr>
498+
<td class="markdownTableBodyRight"><code>wenoz</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">WENO-Z </td></tr>
499499
<tr class="markdownTableRowEven">
500-
<td class="markdownTableBodyRight"><code>teno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">TENO (Targeted ENO) </td></tr>
500+
<td class="markdownTableBodyRight"><code>wenoz_q</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">WENO-Z power parameter q (only for WENO7) </td></tr>
501501
<tr class="markdownTableRowOdd">
502-
<td class="markdownTableBodyRight"><code>teno_CT</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">TENO threshold for smoothness detection </td></tr>
502+
<td class="markdownTableBodyRight"><code>teno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">TENO (Targeted ENO) </td></tr>
503503
<tr class="markdownTableRowEven">
504-
<td class="markdownTableBodyRight"><code>null_weights</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries </td></tr>
504+
<td class="markdownTableBodyRight"><code>teno_CT</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">TENO threshold for smoothness detection </td></tr>
505505
<tr class="markdownTableRowOdd">
506+
<td class="markdownTableBodyRight"><code>null_weights</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Null WENO weights at boundaries </td></tr>
507+
<tr class="markdownTableRowEven">
506508
<td class="markdownTableBodyRight"><code>mp_weno</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">Monotonicity preserving WENO </td></tr>
509+
<tr class="markdownTableRowOdd">
510+
<td class="markdownTableBodyRight"><code>muscl_order</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">MUSCL order [1,2] </td></tr>
511+
<tr class="markdownTableRowEven">
512+
<td class="markdownTableBodyRight"><code>muscl_lim</code> </td><td class="markdownTableBodyCenter">Integer </td><td class="markdownTableBodyLeft">MUSCL Slope Limiter: [1] minmod; [2] monotonized central; [3] Van Albada; [4] Van Leer; [5] SUPERBEE </td></tr>
513+
<tr class="markdownTableRowOdd">
514+
<td class="markdownTableBodyRight"><code>int_comp</code> </td><td class="markdownTableBodyCenter">Logical </td><td class="markdownTableBodyLeft">THINC Interface Compression </td></tr>
515+
<tr class="markdownTableRowEven">
516+
<td class="markdownTableBodyRight"><code>ic_eps</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Interface compression threshold (default: 1e-4) </td></tr>
517+
<tr class="markdownTableRowOdd">
518+
<td class="markdownTableBodyRight"><code>ic_beta</code> </td><td class="markdownTableBodyCenter">Real </td><td class="markdownTableBodyLeft">Interface compression sharpness parameter (default: 1.6) </td></tr>
507519
<tr class="markdownTableRowEven">
508520
<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>
509521
<tr class="markdownTableRowOdd">
@@ -585,7 +597,10 @@ <h2><a class="anchor" id="autotoc_md15"></a>
585597
<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>
586598
<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>
587599
<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 class="el" href="md_references.html">Balsara and Shu, 2000</a>; <a class="el" href="md_references.html">Suresh and Huynh, 1997</a>).</li>
588-
<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 class="el" href="md_references.html">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 class="el" href="md_references.html">Miyoshi and Kusano, 2005</a>).</li>
600+
<li><code>muscl_order</code> specifies the order of the MUSCL scheme that is used for spatial reconstruction of variables by an integer of 1, or 2, that corresponds to the 1st, and 2nd order respectively. When using <code>muscl_order = 2</code>, <code>muscl_lim</code> must be defined.</li>
601+
<li><code>muscl_lim</code> specifies the slope limiter that is used in 2nd order MUSCL Reconstruction by an integer from 1 through 5. <code>muscl_lim = 1</code>, <code>2</code>, <code>3</code>, <code>4</code>, and <code>5</code> correspond to minmod, monotonized central, Van Albada, Van Leer, and SUPERBEE, respectively.</li>
602+
<li><code>int_comp</code> activates interface compression using THINC used in MUSCL Reconstruction, with control parameters (<code>ic_eps</code>, and <code>ic_beta</code>).</li>
603+
<li><code>riemann_solver</code> specifies the choice of the Riemann solver that is used in simulation by an integer from 1 through 4. <code>riemann_solver = 1</code>, <code>2</code>, and <code>3</code> correspond to HLL, HLLC, and Exact Riemann solver, respectively (<a class="el" href="md_references.html">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 class="el" href="md_references.html">Miyoshi and Kusano, 2005</a>).</li>
589604
<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 class="el" href="md_references.html">Chen et al., 2022</a>) and the improved velocity reconstruction method (<a class="el" href="md_references.html">Thornber et al., 2008</a>). This feature requires <code>model_eqns = 2</code> or <code>3</code>. <code>low_Mach = 1</code> works for <code>riemann_solver = 1</code> and <code>2</code>, but <code>low_Mach = 2</code> only works for <code>riemann_solver = 2</code>.</li>
590605
<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>
591606
<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 class="el" href="md_references.html">Batten et al., 1997</a>), and indirect method that approximates the pressures and velocity (<a class="el" href="md_references.html">Toro, 2013</a>), respectively.</li>

post_process/doxygen_crawl.html

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,7 @@
158158
<a href="namespacem__checker__common.html#a4d7eb10d2a0d42d94c58cf93277143c0"/>
159159
<a href="namespacem__checker__common.html#a4f50e9fd68b983d11ffc37227992b540"/>
160160
<a href="namespacem__checker__common.html#a68304b96a2df65e461a7cfbca6b6bd01"/>
161+
<a href="namespacem__checker__common.html#a799f031bb6612816625d841ba4e19e00"/>
161162
<a href="namespacem__checker__common.html#a970fc65314cddafcf0102f416d66f4ce"/>
162163
<a href="namespacem__checker__common.html#a987a0208e0d67e49938e8f7d9185f90e"/>
163164
<a href="namespacem__checker__common.html#a9a28548179ff1dc35c035a76247ed51e"/>
@@ -184,10 +185,12 @@
184185
<a href="namespacem__constants.html#a0c7e3c78582e1105041a8f3d8aafc5ab"/>
185186
<a href="namespacem__constants.html#a1495dfa0d93a4fa455e4faf14fd4e900"/>
186187
<a href="namespacem__constants.html#a15280ea1aa249cfd827a039bbea68fbd"/>
188+
<a href="namespacem__constants.html#a1a4c5489d1ddd1f49783e865f966ed06"/>
187189
<a href="namespacem__constants.html#a1de9ebff81a0be652121ae336ffb8757"/>
188190
<a href="namespacem__constants.html#a1f52e85430eb7f1fba1d46370791e877"/>
189191
<a href="namespacem__constants.html#a2678965621459e6045edb254772ffdb5"/>
190192
<a href="namespacem__constants.html#a26fa1d5822a4ccfb4ac407028a0fcb50"/>
193+
<a href="namespacem__constants.html#a2a50ea8c440ba3a40ccea94f385bdcbe"/>
191194
<a href="namespacem__constants.html#a3183b80e6560ba958cded8f6e52c58f7"/>
192195
<a href="namespacem__constants.html#a347d9c638ece21f6f356c5ba91e6438e"/>
193196
<a href="namespacem__constants.html#a36d9e57f65f9235b1e7b4abb690345a6"/>
@@ -196,6 +199,7 @@
196199
<a href="namespacem__constants.html#a40dd8e42f1d768ce7c112ea571ba9a7d"/>
197200
<a href="namespacem__constants.html#a4313ade00be58e197e9c0f4a109eadac"/>
198201
<a href="namespacem__constants.html#a4363660e82e633cc1947ab968706b26b"/>
202+
<a href="namespacem__constants.html#a4719593ac4c8aa6382476232d2b20614"/>
199203
<a href="namespacem__constants.html#a515fed125471f30a2d2b1036e3c0d645"/>
200204
<a href="namespacem__constants.html#a519657d0f4b6e1301eedfbd71926c5cc"/>
201205
<a href="namespacem__constants.html#a53cf8dfd06fcfa36c018ab624ef988b6"/>
@@ -212,6 +216,7 @@
212216
<a href="namespacem__constants.html#a780f498b501ce87bb36fa0a33fce28c5"/>
213217
<a href="namespacem__constants.html#a78c3f6cc5d1faa23da2ff4283e31fe4a"/>
214218
<a href="namespacem__constants.html#a78dc466963174e056c559059e09704cc"/>
219+
<a href="namespacem__constants.html#a79603a708c77a92718374da11a4dc299"/>
215220
<a href="namespacem__constants.html#a80147c26022bec4383d74045e804ac0b"/>
216221
<a href="namespacem__constants.html#a89491724fc8077006ff1b62f981400ac"/>
217222
<a href="namespacem__constants.html#a8c2d85f8212ead54a233542e4b44a431"/>
@@ -238,6 +243,7 @@
238243
<a href="namespacem__constants.html#acd40252c4301f62b597827bf9d900f3a"/>
239244
<a href="namespacem__constants.html#ad2919a9016acfe411dfc41e18beb1140"/>
240245
<a href="namespacem__constants.html#ad33b5162f889bfb141eb03b8276ac183"/>
246+
<a href="namespacem__constants.html#ad59d636dd0c6c3876b6aa5fd7a23e9fe"/>
241247
<a href="namespacem__constants.html#ad6a16fddedb72d1e8a561901042ccd4a"/>
242248
<a href="namespacem__constants.html#ad9e8b92a99c0cefe3ac9fd476d9ff413"/>
243249
<a href="namespacem__constants.html#adfcbcad525ad9cfea6edf0d68eea3517"/>
@@ -359,6 +365,7 @@
359365
<a href="namespacem__global__parameters.html#a1a3314b39e21e17d7e72a9837db2ab42"/>
360366
<a href="namespacem__global__parameters.html#a1acf0ecc974673284ad75ebe30751453"/>
361367
<a href="namespacem__global__parameters.html#a1cbfce601c016d37f80ccb1bc67247c8"/>
368+
<a href="namespacem__global__parameters.html#a1dc6fe86e6ff9b5d155dbfc914ec130e"/>
362369
<a href="namespacem__global__parameters.html#a206f9fba2814a2fd594e9b884e183347"/>
363370
<a href="namespacem__global__parameters.html#a20b197a8bcb801bed6a0eef7baea2568"/>
364371
<a href="namespacem__global__parameters.html#a20f2996bb0dc87d637715622a9301f8d"/>
@@ -411,6 +418,7 @@
411418
<a href="namespacem__global__parameters.html#a4ecdedaf3db880f8d71dbefc816322f8"/>
412419
<a href="namespacem__global__parameters.html#a5113de77eca1f975b20056db60853757"/>
413420
<a href="namespacem__global__parameters.html#a53f0d5eed7783c9760aaeeaa0abbd58c"/>
421+
<a href="namespacem__global__parameters.html#a553f3c94d53e408a78574b5340ecf4a3"/>
414422
<a href="namespacem__global__parameters.html#a56a071ae0b79b39a826646ace37972eb"/>
415423
<a href="namespacem__global__parameters.html#a58143d8d3f8549f5fc87559074fae12b"/>
416424
<a href="namespacem__global__parameters.html#a59f10cfe28c1478382aa1ee4cd3793b9"/>
@@ -576,7 +584,7 @@
576584
<a href="namespacem__helper.html#aded4fe6025b2194ba0b5cc5a264af9ec"/>
577585
<a href="namespacem__helper.html#ae7cd99428d2408715b0db060b43de489"/>
578586
<a href="namespacem__helper__basic.html"/>
579-
<a href="namespacem__helper__basic.html#a0c3eea955b16f08e5eea03320507cc91"/>
587+
<a href="namespacem__helper__basic.html#a06946e8943e3955a57d083cc2d5ec182"/>
580588
<a href="namespacem__helper__basic.html#a136fdea4dc45a54a616248d66f4bc29e"/>
581589
<a href="namespacem__helper__basic.html#a345e205ced0b0674a22f59a2c1549eb4"/>
582590
<a href="namespacem__helper__basic.html#a35696604e5c3c1eda9a1fcdfca99de4f"/>

post_process/m__checker__common_8fpp_8f90.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@
191191
<tr class="memitem:ad82707f55f487d6868f76ea0074a8882" id="r_ad82707f55f487d6868f76ea0074a8882"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__checker__common.html#ad82707f55f487d6868f76ea0074a8882">m_checker_common::s_check_inputs_weno</a></td></tr>
192192
<tr class="memdesc:ad82707f55f487d6868f76ea0074a8882"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks constraints regarding WENO order. Called by s_check_inputs_common for all three stages. <br /></td></tr>
193193
<tr class="separator:ad82707f55f487d6868f76ea0074a8882"><td class="memSeparator" colspan="2">&#160;</td></tr>
194+
<tr class="memitem:a799f031bb6612816625d841ba4e19e00" id="r_a799f031bb6612816625d841ba4e19e00"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__checker__common.html#a799f031bb6612816625d841ba4e19e00">m_checker_common::s_check_inputs_muscl</a></td></tr>
195+
<tr class="memdesc:a799f031bb6612816625d841ba4e19e00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check constraints regarding MUSCL order Called by s_check_inputs_common for all three stages. <br /></td></tr>
196+
<tr class="separator:a799f031bb6612816625d841ba4e19e00"><td class="memSeparator" colspan="2">&#160;</td></tr>
194197
<tr class="memitem:ae5e684a5330dc4903b6cb1234e0b4f79" id="r_ae5e684a5330dc4903b6cb1234e0b4f79"><td class="memItemLeft" align="right" valign="top">impure subroutine&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__checker__common.html#ae5e684a5330dc4903b6cb1234e0b4f79">m_checker_common::s_check_inputs_bc</a></td></tr>
195198
<tr class="memdesc:ae5e684a5330dc4903b6cb1234e0b4f79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks constraints on the boundary conditions in the x-direction. Called by s_check_inputs_common for all three stages. <br /></td></tr>
196199
<tr class="separator:ae5e684a5330dc4903b6cb1234e0b4f79"><td class="memSeparator" colspan="2">&#160;</td></tr>

post_process/m__checker__common_8fpp_8f90.js

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)