Merge pull request #197 from wilfonba/hardcodedICs

Author: sbryngelson

docs/documentation/case.md

@@ -155,6 +155,7 @@ the grid stretching funciton is applied and has a default value of one.
 | `alpha_rho(i)` *     | Real    | Supported             | Partial density of fluid $i$.                                |
 | `pres` *             | Real    | Supported             | Pressure.                                                    |
 | `vel(i)` *           | Real    | Supported             | Velocity in direction $i$.                                   |
+| `hcid` *             | Integer | N/A                   | Hard coded patch id                                          |
 | `model%filepath`     | String  | Not Supported         | Path to an STL or OBJ file (not all OBJs are supported).     |
 | `model%scale(i)`     | Real    | Not Supported         | Model's (applied) scaling factor for component $i$.          |
 | `model%rotate(i)`    | Real    | Not Supported         | Model's (applied) angle of rotation about axis $i$.          |
@@ -202,6 +203,18 @@ if (patch_id == 2) then
 end if
 ```
 
+#### Hard Coded Patches
+
+Some patch configurations are not adequatley handeled 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 identifers to `src/pre_process/include/1[2,3]dHardcodedIC.fpp`. For example, to add a 2D Hardcoded patch with an id of 201, one would add the following to `src/pre_process/include/2dHardcodedIC.fpp`
+
+```f90
+    if (patch_icpp%hcid == 201) then
+        ! Primitive variables assignment
+    end if
+```
+
+and use `patch_icpp(i)%geometry = y` and `patch_icpp(i)%hcid = 201` in the input file. As a convention, any hard coded patches that are part of the MFC master branch should be identied as 1[2,3]xx where the first digit indiates the number of dimensions.
+
 #### Parameter Descriptions
 
 - `num_patches` defines the total number of patches defined in the domain. The number has to be a positive integer.

src/common/m_derived_types.fpp

@@ -168,6 +168,9 @@ module m_derived_types
         real(kind(0d0)) :: p0 !< Bubble size
         real(kind(0d0)) :: m0 !< Bubble velocity
 
+        integer :: hcid
+        !! id for hard coded initial condition
+
     end type ic_patch_parameters
 
     !> Derived type annexing the physical parameters (PP) of the fluids. These

src/pre_process/include/1dHardcodedIC.fpp

@@ -0,0 +1,7 @@
+#:def Hardcoded1D()
+
+    if (patch_icpp(patch_id)%hcid == 100) then
+
+    end if
+
+#:enddef

src/pre_process/include/2dHardcodedIC.fpp

@@ -0,0 +1,7 @@
+#:def Hardcoded2D()
+
+    if (patch_icpp(patch_id)%hcid == 200) then
+
+    end if
+
+#:enddef

src/pre_process/include/3dHardcodedIC.fpp

@@ -0,0 +1,7 @@
+#:def Hardcoded3D()
+
+    if (patch_icpp(patch_id)%hcid == 300) then
+
+    end if
+
+#:enddef

src/pre_process/m_global_parameters.fpp

@@ -300,6 +300,8 @@ contains
 
             patch_icpp(i)%p0 = dflt_real
             patch_icpp(i)%m0 = dflt_real
+
+            patch_icpp(i)%hcid = dflt_int
         end do
 
         ! Tait EOS

src/pre_process/m_patches.fpp

@@ -3,6 +3,9 @@
 !! @brief Contains module m_patches
 
 #:include 'case.fpp'
+#:include '1dHardcodedIC.fpp'
+#:include '2dHardcodedIC.fpp'
+#:include '3dHardcodedIC.fpp'
 #:include 'macros.fpp'
 
 module m_patches
@@ -813,7 +816,7 @@ contains
                 call s_assign_patch_primitive_variables(patch_id, i, 0, 0, &
                                                 eta, q_prim_vf, patch_id_fp)
 
-                @:analytical()
+                @:Hardcoded1D()
             end if
         end do
 
@@ -927,7 +930,7 @@ contains
                     call s_assign_patch_primitive_variables(patch_id, i, j, 0, &
                                                     eta, q_prim_vf, patch_id_fp)
 
-                    @:analytical()
+                    @:Hardcoded2D()
                 end if
             end do
         end do
@@ -1001,7 +1004,7 @@ contains
                         call s_assign_patch_primitive_variables(patch_id, i, j, k, &
                                                     eta, q_prim_vf, patch_id_fp)
 
-                        @:analytical()
+                        @:Hardcoded3D()
 
                     end if
 

toolchain/mfc/run/case_dicts.py

@@ -39,7 +39,7 @@
     for attribute in ["geometry", "radius", "radii", "epsilon", "beta",
                       "normal", "smoothen", "smooth_patch_id", "alpha_rho",
                       "smooth_coeff", "rho", "vel", "pres", "alpha", "gamma",
-                      "pi_inf", "r0", "v0", "p0", "m0"]:
+                      "pi_inf", "r0", "v0", "p0", "m0", "hcid"]:
         PRE_PROCESS.append(f"patch_icpp({p_id})%{attribute}")
 
     PRE_PROCESS.append(f"patch_icpp({p_id})%model%filepath")