restore master inline comments safely (exclude PR-removed variables)

Author: sbryngelson

.ffmt_cache/hashes

@@ -13,21 +13,21 @@
         ! magnetic field
         q_prim_vf(B_idx%end - 1)%sf(i, 0, 0) = 0.1_wp*sin(2._wp*pi*x_cc(i))
         q_prim_vf(B_idx%end)%sf(i, 0, 0) = 0.1_wp*cos(2._wp*pi*x_cc(i))
-    case (170)
+    case (170)  ! 1D profile from external data (e.g. Cantera, SDtoolbox)
         ! This hardcoded case can be used to start a simulation with initial conditions given from a known 1D profile (e.g. Cantera,
         ! SDtoolbox)
         @: HardcodedReadValues()
-    case (180)
+    case (180)  ! Shu-Osher problem
         ! This is patch is hard-coded for test suite optimization used in the 1D_shuoser cases: "patch_icpp(2)%alpha_rho(1)": "1 +
         ! 0.2*sin(5*x)"
         if (patch_id == 2) then
             q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.2*sin(5*x_cc(i))
         end if
-    case (181)
+    case (181)  ! Titarev-Torro problem
         ! This is patch is hard-coded for test suite optimization used in the 1D_titarevtorro cases: "patch_icpp(2)%alpha_rho(1)":
         ! "1 + 0.1*sin(20*x*pi)"
         q_prim_vf(contxb + 0)%sf(i, 0, 0) = 1 + 0.1*sin(20*x_cc(i)*pi)
-    case (182)
+    case (182)  ! Multi-component diffusion
         ! This patch is a hard-coded for test suite optimization (multiple component diffusion)
         x_mid_diffu = 0.05_wp/2.0_wp
         width_sq = (2.5_wp*10.0_wp**(-3.0_wp))**2

src/common/include/1dHardcodedIC.fpp

@@ -18,7 +18,7 @@
 
 #:def Hardcoded2D()
     select case (patch_icpp(patch_id)%hcid)  ! 2D_hardcoded_ic example case
-    case (200)
+    case (200)  ! Two-fluid cubic interface
         if (y_cc(j) <= (-x_cc(i)**3 + 1)**(1._wp/3._wp)) then
             ! Volume Fractions
             q_prim_vf(advxb)%sf(i, j, 0) = eps
@@ -265,10 +265,10 @@
             q_prim_vf(B_idx%beg + 1)%sf(i, j, 0) = (5._wp/sqrt(4._wp*pi))*sinA + (5._wp/sqrt(4._wp*pi))*cosA
         end if
         ! v^z and B^z remain zero by default
-    case (270)
+    case (270)  ! 2D extrusion of 1D profile from external data
         ! This hardcoded case extrudes a 1D profile to initialize a 2D simulation domain
         @: HardcodedReadValues()
-    case (280)
+    case (280)  ! Isentropic vortex
         ! This is patch is hard-coded for test suite optimization used in the 2D_isentropicvortex case: This analytic patch uses
         ! geometry 2
         if (patch_id == 1) then
@@ -285,7 +285,7 @@
                       & 0) = 0.0 - (x_cc(i) - patch_icpp(1)%x_centroid)*(5.0/(2.0*pi))*exp(1.0*(1.0 - (x_cc(i) - patch_icpp(1) &
                       & %x_centroid)**2.0 - (y_cc(j) - patch_icpp(1)%y_centroid)**2.0))
         end if
-    case (281)
+    case (281)  ! Acoustic pulse
         ! This is patch is hard-coded for test suite optimization used in the 2D_acoustic_pulse case: This analytic patch uses
         ! geometry 2
         if (patch_id == 2) then
@@ -294,7 +294,7 @@
             q_prim_vf(contxb + 0)%sf(i, j, &
                       & 0) = 1*(1 - 0.5*(1.4 - 1)*(0.4)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1/(1.4 - 1))
         end if
-    case (282)
+    case (282)  ! Zero-circulation vortex
         ! This is patch is hard-coded for test suite optimization used in the 2D_zero_circ_vortex case: This analytic patch uses
         ! geometry 2
         if (patch_id == 2) then

src/common/include/2dHardcodedIC.fpp

@@ -7,13 +7,13 @@
     real(wp), dimension(:), allocatable :: y_th_arr, z_th_arr, r_th_arr
     ! Variables to describe initial condition of jet
     real(wp)                              :: r, ux_th, ux_am, p_th, p_am, rho_th, rho_am, y_th, z_th, r_th, eps_smooth
-    real(wp)                              :: rcut, xcut  ! Intermediate variables for creating smooth initial condition
+    real(wp)                              :: rcut, xcut  !< Intermediate variables for creating smooth initial condition
     real(wp), dimension(0:n,0:p)          :: rcut_arr
-    integer                               :: l, q, s  ! Iterators for reading input files
-    integer                               :: start, end  ! Ints to keep track of position in file
+    integer                               :: l, q, s     !< Iterators for reading input files
+    integer                               :: start, end  !< Ints to keep track of position in file
     character(len=100000)                 :: line  ! String to store line in file
-    character(len=25)                     :: value  ! String to store value in line
-    integer                               :: NJet  ! Number of jets
+    character(len=25)                     :: value       !< String to store value in line
+    integer                               :: NJet        !< Number of jets
     real(wp), allocatable, dimension(:,:) :: ih  ! Array to store interface height in
     logical                               :: file_exist  ! Flag to check if file exists
 
@@ -261,10 +261,10 @@
                   & k))*g0_ic*(ih(start_idx(1) + i, start_idx(3) + k) - y_cc(j))
 
         if (surface_tension) q_prim_vf(c_idx)%sf(i, j, k) = alph
-    case (370)
+    case (370)  ! 3D extrusion of 2D profile from external data
         ! This hardcoded case extrudes a 2D profile to initialize a 3D simulation domain
         @: HardcodedReadValues()
-    case (380)
+    case (380)  ! Taylor-Green vortex
         ! This is patch is hard-coded for test suite optimization used in the 3D_TaylorGreenVortex case: This analytic patch used
         ! geometry 9
         Mach = 0.1

src/common/include/3dHardcodedIC.fpp

@@ -40,18 +40,18 @@
     integer                                 :: f, iter, ios, ios2, unit, unit2, idx, idy, index_x, index_y, jump, line_count, ycount
     real(wp)                                :: x_len, x_step, y_len, y_step
     real(wp)                                :: dummy_x, dummy_y, dummy_z, x0, y0
-    integer                                 :: global_offset_x, global_offset_y  ! MPI subdomain offset
+    integer                                 :: global_offset_x, global_offset_y       !< MPI subdomain offset
     real(wp)                                :: delta_x, delta_y
-    character(len=100), dimension(sys_size) :: fileNames  ! Arrays to store all data from files
+    character(len=100), dimension(sys_size) :: fileNames                              !< Arrays to store all data from files
     character(len=200)                      :: errmsg
     real(wp), allocatable                   :: stored_values(:,:,:)
     real(wp), allocatable                   :: x_coords(:), y_coords(:)
     logical                                 :: files_loaded = .false.
     real(wp)                                :: domain_xstart, domain_xend, domain_ystart, domain_yend
-    character(len=*), parameter             :: init_dir = "/home/MFC/FilesDirectory"  ! For example /home/MFC/examples/1D_Shock/D/
-    character(len=20)                       :: file_num_str  ! For storing the file number as a string
-    character(len=20)                       :: zeros_part  ! For the trailing zeros part
-    character(len=6), parameter             :: zeros_default = "000000"  ! Default zeros (can be changed)
+    character(len=*), parameter             :: init_dir = "/home/MFC/FilesDirectory"  !< For example /home/MFC/examples/1D_Shock/D/
+    character(len=20)                       :: file_num_str                           !< For storing the file number as a string
+    character(len=20)                       :: zeros_part                             !< For the trailing zeros part
+    character(len=6), parameter             :: zeros_default = "000000"               !< Default zeros (can be changed)
 #:enddef
 
 #:def HardcodedReadValues()