Github suggestions and bug fix

Author: wilfonba

examples/1D_convergence/README.md

@@ -1,7 +1,7 @@
 This example case contains an automated convergence test using a 1D, two-component advection case.
-The case can be ran by executing the bash script `./submitJobs.sh` in a terminal after enabling
+The case can be run by executing the bash script `./submitJobs.sh` in a terminal after enabling
 execution permissions with `chmod +x ./submitJobs.sh` and setting the `ROOT_DIR` and `MFC_DIR`
-variables. The default settings the script run the case for 6 different grid resolutions with 1st,
+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 `ME` variable
 and different Riemann solvers by setting the `RS` variable.

examples/1D_convergence/plot.py

@@ -19,16 +19,15 @@
         exact_a2 = pd.read_csv(f"N{N[i]}_O{Ord[j]}/D/cons.6.00.000000.dat", sep=r"\s+", header=None, names=["x", "y"])
 
         ## 2 norm
-        errors[i, j, 0] = 1 / N[i] * np.sum(np.sqrt((sim_a1.y - exact_a1.y) ** 2))
-        errors[i, j, 0] += 1 / N[i] * np.sum(np.sqrt((sim_a2.y - exact_a2.y) ** 2))
+        errors[i, j, 0] = np.linalg.norm(sim_a1.y - exact_a1.y) / np.sqrt(N[i])
+        errors[i, j, 0] += np.linalg.norm(sim_a2.y - exact_a2.y) / np.sqrt(N[i])
 
         ## 1 norm
         errors[i, j, 1] = 1 / N[i] * np.sum(np.abs(sim_a1.y - exact_a1.y))
         errors[i, j, 1] += 1 / N[i] * np.sum(np.abs(sim_a2.y - exact_a2.y))
 
         ## Inf norm
-        errors[i, j, 2] = np.nanmax(np.abs(sim_a1.y - exact_a1.y))
-        errors[i, j, 2] += np.nanmax(np.abs(sim_a2.y - exact_a2.y))
+        errors[i, j, 2] = np.max([np.nanmax(np.abs(sim_a1.y - exact_a1.y)), np.nanmax(np.abs(sim_a2.y - exact_a2.y))])
 
 fig, ax = plt.subplots(1, 3, figsize=(12, 8), sharex=True)
 

examples/1D_convergence/submitJobs.sh

@@ -1,13 +1,14 @@
 #!/usr/bin/env sh
 Nx=(32 64 128 256 512 1024)
 Order=(1 3 5)
+
 ME=2 # Model equations = 2 for five-equation model
 RS=2 # Riemann solver = 2 for HLLC
 
-#ROOT_DIR=<WORKING DIRECTORY>
-#MFC_DIR=<MFC ROOT DIR>
-ROOT_DIR="/Users/benwilfong/Documents/software/MFC-Wilfong/examples/1D_convergence"
-MFC_DIR="/Users/benwilfong/Documents/software/MFC-Wilfong"
+# Get the directory of the script itself
+ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
+# Assume the script is in examples/1D_convergence, so MFC_DIR is two levels up
+MFC_DIR="$(dirname "$(dirname "$ROOT_DIR")")"
 
 for i in "${Nx[@]}"; do
     for j in "${Order[@]}"; do

toolchain/mfc/test/cases.py

@@ -1021,7 +1021,8 @@ def foreach_example():
                            "3D_TaylorGreenVortex_analytical",
                            "3D_IGR_TaylorGreenVortex_nvidia",
                            "2D_backward_facing_step",
-                           "2D_forward_facing_step"]
+                           "2D_forward_facing_step",
+                           "1D_convergence"]
             if path in casesToSkip:
                 continue
             name = f"{path.split('_')[0]} -> Example -> {'_'.join(path.split('_')[1:])}"