You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<li><code>dt</code> specifies the constant time step size that is used in simulation. The value of <code>dt</code> needs to be sufficiently small such that the Courant-Friedrichs-Lewy (CFL) condition is satisfied.</li>
538
538
<li><code>t_step_start</code> and <code>t_step_end</code> define the time steps at which simulation starts and ends, respectively.</li>
539
539
</ul>
540
-
<p><code>t_step_save</code> is the time step interval for data output during simulation. To newly start the simulation, set <code>t_step_start = 0</code>. To restart simulation from $k$-th time step, set <code>t_step_start = k</code>, see <ahref="md_running.html#restarting_cases">Restarting Cases</a>.</p>
540
+
<p><code>t_step_save</code> is the time step interval for data output during simulation. To newly start the simulation, set <code>t_step_start = 0</code>. To restart simulation from $k$-th time step, set <code>t_step_start = k</code>, see <ahref="running.md#restarting-cases">Restarting Cases</a>.</p>
<li><code>t_save</code> specifies the time interval between data output during simulation</li>
549
549
<li><code>t_stop</code> specifies at what time the simulation should stop</li>
550
550
</ul>
551
-
<p>To newly start the simulation, set <code>n_start = 0</code>. To restart simulation from $k$-th time step, see <ahref="md_running.html#restarting_cases">Restarting Cases</a>.).</p>
551
+
<p>To newly start the simulation, set <code>n_start = 0</code>. To restart simulation from $k$-th time step, see <ahref="running.md#restarting-cases">Restarting Cases</a>.</p>
<p><b>All grind times are in nanoseconds (ns) per grid point (gp) per equation (eq) per right-hand side (rhs) evaluation, so X ns/gp/eq/rhs. Lower is better.</b></p>
<li>Rocprof (ROC): <code>./mfc.sh run ... -t simulation --roc --hip-trace [rocprof flags]</code> allows one to visualize MFC's system-wide performance with <ahref="https://ui.perfetto.dev/">Perfetto UI</a>. When used, <code>--roc</code> will run the simulation and generate files in the case directory for all targets. <code>results.json</code> can then be imported in <ahref="https://ui.perfetto.dev/">Perfetto's UI</a>. Learn more about AMD Rocprof <ahref="https://rocm.docs.amd.com/projects/rocprofiler/en/docs-5.5.1/rocprof.html">here</a> It is best to run case files with few timesteps to keep the report file sizes manageable.</li>
193
193
<li>Omniperf (OMNI): <code>./mfc.sh run ... -t simulation --omni [omniperf flags]</code> allows one to conduct kernel-level profiling with <ahref="https://rocm.docs.amd.com/projects/omniperf/en/latest/index.html">AMD's Omniperf</a>. When used, <code>--omni</code> will output profiling information for all subroutines, including rooflines, cache usage, register usage, and more, after the simulation is run. Adding this argument will moderately slow down the simulation and run the MFC executable several times. For this reason, it should only be used with case files with few timesteps.</li>
<p>When running a simulation, MFC generates a <code>./restart_data</code> folder in the case directory that contains <code>lustre_*.dat</code> files that can be used to restart a simulation from saved timesteps. This allows a user to simulate some timestep $X$, then continue it to run to another timestep $Y$, where $Y > X$. The user can also choose to add new patches at the intermediate timestep.</p>
<p>To run MFC's test suite, run </p><divclass="fragment"><divclass="line">./mfc.sh test -j <thread count></div>
140
140
</div><!-- fragment --><p>It will generate and run test cases, comparing their output to previous runs from versions of MFC considered accurate. <em>golden files</em>, stored in the <code>tests/</code> directory contain this data, aggregating <code>.dat</code> files generated when running MFC. A test is considered passing when our error tolerances are met in order to maintain a high level of stability and accuracy. Run <code>./mfc.sh test -h</code> for a full list of accepted arguments.</p>
141
141
<p>Most notably, you can consult the full list of tests by running </p><divclass="fragment"><divclass="line">./mfc.sh test -l</div>
142
142
</div><!-- fragment --><p>To restrict to a given range, use the <code>--from</code> (<code>-f</code>) and <code>--to</code> (<code>-t</code>) options. To run a (non-contiguous) subset of tests, use the <code>--only</code> (<code>-o</code>) option instead. To specify a computer, pass the <code>-c</code> flag to <code>./mfc.sh run</code> like so: </p><divclass="fragment"><divclass="line">./mfc.sh test -j <thread count> -- -c <computer name></div>
143
143
</div><!-- fragment --><p> where <code><computer name></code> could be <code>phoenix</code> or any of the others in the <ahref="https://github.com/MFlowCode/MFC/tree/master/toolchain/templates">templates</a>). You can create new templates with the appropriate run commands or omit this option. The use of <code>--</code> in the above command passes options to the <code>./mfc.sh run</code> command underlying the <code>./mfc.sh test</code>.</p>
144
-
<h2><aclass="anchor" id="autotoc_md100"></a>
144
+
<h2><aclass="anchor" id="autotoc_md101"></a>
145
145
Creating Tests</h2>
146
146
<p>To (re)generate <em>golden files</em>, append the <code>--generate</code> option: </p><divclass="fragment"><divclass="line">./mfc.sh test --generate -j 8</div>
147
147
</div><!-- fragment --><p>It is recommended that a range be specified when generating golden files for new test cases, as described in the previous section, in an effort not to regenerate the golden files of existing test cases.</p>
<p>If a trace is empty (that is, the empty string <code>""</code>), it will not appear in the final trace, but any case parameter variations associated with it will still be applied.</p>
187
187
<p>Finally, the case is appended to the <code>cases</code> list, which will be returned by the <code>list_cases</code> function.</p>
188
-
<h2><aclass="anchor" id="autotoc_md101"></a>
188
+
<h2><aclass="anchor" id="autotoc_md102"></a>
189
189
Testing Post Process</h2>
190
190
<p>To test the post-processing code, append the <code>-a</code> or <code>--test-all</code> option: </p><divclass="fragment"><divclass="line">./mfc.sh test -a -j 8</div>
191
191
</div><!-- fragment --><p>This argument will re-run the test stack with ‘parallel_io='T’<code>, which generates silo_hdf5 files. It will also turn most write parameters (</code>*_wrt<code>) on. Then, it searches through the silo files using</code>h5dump<code>to ensure that there are no</code>NaN<code>s or</code>Infinity<code>s. Although adding this option does not guarantee that accurate</code>.silo` files are generated, it does ensure that the post-process code does not fail or produce malformed data. </p>
0 commit comments