Hardcoded Extrusion

Author: DimAdam-01

docs/documentation/case.md

@@ -240,7 +240,7 @@ Also Several custom hard-coded patches are already defined to support common wor
 
 By convention, patch ID `case(170)` load a 1D profile, ID `case(270)` extrude that 1D data into 2D, and ID `case(370)` extrude 2D data into 3D. 
 You only need to supply `init_dir` (and the filename‐pattern via `zeros_default`). All related variables (including init_dir, zeros_default, and the “files_loaded” flag) 
-live in `src/pre_process/include/HardcodedExtrusion.fpp`, and no manual grid‐size settings are required.
+live in `src/pre_process/include/ExtrusionHardcodedIC.fpp`, and no manual grid‐size settings are required.
 #### Parameter Descriptions
 
 - `num_patches` defines the total number of patches defined in the domain.

src/pre_process/include/1dHardcodedIC.fpp

@@ -18,25 +18,25 @@
             fileNames(f) = trim(init_dir)//"prim."//trim(file_num_str)//".00."//zeros_default//".dat"
             ! Create the filename with the pattern "prim.X.00.000000.dat"
         end do
-        
+
         if (.not. files_loaded) then
             !Reading the first file to calculate the number of grid points in the x direction
             line_count = 0
-            open(newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
-                if (ios2 /= 0) then
-                    write(errmsg, '(A,A)') "Error opening file: ", trim(fileNames(1))
-                    call s_mpi_abort(trim(errmsg))
-                end if
-                do
-                    read(unit2, *, iostat=ios2) dummy_x, dummy_y
-                    if (ios2 /= 0) exit  ! Exit since the file has been read
-                    line_count = line_count + 1
-                end do
-            close(unit2)
-            
+            open (newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
+            if (ios2 /= 0) then
+                write (errmsg, '(A,A)') "Error opening file: ", trim(fileNames(1))
+                call s_mpi_abort(trim(errmsg))
+            end if
+            do
+                read (unit2, *, iostat=ios2) dummy_x, dummy_y
+                if (ios2 /= 0) exit  ! Exit since the file has been read
+                line_count = line_count + 1
+            end do
+            close (unit2)
+
             xRows = line_count
-            allocate(x_coords(xRows))
-            allocate(stored_values(xRows, 1, sys_size))
+            allocate (x_coords(xRows))
+            allocate (stored_values(xRows, 1, sys_size))
             do f = 1, sys_size
                 ! Open the file for reading
                 open (newunit=unit, file=trim(fileNames(f)), status='old', action='read', iostat=ios)
@@ -74,6 +74,5 @@
         call s_int_to_str(patch_id, iStr)
         call s_mpi_abort("Invalid hcid specified for patch "//trim(iStr))
     end select
-     
 
 #:enddef

src/pre_process/include/2dHardcodedIC.fpp

@@ -167,28 +167,28 @@
                 write (file_num_str, '(I2)') f  ! Double digit
                 ! For more than 99 files, you might need to adjust this format
             end if
-            fileNames(f) = trim(init_dir)//"prim."//trim(file_num_str)//".00."//zeros_default//".dat" 
+            fileNames(f) = trim(init_dir)//"prim."//trim(file_num_str)//".00."//zeros_default//".dat"
         end do
 
         if (.not. files_loaded) then
             ! Calculating the number of grid points in the x direction in the file.
             line_count = 0
-            open(newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
-                if (ios2 /= 0) then
-                    write(errmsg, '(A,A)') "Error opening file: ", trim(fileNames(1))
-                    call s_mpi_abort(trim(errmsg))
-                end if
-                do
-                    read(unit2, *, iostat=ios2) dummy_x, dummy_y
-                    if (ios2 /= 0) exit ! Exit since files has been read
-                    line_count = line_count + 1
-                end do
-            close(unit2)
-            
+            open (newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
+            if (ios2 /= 0) then
+                write (errmsg, '(A,A)') "Error opening file: ", trim(fileNames(1))
+                call s_mpi_abort(trim(errmsg))
+            end if
+            do
+                read (unit2, *, iostat=ios2) dummy_x, dummy_y
+                if (ios2 /= 0) exit ! Exit since files has been read
+                line_count = line_count + 1
+            end do
+            close (unit2)
+
             index_x = i
             xRows = line_count
-            allocate(x_coords(xRows))
-            allocate(stored_values(xRows, 1, sys_size))
+            allocate (x_coords(xRows))
+            allocate (stored_values(xRows, 1, sys_size))
             do f = 1, sys_size - 1
                 ! Open the file for reading
                 open (newunit=unit, file=trim(fileNames(f)), status='old', action='read', iostat=ios)
@@ -227,7 +227,7 @@
         end do
         ! Set element the velocity paraller to y explicitly to zero
         q_prim_vf(momxe)%sf(i, j, 0) = 0.0_wp
-        
+
     case default
         if (proc_rank == 0) then
             call s_int_to_str(patch_id, iStr)
@@ -236,7 +236,4 @@
 
     end select
 
-
-
-
 #:enddef

src/pre_process/include/3dHardcodedIC.fpp

@@ -68,63 +68,63 @@
         end do
 
         if (.not. files_loaded) then
-          ! 1) Discover yRows by reading fileNames(1)  until x changes from the first line’s x.
-          open(newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
-          if (ios2 /= 0 ) then
-            write(errmsg, '(A,A)') "Error opening file for yRows detection: ", trim(fileNames(1))
-            call s_mpi_abort(trim(errmsg))
-          end if
-
-          ! Read the very first line to get (x₀, y₀)
-          read(unit2, *, iostat=ios2) x0, y0, dummy_z
-          if (ios2 /= 0 ) then
-            write(errmsg, '(A,A)') "Error reading first line of: ", trim(fileNames(1))
-            call s_mpi_abort(trim(errmsg))
-          end if
-
-          ycount = 1
-          do
-            read(unit2, *, iostat=ios2) dummy_x, dummy_y, dummy_z
-            if (ios2 /= 0) exit         ! End of File : stop counting
-            if (dummy_x == x0 .and. dummy_y /= y0) then
-              ! As soon as x or y changes from the first line’s (x0,y0),
-              ! we know we have counted all the (x0, y1) rows.
-              ycount = ycount + 1
-            else
-              exit
+            ! 1) Discover yRows by reading fileNames(1)  until x changes from the first line’s x.
+            open (newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
+            if (ios2 /= 0) then
+                write (errmsg, '(A,A)') "Error opening file for yRows detection: ", trim(fileNames(1))
+                call s_mpi_abort(trim(errmsg))
+            end if
+
+            ! Read the very first line to get (x₀, y₀)
+            read (unit2, *, iostat=ios2) x0, y0, dummy_z
+            if (ios2 /= 0) then
+                write (errmsg, '(A,A)') "Error reading first line of: ", trim(fileNames(1))
+                call s_mpi_abort(trim(errmsg))
+            end if
+
+            ycount = 1
+            do
+                read (unit2, *, iostat=ios2) dummy_x, dummy_y, dummy_z
+                if (ios2 /= 0) exit         ! End of File : stop counting
+                if (dummy_x == x0 .and. dummy_y /= y0) then
+                    ! As soon as x or y changes from the first line’s (x0,y0),
+                    ! we know we have counted all the (x0, y1) rows.
+                    ycount = ycount + 1
+                else
+                    exit
+                end if
+            end do
+            yRows = ycount
+            close (unit2)
+            ! 2) Count total rows (nrows) to get xRows
+            open (newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
+            if (ios2 /= 0) then
+                write (errmsg, '(A,A)') "Error re‐opening file to count rows: ", trim(fileNames(1))
+                call s_mpi_abort(trim(errmsg))
+            end if
+
+            nrows = 0
+            do
+                read (unit2, *, iostat=ios2) dummy_x, dummy_y, dummy_z
+                if (ios2 /= 0) exit
+                nrows = nrows + 1
+            end do
+            close (unit2)
+
+            if (mod(nrows, yRows) /= 0) then
+                write (errmsg, '(A,A,I0,A,I0)') &
+                    "File ’", trim(fileNames(1)), &
+                    "’ has total lines=", nrows, &
+                    " which is not a multiple of yRows=", yRows
+                call s_mpi_abort(trim(errmsg))
             end if
-          end do
-          yRows = ycount
-          close(unit2)
-          ! 2) Count total rows (nrows) to get xRows
-          open(newunit=unit2, file=trim(fileNames(1)), status='old', action='read', iostat=ios2)
-          if (ios2 /= 0 ) then
-            write(errmsg, '(A,A)') "Error re‐opening file to count rows: ", trim(fileNames(1))
-            call s_mpi_abort(trim(errmsg))
-          end if
-
-          nrows = 0
-          do
-            read(unit2, *, iostat=ios2) dummy_x, dummy_y, dummy_z
-            if (ios2 /= 0) exit
-            nrows = nrows + 1
-          end do
-          close(unit2)
-
-          if (mod(nrows, yRows) /= 0) then
-              write(errmsg, '(A,A,I0,A,I0)') &
-                "File ’", trim(fileNames(1)), &
-                "’ has total lines=", nrows, &
-                " which is not a multiple of yRows=", yRows
-              call s_mpi_abort(trim(errmsg))
-          end if
-            xRows = nrows / yRows
-            allocate(x_coords(nRows))
-            allocate(y_coords(nRows))
-            allocate(stored_values(xRows, yRows, sys_size))
+            xRows = nrows/yRows
+            allocate (x_coords(nRows))
+            allocate (y_coords(nRows))
+            allocate (stored_values(xRows, yRows, sys_size))
             index_x = i
             index_y = j
- 
+
             open (newunit=unit, file=trim(fileNames(1)), status='old', action='read', iostat=ios)
             if (ios /= 0) then
                 write (errmsg, '(A,A)') "Error opening file: ", trim(fileNames(f))
@@ -165,7 +165,6 @@
                 end do
             end do
             close (unit)
-           
 
             domain_xstart = x_coords(1)  ! First x value
             domain_ystart = y_coords(1)  ! First y value

src/pre_process/include/ExtrusionHardcodedIC.fpp

@@ -10,25 +10,23 @@
 !>     - files_loaded => .false.
 !>     - index_x, index_y, global_offset_x => 0.
 !>
-!>   (Note: The corresponding loader macro reads 
-!>    `prim.<variable>.00.<timestep>.dat` files—pattern controlled by `zeros_default`— 
+!>   (Note: The corresponding loader macro reads
+!>    `prim.<variable>.00.<timestep>.dat` files—pattern controlled by `zeros_default`—
 !>    from `examples/Case_File/D`.)
 
-
-
-#:def HardcodedDimensionsExtension()
+#:def HardcodedDimensionsExtrusion()
     integer :: xRows, yRows, nRows, iix, iiy
-    integer :: f, iter, ios, ios2, unit, unit2, idx,idy,index_x,index_y, jump, line_count, ycount
+    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
     real(wp) :: delta_x, delta_y
     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 :: stored_values(:, :, :)
     real(wp), allocatable :: x_coords(:), y_coords(:)
     logical :: files_loaded = .false.
-    real(wp) :: domain_xstart, domain_xend,  domain_ystart, domain_yend
+    real(wp) :: domain_xstart, domain_xend, domain_ystart, domain_yend
     character(len=*), parameter :: init_dir = "/home/YourDirectory" ! 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
@@ -37,11 +35,11 @@
 
 #:def HardcodedDellacation()
     if (allocated(stored_values)) then
-        deallocate(stored_values)
-        deallocate(x_coords)
+        deallocate (stored_values)
+        deallocate (x_coords)
     end if
 
     if (allocated(y_coords)) then
-        deallocate(y_coords)
+        deallocate (y_coords)
     end if
 #:enddef

src/pre_process/m_patches.fpp

@@ -1302,9 +1302,8 @@ contains
         ! Placeholders for the cell boundary values
         real(wp) :: a, b, c, d, pi_inf, gamma, lit_gamma
         real(wp) :: pi_inf, gamma, lit_gamma
-        @:HardcodedDimensionsExtension()
+        @:HardcodedDimensionsExtrusion()
         @:Hardcoded1DVariables()
-      
 
         pi_inf = fluid_pp(1)%pi_inf
         gamma = fluid_pp(1)%gamma
@@ -1419,10 +1418,9 @@ contains
 
         real(wp) :: pi_inf, gamma, lit_gamma !< equation of state parameters
         real(wp) :: l, U0 !< Taylor Green Vortex parameters
-        @:HardcodedDimensionsExtension()
+        @:HardcodedDimensionsExtrusion()
         @:Hardcoded2DVariables()
 
-
         pi_inf = fluid_pp(1)%pi_inf
         gamma = fluid_pp(1)%gamma
         lit_gamma = (1._wp + gamma)/gamma
@@ -1489,7 +1487,7 @@ contains
 
         integer :: i, j, k !< generic loop iterators
         real(wp) :: pi_inf, gamma, lit_gamma !< equation of state parameters
-        @:HardcodedDimensionsExtension()
+        @:HardcodedDimensionsExtrusion()
         @:Hardcoded3DVariables()
 
         pi_inf = fluid_pp(1)%pi_inf
@@ -1557,7 +1555,7 @@ contains
                 end do
             end do
         end do
-        
+
         @:HardcodedDellacation()
     end subroutine s_3D_analytical