Skip to content

Commit bf1532b

Browse files
author
MFC Action
committed
Docs @ 9f40b5e
1 parent 4515c2c commit bf1532b

File tree

4 files changed

+37
-36
lines changed

4 files changed

+37
-36
lines changed

documentation/md_getting-started.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,9 +149,10 @@ <h1><a class="anchor" id="autotoc_md118"></a>
149149
<div class="fragment"><div class="line">mkdir -p ~/mfc_quickstart &amp;&amp; cd ~/mfc_quickstart</div>
150150
<div class="line">cp $(brew --prefix mfc)/examples/1D_sodshocktube/case.py .</div>
151151
<div class="line"># Use -n X to choose the number of MPI processes</div>
152-
<div class="line">mfc run case.py -n 2</div>
152+
<div class="line">mfc case.py -n 2</div>
153153
</div><!-- fragment --><p>Notes:</p><ul>
154-
<li>The Homebrew wrapper supports only <code>mfc run ...</code>. Developer commands like <code>build</code>, <code>test</code>, <code>clean</code> are available when you clone the repo and use <code>./mfc.sh</code>.</li>
154+
<li>The Homebrew package uses a simplified syntax: just <code>mfc &lt;case.py&gt;</code> to run cases.</li>
155+
<li>Developer commands like <code>build</code>, <code>test</code>, <code>clean</code> are available when you clone the repo and use <code>./mfc.sh</code>.</li>
155156
<li>The package bundles a Python venv and prebuilt binaries; no additional setup is required.</li>
156157
<li>Examples are installed at <code>$(brew --prefix mfc)/examples/</code>.</li>
157158
</ul>

documentation/md_running.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,10 +141,10 @@
141141
<h1><a class="anchor" id="autotoc_md156"></a>
142142
Using the Homebrew package (macOS)</h1>
143143
<p>If you installed MFC via Homebrew, run cases with the <code>mfc</code> wrapper:</p>
144-
<div class="fragment"><div class="line">mfc run &lt;path/to/case.py&gt; -n 2</div>
144+
<div class="fragment"><div class="line">mfc &lt;path/to/case.py&gt; -n 2</div>
145145
</div><!-- fragment --><ul>
146146
<li>Use <code>-n X</code> to control the number of MPI processes (ranks).</li>
147-
<li>Only the <code>run</code> command is supported in the Homebrew wrapper.</li>
147+
<li>The Homebrew package uses a simplified syntax: just <code>mfc &lt;case.py&gt;</code> to run cases.</li>
148148
<li>To use developer commands (<code>build</code>, <code>test</code>, <code>clean</code>, etc.), clone the repository and use <code>./mfc.sh</code>.</li>
149149
<li>The wrapper passes through runtime flags like <code>-t pre_process simulation</code>, <code>-n</code>, and others; it always runs with preinstalled binaries.</li>
150150
<li>Examples live at <code>$(brew --prefix mfc)/examples/</code>.</li>

simulation/m__global__parameters_8fpp_8f90.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -357,30 +357,30 @@
357357
<tr class="memitem:a8f189b60d9f8aa4b5cfb8451d9bacd73" id="r_a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memItemLeft" align="right" valign="top">logical&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a8f189b60d9f8aa4b5cfb8451d9bacd73">m_global_parameters::bf_z</a></td></tr>
358358
<tr class="memdesc:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="mdescLeft">&#160;</td><td class="mdescRight">body force toggle in three directions amplitude, frequency, and phase shift sinusoid in each direction <br /></td></tr>
359359
<tr class="separator:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
360-
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
361-
<tr class="separator:a2b4bee61739d582d3f9d9538c6100c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
362-
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
363-
<tr class="separator:aa11528d15dfa6e313e1298dee5ca42cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
360+
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
361+
<tr class="separator:a86fb50483af0d51af7adb848daa8a4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
362+
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
363+
<tr class="separator:a72371679cecccecfbc2b291dcd726228"><td class="memSeparator" colspan="2">&#160;</td></tr>
364+
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
365+
<tr class="separator:a82a4a61004712d4ded68b1018d796fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
366+
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
367+
<tr class="separator:ac5836965fc47e3cda0ac04bd3f33e347"><td class="memSeparator" colspan="2">&#160;</td></tr>
364368
<tr class="memitem:a1f924d5ee4e2910cffe8e756a0c8657b" id="r_a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1f924d5ee4e2910cffe8e756a0c8657b">m_global_parameters::p_z</a></td></tr>
365369
<tr class="separator:a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memSeparator" colspan="2">&#160;</td></tr>
370+
<tr class="memitem:a2b4bee61739d582d3f9d9538c6100c02" id="r_a2b4bee61739d582d3f9d9538c6100c02"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a2b4bee61739d582d3f9d9538c6100c02">m_global_parameters::k_z</a></td></tr>
371+
<tr class="separator:a2b4bee61739d582d3f9d9538c6100c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
366372
<tr class="memitem:a444ad421d11df63042d50c0ecae450c9" id="r_a444ad421d11df63042d50c0ecae450c9"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a444ad421d11df63042d50c0ecae450c9">m_global_parameters::g_z</a></td></tr>
367373
<tr class="separator:a444ad421d11df63042d50c0ecae450c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
368-
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
369-
<tr class="separator:a1671373492ac31693c8698500f095ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
370-
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
371-
<tr class="separator:a04316d272b181c3c8496d1b0ce088c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
374+
<tr class="memitem:aa11528d15dfa6e313e1298dee5ca42cd" id="r_aa11528d15dfa6e313e1298dee5ca42cd"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#aa11528d15dfa6e313e1298dee5ca42cd">m_global_parameters::w_z</a></td></tr>
375+
<tr class="separator:aa11528d15dfa6e313e1298dee5ca42cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
372376
<tr class="memitem:a1b662ab55a2226686cc9e8a9ab95ada3" id="r_a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1b662ab55a2226686cc9e8a9ab95ada3">m_global_parameters::p_x</a></td></tr>
373377
<tr class="separator:a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memSeparator" colspan="2">&#160;</td></tr>
378+
<tr class="memitem:a1671373492ac31693c8698500f095ff4" id="r_a1671373492ac31693c8698500f095ff4"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1671373492ac31693c8698500f095ff4">m_global_parameters::k_x</a></td></tr>
379+
<tr class="separator:a1671373492ac31693c8698500f095ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
374380
<tr class="memitem:a1b2b0f3b66e4aef04d872e7550735df5" id="r_a1b2b0f3b66e4aef04d872e7550735df5"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a1b2b0f3b66e4aef04d872e7550735df5">m_global_parameters::g_x</a></td></tr>
375381
<tr class="separator:a1b2b0f3b66e4aef04d872e7550735df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
376-
<tr class="memitem:a72371679cecccecfbc2b291dcd726228" id="r_a72371679cecccecfbc2b291dcd726228"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a72371679cecccecfbc2b291dcd726228">m_global_parameters::k_y</a></td></tr>
377-
<tr class="separator:a72371679cecccecfbc2b291dcd726228"><td class="memSeparator" colspan="2">&#160;</td></tr>
378-
<tr class="memitem:ac5836965fc47e3cda0ac04bd3f33e347" id="r_ac5836965fc47e3cda0ac04bd3f33e347"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#ac5836965fc47e3cda0ac04bd3f33e347">m_global_parameters::w_y</a></td></tr>
379-
<tr class="separator:ac5836965fc47e3cda0ac04bd3f33e347"><td class="memSeparator" colspan="2">&#160;</td></tr>
380-
<tr class="memitem:a86fb50483af0d51af7adb848daa8a4ae" id="r_a86fb50483af0d51af7adb848daa8a4ae"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a86fb50483af0d51af7adb848daa8a4ae">m_global_parameters::p_y</a></td></tr>
381-
<tr class="separator:a86fb50483af0d51af7adb848daa8a4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
382-
<tr class="memitem:a82a4a61004712d4ded68b1018d796fae" id="r_a82a4a61004712d4ded68b1018d796fae"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a82a4a61004712d4ded68b1018d796fae">m_global_parameters::g_y</a></td></tr>
383-
<tr class="separator:a82a4a61004712d4ded68b1018d796fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
382+
<tr class="memitem:a04316d272b181c3c8496d1b0ce088c64" id="r_a04316d272b181c3c8496d1b0ce088c64"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a04316d272b181c3c8496d1b0ce088c64">m_global_parameters::w_x</a></td></tr>
383+
<tr class="separator:a04316d272b181c3c8496d1b0ce088c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
384384
<tr class="memitem:a4d953db2f36f05624766c42cc9851362" id="r_a4d953db2f36f05624766c42cc9851362"><td class="memItemLeft" align="right" valign="top">real(<a class="el" href="namespacem__precision__select.html#a5c61bc246bcd3d3239269c38473c000a">wp</a>), dimension(3)&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a4d953db2f36f05624766c42cc9851362">m_global_parameters::accel_bf</a></td></tr>
385385
<tr class="separator:a4d953db2f36f05624766c42cc9851362"><td class="memSeparator" colspan="2">&#160;</td></tr>
386386
<tr class="memitem:a5422a3820409740b5c3b0b2e88bdb2b0" id="r_a5422a3820409740b5c3b0b2e88bdb2b0"><td class="memItemLeft" align="right" valign="top">integer&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacem__global__parameters.html#a5422a3820409740b5c3b0b2e88bdb2b0">m_global_parameters::cpu_start</a></td></tr>

0 commit comments

Comments
 (0)