Apply ffmt formatting with comment alignment and idempotency fixes

Author: sbryngelson

src/common/include/2dHardcodedIC.fpp

@@ -228,7 +228,7 @@
 
         ! pressure
         q_prim_vf(E_idx)%sf(i, j, &
-                  & 0) = 1._wp + (1 - 2._wp*(x_cc(i)**2 + y_cc(j)**2))*exp(1 - (x_cc(i)**2 + y_cc(j)**2))/((2._wp*pi)**3)
+            & 0) = 1._wp + (1 - 2._wp*(x_cc(i)**2 + y_cc(j)**2))*exp(1 - (x_cc(i)**2 + y_cc(j)**2))/((2._wp*pi)**3)
     case (260) ! Gaussian Divergence Pulse
         !  Bx(x) = 1 + C * erf((x-0.5)/\sigma)
         !  =>  \partialBx/\partialx = C * (2/\sqrt\pi) * exp[-((x-0.5)/\sigma)**2] * (1/\sigma)
@@ -287,39 +287,39 @@
         ! This analytic patch uses geometry 2
         if (patch_id == 1) then
             q_prim_vf(E_idx)%sf(i, j, &
-                      & 0) = 1.0*(1.0 - (1.0/1.0)*(5.0/(2.0*pi))*(5.0/(8.0*1.0*(1.4 + 1.0)*pi))*exp(2.0*1.0*(1.0 - (x_cc(i) &
-                      & - patch_icpp(1)%x_centroid)**2.0 - (y_cc(j) - patch_icpp(1)%y_centroid)**2.0)))**(1.4 + 1.0)
+                & 0) = 1.0*(1.0 - (1.0/1.0)*(5.0/(2.0*pi))*(5.0/(8.0*1.0*(1.4 + 1.0)*pi))*exp(2.0*1.0*(1.0 - (x_cc(i) &
+                & - patch_icpp(1)%x_centroid)**2.0 - (y_cc(j) - patch_icpp(1)%y_centroid)**2.0)))**(1.4 + 1.0)
             q_prim_vf(contxb + 0)%sf(i, j, &
-                      & 0) = 1.0*(1.0 - (1.0/1.0)*(5.0/(2.0*pi))*(5.0/(8.0*1.0*(1.4 + 1.0)*pi))*exp(2.0*1.0*(1.0 - (x_cc(i) &
-                      & - patch_icpp(1)%x_centroid)**2.0 - (y_cc(j) - patch_icpp(1)%y_centroid)**2.0)))**1.4
+                & 0) = 1.0*(1.0 - (1.0/1.0)*(5.0/(2.0*pi))*(5.0/(8.0*1.0*(1.4 + 1.0)*pi))*exp(2.0*1.0*(1.0 - (x_cc(i) &
+                & - patch_icpp(1)%x_centroid)**2.0 - (y_cc(j) - patch_icpp(1)%y_centroid)**2.0)))**1.4
             q_prim_vf(momxb + 0)%sf(i, j, &
-                      & 0) = 0.0 + (y_cc(j) - patch_icpp(1)%y_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))
+                & 0) = 0.0 + (y_cc(j) - patch_icpp(1)%y_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))
             q_prim_vf(momxb + 1)%sf(i, j, &
-                      & 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))
+                & 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)
         ! 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
             q_prim_vf(E_idx)%sf(i, j, &
-                      & 0) = 101325*(1 - 0.5*(1.4 - 1)*(0.4)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1.4/(1.4 - 1))
+                & 0) = 101325*(1 - 0.5*(1.4 - 1)*(0.4)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1.4/(1.4 - 1))
             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))
+                & 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)
         ! 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
             q_prim_vf(E_idx)%sf(i, j, &
-                      & 0) = 101325*(1 - 0.5*(1.4 - 1)*(0.1/0.3)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1.4/(1.4 - 1))
+                & 0) = 101325*(1 - 0.5*(1.4 - 1)*(0.1/0.3)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1.4/(1.4 - 1))
             q_prim_vf(contxb + 0)%sf(i, j, &
-                      & 0) = 1*(1 - 0.5*(1.4 - 1)*(0.1/0.3)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1/(1.4 - 1))
+                & 0) = 1*(1 - 0.5*(1.4 - 1)*(0.1/0.3)**2*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2))))**(1/(1.4 - 1))
             q_prim_vf(momxb + 0)%sf(i, j, &
-                      & 0) = 112.99092883944267*(1 - (0.1/0.3))*y_cc(j)*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2)))
+                & 0) = 112.99092883944267*(1 - (0.1/0.3))*y_cc(j)*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2)))
             q_prim_vf(momxb + 1)%sf(i, j, 0) = 112.99092883944267*((0.1/0.3))*x_cc(i)*exp(0.5*(1 - sqrt(x_cc(i)**2 + y_cc(j)**2)))
         end if
     case default

src/common/include/3dHardcodedIC.fpp

@@ -177,7 +177,7 @@
         Mach = 0.1
         if (patch_id == 1) then
             q_prim_vf(E_idx)%sf(i, j, &
-                      & k) = 101325 + (Mach**2*376.636429464809**2/16)*(cos(2*x_cc(i)/1) + cos(2*y_cc(j)/1))*(cos(2*z_cc(k)/1) + 2)
+                & k) = 101325 + (Mach**2*376.636429464809**2/16)*(cos(2*x_cc(i)/1) + cos(2*y_cc(j)/1))*(cos(2*z_cc(k)/1) + 2)
             q_prim_vf(momxb + 0)%sf(i, j, k) = Mach*376.636429464809*sin(x_cc(i)/1)*cos(y_cc(j)/1)*sin(z_cc(k)/1)
             q_prim_vf(momxb + 1)%sf(i, j, k) = -Mach*376.636429464809*cos(x_cc(i)/1)*sin(y_cc(j)/1)*sin(z_cc(k)/1)
         end if

src/common/include/macros.fpp

@@ -157,7 +157,7 @@
 #:def ASSERT(predicate, message = None)
     if (.not. (${predicate}$)) then
         call s_mpi_abort("${_FILE_.split('/')[-1]}$:${_LINE_}$: " // "Assertion failed: ${predicate}$. " &
-                         & // ${message or '"No error description."'}$)
+            & // ${message or '"No error description."'}$)
     end if
 #:enddef
 ! New line at end of file is required for FYPP

src/common/m_boundary_common.fpp

@@ -8,15 +8,10 @@
 
 module m_boundary_common
     use m_derived_types        !< Definitions of the derived types
-
     use m_global_parameters    !< Definitions of the global parameters
-
     use m_mpi_proxy
-
     use m_constants
-
     use m_delay_file_access
-
     use m_compile_specific
 
     implicit none
@@ -70,6 +65,7 @@ contains
             end do
         end if
     end subroutine s_initialize_boundary_common_module
+
     !> The purpose of this procedure is to populate the buffers of the primitive variables, depending on the selected boundary
     !! conditions.
     impure subroutine s_populate_variables_buffers(bc_type, q_prim_vf, pb_in, mv_in)
@@ -269,6 +265,7 @@ contains
         #:endif
         ! END: Population of Buffers in z-direction
     end subroutine s_populate_variables_buffers
+
     !> @brief Fills ghost cells by copying the nearest boundary cell value along the specified direction.
     subroutine s_ghost_cell_extrapolation(q_prim_vf, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_ghost_cell_extrapolation', parallelism='[seq]', cray_inline=True)
@@ -321,6 +318,7 @@ contains
             end if
         end if
     end subroutine s_ghost_cell_extrapolation
+
     !> @brief Applies reflective (symmetry) boundary conditions by mirroring primitive variables and flipping the normal velocity
     !! component.
     subroutine s_symmetry(q_prim_vf, bc_dir, bc_loc, k, l, pb_in, mv_in)
@@ -347,7 +345,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(1, i))%sf(-j, k, l) = -q_prim_vf(shear_BC_flip_indices(1, &
-                                      & i))%sf(j - 1, k, l)
+                                & i))%sf(j - 1, k, l)
                         end do
                     end if
 
@@ -381,7 +379,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(1, i))%sf(m + j, k, l) = -q_prim_vf(shear_BC_flip_indices(1, &
-                                      & i))%sf(m - (j - 1), k, l)
+                                & i))%sf(m - (j - 1), k, l)
                         end do
                     end if
 
@@ -416,7 +414,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(2, i))%sf(k, -j, l) = -q_prim_vf(shear_BC_flip_indices(2, i))%sf(k, &
-                                      & j - 1, l)
+                                & j - 1, l)
                         end do
                     end if
 
@@ -450,7 +448,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(2, i))%sf(k, n + j, l) = -q_prim_vf(shear_BC_flip_indices(2, &
-                                      & i))%sf(k, n - (j - 1), l)
+                                & i))%sf(k, n - (j - 1), l)
                         end do
                     end if
 
@@ -486,7 +484,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(3, i))%sf(k, l, -j) = -q_prim_vf(shear_BC_flip_indices(3, i))%sf(k, &
-                                      & l, j - 1)
+                                & l, j - 1)
                         end do
                     end if
 
@@ -520,7 +518,7 @@ contains
                     if (elasticity) then
                         do i = 1, shear_BC_flip_num
                             q_prim_vf(shear_BC_flip_indices(3, i))%sf(k, l, p + j) = -q_prim_vf(shear_BC_flip_indices(3, &
-                                      & i))%sf(k, l, p - (j - 1))
+                                & i))%sf(k, l, p - (j - 1))
                         end do
                     end if
 
@@ -542,6 +540,7 @@ contains
             end if
         end if
     end subroutine s_symmetry
+
     !> @brief Applies periodic boundary conditions by copying values from the opposite domain boundary.
     subroutine s_periodic(q_prim_vf, bc_dir, bc_loc, k, l, pb_in, mv_in)
         $:GPU_ROUTINE(parallelism='[seq]')
@@ -661,6 +660,7 @@ contains
             end if
         end if
     end subroutine s_periodic
+
     !> @brief Applies axis boundary conditions for cylindrical coordinates by reflecting values across the axis with azimuthal phase
     !! shift.
     subroutine s_axis(q_prim_vf, pb_in, mv_in, k, l)
@@ -709,6 +709,7 @@ contains
             end do
         end if
     end subroutine s_axis
+
     !> @brief Applies slip wall boundary conditions by extrapolating scalars and reflecting the wall-normal velocity component.
     subroutine s_slip_wall(q_prim_vf, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_slip_wall',parallelism='[seq]', cray_inline=True)
@@ -785,6 +786,7 @@ contains
             end if
         end if
     end subroutine s_slip_wall
+
     !> @brief Applies no-slip wall boundary conditions by reflecting and negating all velocity components at the wall.
     subroutine s_no_slip_wall(q_prim_vf, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_no_slip_wall',parallelism='[seq]', cray_inline=True)
@@ -886,6 +888,7 @@ contains
             end if
         end if
     end subroutine s_no_slip_wall
+
     !> @brief Applies Dirichlet boundary conditions by prescribing ghost cell values from stored boundary buffers.
     subroutine s_dirichlet(q_prim_vf, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_dirichlet',parallelism='[seq]', cray_inline=True)
@@ -946,6 +949,7 @@ contains
         call s_ghost_cell_extrapolation(q_prim_vf, bc_dir, bc_loc, k, l)
 #endif
     end subroutine s_dirichlet
+
     !> @brief Extrapolates QBMM bubble pressure and mass-vapor variables into ghost cells by copying boundary values.
     subroutine s_qbmm_extrapolation(bc_dir, bc_loc, k, l, pb_in, mv_in)
         $:GPU_ROUTINE(parallelism='[seq]')
@@ -1016,6 +1020,7 @@ contains
             end if
         end if
     end subroutine s_qbmm_extrapolation
+
     !> @brief Populates ghost cell buffers for the color function and its divergence used in capillary surface tension.
     impure subroutine s_populate_capillary_buffers(c_divs, bc_type)
         type(scalar_field), dimension(num_dims + 1), intent(inout)  :: c_divs
@@ -1147,6 +1152,7 @@ contains
             end if
         #:endif
     end subroutine s_populate_capillary_buffers
+
     !> @brief Applies periodic boundary conditions to the color function and its divergence fields.
     subroutine s_color_function_periodic(c_divs, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_color_function_periodic', parallelism='[seq]', cray_inline=True)
@@ -1199,6 +1205,7 @@ contains
             end if
         end if
     end subroutine s_color_function_periodic
+
     !> @brief Applies reflective boundary conditions to the color function and its divergence fields.
     subroutine s_color_function_reflective(c_divs, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_color_function_reflective', parallelism='[seq]', cray_inline=True)
@@ -1275,6 +1282,7 @@ contains
             end if
         end if
     end subroutine s_color_function_reflective
+
     !> @brief Extrapolates the color function and its divergence into ghost cells by copying boundary values.
     subroutine s_color_function_ghost_cell_extrapolation(c_divs, bc_dir, bc_loc, k, l)
         $:GPU_ROUTINE(function_name='s_color_function_ghost_cell_extrapolation', parallelism='[seq]', cray_inline=True)
@@ -1327,6 +1335,7 @@ contains
             end if
         end if
     end subroutine s_color_function_ghost_cell_extrapolation
+
     !> @brief Populates ghost cell buffers for the Jacobian scalar field used in the IGR elliptic solver.
     impure subroutine s_populate_F_igr_buffers(bc_type, jac_sf)
         type(integer_field), dimension(1:num_dims, 1:2), intent(in) :: bc_type
@@ -1491,6 +1500,7 @@ contains
             end if
         #:endif
     end subroutine s_populate_F_igr_buffers
+
     !> @brief Creates MPI derived datatypes for boundary condition type arrays and buffer arrays used in parallel I/O.
     impure subroutine s_create_mpi_types(bc_type)
         type(integer_field), dimension(1:num_dims, 1:2), intent(in) :: bc_type
@@ -1506,7 +1516,7 @@ contains
                 sf_extents_loc = shape(bc_type(dir, loc)%sf)
 
                 call MPI_TYPE_CREATE_SUBARRAY(num_dims, sf_extents_loc, sf_extents_loc, sf_start_idx, MPI_ORDER_FORTRAN, &
-                                              & MPI_INTEGER, MPI_BC_TYPE_TYPE(dir, loc), ierr)
+                    & MPI_INTEGER, MPI_BC_TYPE_TYPE(dir, loc), ierr)
                 call MPI_TYPE_COMMIT(MPI_BC_TYPE_TYPE(dir, loc), ierr)
             end do
         end do
@@ -1517,12 +1527,13 @@ contains
                 sf_extents_loc = shape(bc_buffers(dir, loc)%sf)
 
                 call MPI_TYPE_CREATE_SUBARRAY(num_dims, sf_extents_loc*mpi_io_type, sf_extents_loc*mpi_io_type, sf_start_idx, &
-                                              & MPI_ORDER_FORTRAN, mpi_io_p, MPI_BC_BUFFER_TYPE(dir, loc), ierr)
+                    & MPI_ORDER_FORTRAN, mpi_io_p, MPI_BC_BUFFER_TYPE(dir, loc), ierr)
                 call MPI_TYPE_COMMIT(MPI_BC_BUFFER_TYPE(dir, loc), ierr)
             end do
         end do
 #endif
     end subroutine s_create_mpi_types
+
     !> @brief Writes boundary condition type and buffer data to serial (unformatted) restart files.
     subroutine s_write_serial_boundary_condition_files(q_prim_vf, bc_type, step_dirpath, old_grid_in)
         type(scalar_field), dimension(sys_size), intent(in)         :: q_prim_vf
@@ -1559,6 +1570,7 @@ contains
         end do
         close (1)
     end subroutine s_write_serial_boundary_condition_files
+
     !> @brief Writes boundary condition type and buffer data to per-rank parallel files using MPI I/O.
     subroutine s_write_parallel_boundary_condition_files(q_prim_vf, bc_type)
         type(scalar_field), dimension(sys_size), intent(in)         :: q_prim_vf
@@ -1621,6 +1633,7 @@ contains
         call MPI_File_close(file_id, ierr)
 #endif
     end subroutine s_write_parallel_boundary_condition_files
+
     !> @brief Reads boundary condition type and buffer data from serial (unformatted) restart files.
     subroutine s_read_serial_boundary_condition_files(step_dirpath, bc_type)
         character(LEN=*), intent(in)                                   :: step_dirpath
@@ -1662,6 +1675,7 @@ contains
         end do
         close (1)
     end subroutine s_read_serial_boundary_condition_files
+
     !> @brief Reads boundary condition type and buffer data from per-rank parallel files using MPI I/O.
     subroutine s_read_parallel_boundary_condition_files(bc_type)
         type(integer_field), dimension(1:num_dims, 1:2), intent(inout) :: bc_type
@@ -1724,6 +1738,7 @@ contains
         call MPI_File_close(file_id, ierr)
 #endif
     end subroutine s_read_parallel_boundary_condition_files
+
     !> @brief Packs primitive variable boundary slices into bc_buffers arrays for serialization.
     subroutine s_pack_boundary_condition_buffers(q_prim_vf)
         type(scalar_field), dimension(sys_size), intent(in) :: q_prim_vf
@@ -1764,6 +1779,7 @@ contains
             end if
         #:endif
     end subroutine s_pack_boundary_condition_buffers
+
     !> @brief Initializes the per-cell boundary condition type arrays with the global default BC values.
     subroutine s_assign_default_bc_type(bc_type)
         type(integer_field), dimension(1:num_dims, 1:2), intent(in) :: bc_type
@@ -1787,6 +1803,7 @@ contains
             end if
         #:endif
     end subroutine s_assign_default_bc_type
+
     !> The purpose of this subroutine is to populate the buffers of the grid variables, which are constituted of the cell- boundary
     !! locations and cell-width distributions, based on the boundary conditions.
     subroutine s_populate_grid_variables_buffers
@@ -1971,6 +1988,7 @@ contains
         ! END: Population of Buffers in z-direction
 #endif
     end subroutine s_populate_grid_variables_buffers
+
     !> @brief Deallocates boundary condition buffer arrays allocated during module initialization.
     subroutine s_finalize_boundary_common_module()
         if (bc_io) then

src/common/m_checker_common.fpp

@@ -8,11 +8,8 @@
 !> @brief Shared input validation checks for grid dimensions and AMD GPU compiler limits
 module m_checker_common
     use m_global_parameters    !< Definitions of the global parameters
-
     use m_mpi_proxy            !< Message passing interface (MPI) module proxy
-
     use m_helper_basic         !< Functions to compare floating point numbers
-
     use m_helper
 
     implicit none
@@ -29,6 +26,7 @@ contains
             call s_check_amd
         #:endif
     end subroutine s_check_inputs_common
+
 #ifndef MFC_SIMULATION
 
     !> @brief Verifies that the total number of grid cells meets the minimum required by the number of dimensions and MPI ranks.
@@ -41,6 +39,7 @@ contains
 
         @:PROHIBIT(nGlobal < min_cells, "Total number of cells must be at least (2^[number of dimensions])*num_procs, " // "which is currently "//trim(numStr))
     end subroutine s_check_total_cells
+
 #endif
 
     !> @brief Checks that simulation parameters stay within AMD GPU compiler limits when case optimization is disabled.
@@ -51,6 +50,7 @@ contains
             @:PROHIBIT(chemistry .and. num_species /= 10, "num_species = 10 for AMDFLang when Case optimization is off")
         #:endif
     end subroutine s_check_amd
+
 #ifndef MFC_POST_PROCESS
 #endif
 end module m_checker_common