Docs @ e2ce07d

Author: MFC Action

documentation/md_examples.html

@@ -304,6 +304,8 @@ <h1><a class="anchor" id="autotoc_md95"></a>
 <h2><a class="anchor" id="autotoc_md96"></a>
 Initial Condition and Result</h2>
 <p><img src="initial-2D_hardcoded_ic-example.png" alt="" width="45%" class="inline"/> <img src="result-2D_hardcoded_ic-example.png" alt="" width="45%" class="inline"/></p>
+<p>This example case contains an automated convergence test using a 1D, two-component advection case. The case can be run by executing the bash script <code>./submitJobs.sh</code> in a terminal after enabling execution permissions with <code>chmod +x ./submitJobs.sh</code> and setting the <code>ROOT_DIR</code> and <code>MFC_DIR</code> variables. By default the script runs the case for 6 different grid resolutions with 1st, 3rd, and 5th, order spatial reconstructions. These settings can be modified by editing the variables at the top of the script. You can also run different model equations by setting the <code>ME</code> variable and different Riemann solvers by setting the <code>RS</code> variable.</p>
+<p>Once the simulations have been run, you can generate convergence plots with matplotlib by running <code>python3 plot.py</code> in a terminal. This will generate plots of the L1, L2, and Linf error norms and save the results to <code>errors.csv</code>.</p>
 <h1><a class="anchor" id="autotoc_md97"></a>
 Backward Facing Step (2D)</h1>
 <h2><a class="anchor" id="autotoc_md98"></a>

simulation/m__global__parameters_8fpp_8f90.html

@@ -357,30 +357,30 @@
 <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>
 <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>
 <tr class="separator:a8f189b60d9f8aa4b5cfb8451d9bacd73"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:a86fb50483af0d51af7adb848daa8a4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:a72371679cecccecfbc2b291dcd726228"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:ac5836965fc47e3cda0ac04bd3f33e347"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:a82a4a61004712d4ded68b1018d796fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a2b4bee61739d582d3f9d9538c6100c02"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:aa11528d15dfa6e313e1298dee5ca42cd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a1f924d5ee4e2910cffe8e756a0c8657b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a444ad421d11df63042d50c0ecae450c9"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<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>
-<tr class="separator:a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a1671373492ac31693c8698500f095ff4"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a04316d272b181c3c8496d1b0ce088c64"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a1b662ab55a2226686cc9e8a9ab95ada3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a1b2b0f3b66e4aef04d872e7550735df5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a72371679cecccecfbc2b291dcd726228"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:ac5836965fc47e3cda0ac04bd3f33e347"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a86fb50483af0d51af7adb848daa8a4ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<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>
+<tr class="separator:a82a4a61004712d4ded68b1018d796fae"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>
 <tr class="separator:a4d953db2f36f05624766c42cc9851362"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <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>