Skip to content

Commit 8c319b2

Browse files
author
MFC Action
committed
Docs @ 9b1e64f
1 parent 77d6964 commit 8c319b2

File tree

854 files changed

+1117
-5613
lines changed

Some content is hidden

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

854 files changed

+1117
-5613
lines changed

documentation/authors.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -144,10 +144,5 @@
144144
</div><!-- container -->
145145
<!-- HTML footer for doxygen 1.9.1-->
146146
<!-- start footer part -->
147-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
148-
<ul>
149-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
150-
</ul>
151-
</div>
152147
</body>
153148
</html>

documentation/case.html

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -179,7 +179,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md5"></a>
179179
</ul>
180180
<p><b>Parameter Lookup:</b></p><ul>
181181
<li>CLI search: <span class="tt">./mfc.sh params &lt;query&gt;</span> - Search ~3,300 parameters from the command line</li>
182-
<li>Full reference: <b><a class="el" href="parameters.html" title="Case Parameters Reference">Case Parameters</a></b> - Complete parameter documentation</li>
182+
<li>Full reference: <b><a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a></b> - Complete parameter documentation</li>
183183
</ul>
184184
<p>There are multiple sets of parameters that must be specified in the python input file:</p><ol type="1">
185185
<li><a class="el" href="#sec-runtime" title="1. Runtime">Runtime Parameters</a></li>
@@ -1448,10 +1448,5 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md23"></a>
14481448
</div><!-- container -->
14491449
<!-- HTML footer for doxygen 1.9.1-->
14501450
<!-- start footer part -->
1451-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1452-
<ul>
1453-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
1454-
</ul>
1455-
</div>
14561451
</body>
14571452
</html>

documentation/case_constraints.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -1405,10 +1405,5 @@ <h2 class="doxsection"><a class="anchor" id="physics-warnings"></a>
14051405
</div><!-- container -->
14061406
<!-- HTML footer for doxygen 1.9.1-->
14071407
<!-- start footer part -->
1408-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1409-
<ul>
1410-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
1411-
</ul>
1412-
</div>
14131408
</body>
14141409
</html>

documentation/citelist.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -356,10 +356,5 @@
356356
</div><!-- container -->
357357
<!-- HTML footer for doxygen 1.9.1-->
358358
<!-- start footer part -->
359-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
360-
<ul>
361-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
362-
</ul>
363-
</div>
364359
</body>
365360
</html>

documentation/cli-reference.html

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
1515
<meta name="generator" content="Doxygen 1.16.1"/>
1616
<meta name="viewport" content="width=device-width, initial-scale=1"/>
17-
<title>MFC: Command Line Reference</title>
17+
<title>MFC: CLI Reference</title>
1818
<meta name=”keywords” content="exascale, fluid dynamics, cfd, computational fluid dynamics, compressible, hpc, bryngelson, colonius, subgrid, multiphase, frontier, summit, el capitan, aurora, amd gpu, gpu, nvidia"/>
1919
<link href="tabs.css" rel="stylesheet" type="text/css"/>
2020
<script type="text/javascript" src="jquery.js"></script>
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -125,11 +125,11 @@
125125
</div>
126126

127127
<div><div class="header">
128-
<div class="headertitle"><div class="title">Command Line Reference </div></div>
128+
<div class="headertitle"><div class="title">CLI Reference </div></div>
129129
</div><!--header-->
130130
<div class="contents">
131131
<div class="textblock"><h1 class="doxsection"><a class="anchor" id="autotoc_md29"></a>
132-
Command Line Reference</h1>
132+
CLI Reference</h1>
133133
<blockquote class="doxtable">
134134
<p><b>Auto-generated</b> from <span class="tt">toolchain/mfc/cli/commands.py</span></p>
135135
<p>Regenerate with: <span class="tt">./mfc.sh generate</span> </p>
@@ -847,10 +847,5 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md64"></a>
847847
</div><!-- container -->
848848
<!-- HTML footer for doxygen 1.9.1-->
849849
<!-- start footer part -->
850-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
851-
<ul>
852-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
853-
</ul>
854-
</div>
855850
</body>
856851
</html>

documentation/contributing.html

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -200,7 +200,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md71"></a>
200200
<li><b>Fypp</b> preprocesses <span class="tt">.fpp</span> files into <span class="tt">.f90</span> (expands GPU macros, code generation)</li>
201201
<li><b>Fortran compiler</b> builds three executables from the generated <span class="tt">.f90</span> files</li>
202202
</ol>
203-
<p>See <a class="el" href="parameters.html" title="Case Parameters Reference">Case Parameters Reference</a> for the full list of ~3,400 simulation parameters. See <a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> for feature compatibility and example configurations.</p>
203+
<p>See <a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a> for the full list of ~3,400 simulation parameters. See <a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> for feature compatibility and example configurations.</p>
204204
<h2 class="doxsection"><a class="anchor" id="autotoc_md72"></a>
205205
Development Workflow</h2>
206206
<table class="markdownTable">
@@ -352,7 +352,7 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md87"></a>
352352
<p>Step-by-step recipes for common development tasks.</p>
353353
<h3 class="doxsection"><a class="anchor" id="autotoc_md88"></a>
354354
How to Add a New Simulation Parameter</h3>
355-
<p>Adding a parameter touches both the Python toolchain and Fortran source. Follow these steps in order. See <a class="el" href="parameters.html" title="Case Parameters Reference">Case Parameters Reference</a> for the full list of existing parameters and <a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> for feature compatibility.</p>
355+
<p>Adding a parameter touches both the Python toolchain and Fortran source. Follow these steps in order. See <a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a> for the full list of existing parameters and <a class="el" href="case_constraints.html" title="Case Creator Guide">Case Creator Guide</a> for feature compatibility.</p>
356356
<p><b>Step 1: Register in Python</b> (<span class="tt">toolchain/mfc/params/definitions.py</span>)</p>
357357
<p>Add a call to <span class="tt">_r()</span> inside the <span class="tt">_load()</span> function:</p>
358358
<div class="fragment"><div class="line">_r(<span class="stringliteral">&quot;my_param&quot;</span>, REAL, {<span class="stringliteral">&quot;my_feature_tag&quot;</span>},</div>
@@ -363,7 +363,7 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md88"></a>
363363
<li><b>type</b>: <span class="tt">INT</span>, <span class="tt">REAL</span>, <span class="tt">LOG</span>, <span class="tt">STR</span>, or <span class="tt">A_REAL</span> (analytic expression)</li>
364364
<li><b>tags</b>: set of feature tags for grouping (e.g. <span class="tt">{"bubbles"}</span>, <span class="tt">{"mhd"}</span>)</li>
365365
<li><b>desc</b>: human-readable description (optional; auto-generated from <span class="tt">_SIMPLE_DESCS</span> or <span class="tt">_ATTR_DESCS</span> if omitted)</li>
366-
<li><b>math</b>: LaTeX math symbol in Doxygen format (optional; shown in the Symbol column of <a class="el" href="parameters.html" title="Case Parameters Reference">Case Parameters Reference</a>)</li>
366+
<li><b>math</b>: LaTeX math symbol in Doxygen format (optional; shown in the Symbol column of <a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a>)</li>
367367
</ul>
368368
<p>For indexed families like <span class="tt">fluid_pp</span>, put the symbol next to its attribute name using tuples:</p>
369369
<div class="fragment"><div class="line"><span class="keywordflow">for</span> f <span class="keywordflow">in</span> range(1, NF + 1):</div>
@@ -798,10 +798,5 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md105"></a>
798798
</div><!-- container -->
799799
<!-- HTML footer for doxygen 1.9.1-->
800800
<!-- start footer part -->
801-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
802-
<ul>
803-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
804-
</ul>
805-
</div>
806801
</body>
807802
</html>

documentation/custom.css

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,16 @@
33
* Overrides for doxygen-awesome theme
44
*/
55

6+
/* Narrower left navigation panel */
7+
html {
8+
--side-nav-fixed-width: 210px;
9+
}
10+
11+
/* Hide tree sync button */
12+
#nav-sync {
13+
display: none;
14+
}
15+
616
/* Seamless split <code> tags for Fortran % struct accessors.
717
* Doxygen consumes %<word> even inside code spans, so we split around %
818
* into adjacent <code> elements and remove internal borders/padding. */

documentation/docker.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -263,10 +263,5 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md119"></a>
263263
</div><!-- container -->
264264
<!-- HTML footer for doxygen 1.9.1-->
265265
<!-- start footer part -->
266-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
267-
<ul>
268-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
269-
</ul>
270-
</div>
271266
</body>
272267
</html>

documentation/equations.html

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -132,7 +132,7 @@
132132
MFC: Comprehensive Equations Reference</h1>
133133
<p>This document catalogs every equation solved by MFC, organized by physical model. Each section notes the input parameter(s) that activate the corresponding physics module and cross-references the relevant source files.</p>
134134
<p>The models and algorithms described here are detailed in Wilfong et al. <a class="el" href="citelist.html#CITEREF_wilfong26">[54]</a> (MFC 5.0) and Bryngelson et al. <a class="el" href="citelist.html#CITEREF_bryngelson21">[8]</a>. Foundational references for each model are cited inline; see the <a class="el" href="citelist.html" title="Bibliography">Bibliography</a> for full details.</p>
135-
<p>For parameter details and allowed values, see <a class="el" href="case.html" title="Case Files">Case Files</a> and the <a class="el" href="parameters.html" title="Case Parameters Reference">Case Parameters</a> reference.</p>
135+
<p>For parameter details and allowed values, see <a class="el" href="case.html" title="Case Files">Case Files</a> and the <a class="el" href="parameters.html" title="Case Parameters">Case Parameters</a> reference.</p>
136136
<hr />
137137
<h2 class="doxsection"><a class="anchor" id="autotoc_md123"></a>
138138
1. Overview</h2>
@@ -1143,10 +1143,5 @@ <h2 class="doxsection"><a class="anchor" id="autotoc_md195"></a>
11431143
</div><!-- container -->
11441144
<!-- HTML footer for doxygen 1.9.1-->
11451145
<!-- start footer part -->
1146-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
1147-
<ul>
1148-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
1149-
</ul>
1150-
</div>
11511146
</body>
11521147
</html>

documentation/examples.html

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@
6464
<td id="projectalign" style="padding-left: 0.5em;">
6565
<div id="projectname">MFC
6666
</div>
67-
<div id="projectbrief">High-fidelity multiphase flow simulation</div>
67+
<div id="projectbrief">Exascale flow solver</div>
6868
</td>
6969
</tr>
7070
</tbody>
@@ -372,10 +372,5 @@ <h3 class="doxsection"><a class="anchor" id="autotoc_md258"></a>
372372
</div><!-- container -->
373373
<!-- HTML footer for doxygen 1.9.1-->
374374
<!-- start footer part -->
375-
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
376-
<ul>
377-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.16.1 </li>
378-
</ul>
379-
</div>
380375
</body>
381376
</html>

0 commit comments

Comments
 (0)