Add hard coded patched for tests (#942)

Author: danieljvickers

docs/documentation/case.md

@@ -225,14 +225,15 @@ end if
 Some patch configurations are not adequately handled with the above analytic variable definitions.
 In this case, a hard coded patch can be used.
 Hard coded patches can be added by adding additional hard coded patch identifiers to `src/pre_process/include/1[2,3]dHardcodedIC.fpp`.
+When using a hard coded patch, the `patch_icpp(patch_id)%%hcid` must be set to the hard-coded patch id.
 For example, to add a 2D Hardcoded patch with an id of 200, one would add the following to `src/pre_process/include/2dHardcodedIC.fpp`
 
 ```f90
     case(200)
         ! Primitive variables assignment
 ```
 
-and use `patch_icpp(i)%%geometry = 7` and `patch_icpp(i)%%hcid = 200` in the input file.
+and use `patch_icpp(i)%%hcid = 200` in the input file.
 Additional variables can be declared in `Hardcoded1[2,3]DVariables` and used in `hardcoded1[2,3]D`.
 As a convention, any hard coded patches that are part of the MFC master branch should be identified as 1[2,3]xx where the first digit indicates the number of dimensions.
 
@@ -312,8 +313,8 @@ These parameters should be prepended with `patch_ib(j)%` where $j$ is the patch
 
 #### Parameter Descriptions
 
-- `geometry` defines the type of geometry of a patch with an integer number.
-Definitions for currently implemented patch types are list in table [Immersed Boundary Patch Type](#immersed-boundary-patch-types)
+- `geometry` defines the type of geometry of an immersed boundary patch with an integer number.
+Definitions for currently implemented immersed boundary patch types are listed in table [Immersed Boundary Patch Type](#immersed-boundary-patch-types).
 
 - `x[y,z]_centroid` is the centroid location of the patch in the x[y,z]-direction
 
@@ -996,16 +997,16 @@ This boundary condition can be used for subsonic inflow (`bc_[x,y,z]%[beg,end]`
 | 3    | Rectangle 	        | 2     | N      | Coordinate-aligned. Requires `[x,y]_centroid` and `length_[x,y]`. |
 | 4    | Sweep line 		| 2     | Y      | Not coordinate aligned. Requires `[x,y]_centroid` and `normal(i)`. |
 | 5    | Ellipse 		    | 2     | Y      | Requires `[x,y]_centroid` and `radii(i)`. |
-| 6    | N/A 		        | 2     | N      | No longer exists. Empty. |
-| 7    | 2D Hardcoded 	    | 2     | N      | Assigns the primitive variables as analytical functions. |
+| 6    | N/A 		        | N/A   | N/A    | No longer exists. Empty. |
+| 7    | N/A        	    | N/A   | N/A    | No longer exists. Empty. |
 | 8    | Sphere 		    | 3     | Y      | Requires `[x,y,z]_centroid` and `radius` |
 | 9    | Cuboid 		    | 3     | N      | Coordinate-aligned. Requires `[x,y,z]_centroid` and `length_[x,y,z]`. |
 | 10   | Cylinder 		    | 3     | Y      | Requires `[x,y,z]_centroid`, `radius`, and `length_[x,y,z]`. |
 | 11   | Sweep plane 	    | 3     | Y      | Not coordinate-aligned. Requires `x[y,z]_centroid` and `normal(i)`. |
 | 12   | Ellipsoid 		    | 3     | Y      | Requires `[x,y,z]_centroid` and `radii(i)`. |
-| 13   | 3D Hardcoded 	    | 3     | N      | Assigns the primitive variables as analytical functions |
+| 13   | N/A        	    | N/A   | N/A    | No longer exists. Empty. |
 | 14   | Spherical Harmonic | 3     | N      | Requires `[x,y,z]_centroid`, `radius`, `epsilon`, `beta` |
-| 15   | 1D Hardcoded      | 1     | N      | Assigns the primitive variables as analytical functions  |
+| 15   | N/A                | N/A   | N/A    | No longer exists. Empty.  |
 | 16   | 1D bubble pulse    | 1     | N      | Requires `x_centroid`, `length_x` |
 | 17   | Spiral             | 2     | N      | Requires `[x,y]_centroid` |
 | 18   | 2D Varcircle       | 2     | Y      | Requires `[x,y]_centroid`, `radius`, and `thickness` |

examples/1D_shuosher_analytical/case.py

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+import math
+import json
+
+# Numerical setup
+Nx = 1000
+dx = 1.0 / (1.0 * (Nx + 1))
+
+Tend, Nt = 1.8, 20000
+mydt = Tend / (1.0 * Nt)
+
+# Configuring case dictionary
+print(
+    json.dumps(
+        {
+            # Logistics
+            "run_time_info": "T",
+            # Computational Domain Parameters
+            "x_domain%beg": -5.0,
+            "x_domain%end": 5.0,
+            "m": Nx,
+            "n": 0,
+            "p": 0,
+            "dt": mydt,
+            "t_step_start": 0,
+            "t_step_stop": int(Nt),
+            "t_step_save": int(math.ceil(Nt / 10.0)),
+            # Simulation Algorithm Parameters
+            "num_patches": 2,
+            "model_eqns": 2,
+            "alt_soundspeed": "F",
+            "num_fluids": 1,
+            "mpp_lim": "F",
+            "mixture_err": "F",
+            "time_stepper": 3,
+            "weno_order": 5,
+            "weno_eps": 1.0e-16,
+            "mapped_weno": "T",
+            "null_weights": "F",
+            "mp_weno": "F",
+            "riemann_solver": 2,
+            "wave_speeds": 1,
+            "avg_state": 2,
+            "bc_x%beg": -3,
+            "bc_x%end": -3,
+            # Formatted Database Files Structure Parameters
+            "format": 1,
+            "precision": 2,
+            "prim_vars_wrt": "T",
+            "parallel_io": "F",
+            # Background to cover whole domain with basic line patch
+            # Patch 1 Left (-5 < x < -4)
+            "patch_icpp(1)%geometry": 1,
+            "patch_icpp(1)%x_centroid": -4.5,
+            "patch_icpp(1)%length_x": 1.0,
+            "patch_icpp(1)%vel(1)": 2.629369,
+            "patch_icpp(1)%pres": 10.3333,
+            "patch_icpp(1)%alpha_rho(1)": 3.957143,
+            "patch_icpp(1)%alpha(1)": 1.0,
+            # One anlytic patch to take care of -4 < x < 5
+            # Patch 2 Analytic
+            "patch_icpp(2)%geometry": 1,
+            "patch_icpp(2)%x_centroid": 0.5,
+            "patch_icpp(2)%length_x": 9.0,
+            "patch_icpp(2)%vel(1)": 0.0,
+            "patch_icpp(2)%pres": 1.0,
+            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha(1)": 1.0,
+            # Fluids Physical Parameters
+            "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),
+            "fluid_pp(1)%pi_inf": 0.0,
+        }
+    )
+)

examples/1D_shuosher_old/case.py

@@ -64,7 +64,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0.0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_shuosher_teno5/case.py

@@ -66,7 +66,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_shuosher_teno7/case.py

@@ -66,7 +66,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0.0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_shuosher_wenojs5/case.py

@@ -65,7 +65,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_shuosher_wenom5/case.py

@@ -65,7 +65,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_shuosher_wenoz5/case.py

@@ -65,7 +65,8 @@
             "patch_icpp(2)%length_x": 9.0,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.2*sin(5*x)",
+            "patch_icpp(2)%alpha_rho(1)": 0,
+            "patch_icpp(2)%hcid": 180,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_titarevtorro/case.py

@@ -62,7 +62,8 @@
             "patch_icpp(2)%length_x": 9.5,
             "patch_icpp(2)%vel(1)": 0.0,
             "patch_icpp(2)%pres": 1.0,
-            "patch_icpp(2)%alpha_rho(1)": "1 + 0.1*sin(20*x*pi)",
+            "patch_icpp(2)%alpha_rho(1)": 0.0,
+            "patch_icpp(2)%hcid": 181,
             "patch_icpp(2)%alpha(1)": 1.0,
             # Fluids Physical Parameters
             "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),

examples/1D_titarevtorro_analytical/case.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+import math
+import json
+
+# Numerical setup
+Nx = 999
+dx = 1.0 / (1.0 * (Nx + 1))
+
+Tend, Nt = 5, 20000
+mydt = Tend / (1.0 * Nt)
+
+# Configuring case dictionary
+print(
+    json.dumps(
+        {
+            # Logistics
+            "run_time_info": "T",
+            # Computational Domain Parameters
+            "x_domain%beg": -5.0,
+            "x_domain%end": 5.0,
+            "m": Nx,
+            "n": 0,
+            "p": 0,
+            "dt": mydt,
+            "t_step_start": 0,
+            "t_step_stop": int(Nt),
+            "t_step_save": int(math.ceil(Nt / 10.0)),
+            # Simulation Algorithm Parameters
+            "num_patches": 2,
+            "model_eqns": 2,
+            "alt_soundspeed": "F",
+            "num_fluids": 1,
+            "mpp_lim": "F",
+            "mixture_err": "F",
+            "time_stepper": 3,
+            "weno_order": 5,
+            "weno_eps": 1.0e-16,
+            "mapped_weno": "T",
+            "null_weights": "F",
+            "mp_weno": "F",
+            "riemann_solver": 2,
+            "wave_speeds": 1,
+            "avg_state": 2,
+            "bc_x%beg": -3,
+            "bc_x%end": -3,
+            # Formatted Database Files Structure Parameters
+            "format": 1,
+            "precision": 2,
+            "prim_vars_wrt": "T",
+            "parallel_io": "F",
+            # Patch 1 L (-5 < x < -4.5)
+            "patch_icpp(1)%geometry": 1,
+            "patch_icpp(1)%x_centroid": -4.75,
+            "patch_icpp(1)%length_x": 0.5,
+            "patch_icpp(1)%vel(1)": 0.523326,
+            "patch_icpp(1)%pres": 1.805,
+            "patch_icpp(1)%alpha_rho(1)": 1.515695,
+            "patch_icpp(1)%alpha(1)": 1.0,
+            # Patch 2 R (-4.5 < x < 5)
+            "patch_icpp(2)%geometry": 1,
+            "patch_icpp(2)%x_centroid": 0.25,
+            "patch_icpp(2)%length_x": 9.5,
+            "patch_icpp(2)%vel(1)": 0.0,
+            "patch_icpp(2)%pres": 1.0,
+            "patch_icpp(2)%alpha_rho(1)": "1 + 0.1*sin(20*x*pi)",
+            "patch_icpp(2)%alpha(1)": 1.0,
+            # Fluids Physical Parameters
+            "fluid_pp(1)%gamma": 1.0e00 / (1.4 - 1.0e00),
+            "fluid_pp(1)%pi_inf": 0.0,
+        }
+    )
+)