More work into marking subroutines as pure or impure

Author: prathi-wind

src/common/m_boundary_common.fpp

@@ -42,7 +42,7 @@ module m_boundary_common
 
 contains
 
-    subroutine s_initialize_boundary_common_module()
+    impure subroutine s_initialize_boundary_common_module()
 
         bcxb = bc_x%beg; bcxe = bc_x%end; bcyb = bc_y%beg; bcye = bc_y%end; bczb = bc_z%beg; bcze = bc_z%end
 
@@ -71,7 +71,7 @@ contains
     !>  The purpose of this procedure is to populate the buffers
     !!      of the primitive variables, depending on the selected
     !!      boundary conditions.
-    subroutine s_populate_variables_buffers(q_prim_vf, pb, mv, bc_type)
+    impure subroutine s_populate_variables_buffers(q_prim_vf, pb, mv, bc_type)
 
         type(scalar_field), dimension(sys_size), intent(inout) :: q_prim_vf
         real(wp), dimension(idwbuff(1)%beg:, idwbuff(2)%beg:, idwbuff(3)%beg:, 1:, 1:), intent(inout) :: pb, mv
@@ -238,7 +238,7 @@ contains
 
     end subroutine s_populate_variables_buffers
 
-    subroutine s_ghost_cell_extrapolation(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_ghost_cell_extrapolation(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_ghost_cell_extrapolation
 #else
@@ -307,7 +307,7 @@ contains
 
     end subroutine s_ghost_cell_extrapolation
 
-    subroutine s_symmetry(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_symmetry(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_symmetry
 #else
@@ -571,7 +571,7 @@ contains
 
     end subroutine s_symmetry
 
-    subroutine s_periodic(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_periodic(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_periodic
 #else
@@ -714,7 +714,7 @@ contains
 
     end subroutine s_periodic
 
-    subroutine s_axis(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_axis(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_axis
 #else
@@ -778,7 +778,7 @@ contains
 
     end subroutine s_axis
 
-    subroutine s_slip_wall(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_slip_wall(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_slip_wall
 #else
@@ -877,7 +877,7 @@ contains
 
     end subroutine s_slip_wall
 
-    subroutine s_no_slip_wall(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_no_slip_wall(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_no_slip_wall
 #else
@@ -1012,7 +1012,7 @@ contains
 
     end subroutine s_no_slip_wall
 
-    subroutine s_dirichlet(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_dirichlet(q_prim_vf, pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_dirichlet
 #else
@@ -1081,7 +1081,7 @@ contains
 
     end subroutine s_dirichlet
 
-    subroutine s_qbmm_extrapolation(pb, mv, bc_dir, bc_loc, k, l)
+    pure subroutine s_qbmm_extrapolation(pb, mv, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_qbmm_extrapolation
 #else
@@ -1157,7 +1157,7 @@ contains
 
     end subroutine s_qbmm_extrapolation
 
-    subroutine s_populate_capillary_buffers(c_divs, bc_type)
+    impure subroutine s_populate_capillary_buffers(c_divs, bc_type)
 
         type(scalar_field), dimension(num_dims + 1), intent(inout) :: c_divs
         type(integer_field), dimension(1:num_dims, -1:1), intent(in) :: bc_type
@@ -1280,7 +1280,7 @@ contains
         end if
     end subroutine s_populate_capillary_buffers
 
-    subroutine s_color_function_periodic(c_divs, bc_dir, bc_loc, k, l)
+    pure subroutine s_color_function_periodic(c_divs, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_color_function_periodic
 #else
@@ -1338,7 +1338,7 @@ contains
 
     end subroutine s_color_function_periodic
 
-    subroutine s_color_function_reflective(c_divs, bc_dir, bc_loc, k, l)
+    pure subroutine s_color_function_reflective(c_divs, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_color_function_reflective
 #else
@@ -1420,7 +1420,7 @@ contains
 
     end subroutine s_color_function_reflective
 
-    subroutine s_color_function_ghost_cell_extrapolation(c_divs, bc_dir, bc_loc, k, l)
+    pure subroutine s_color_function_ghost_cell_extrapolation(c_divs, bc_dir, bc_loc, k, l)
 #ifdef _CRAYFTN
         !DIR$ INLINEALWAYS s_color_function_ghost_cell_extrapolation
 #else
@@ -1478,7 +1478,7 @@ contains
 
     end subroutine s_color_function_ghost_cell_extrapolation
 
-    subroutine s_create_mpi_types(bc_type)
+    impure subroutine s_create_mpi_types(bc_type)
 
         type(integer_field), dimension(1:num_dims, -1:1) :: bc_type
 
@@ -1511,7 +1511,7 @@ contains
 #endif
     end subroutine s_create_mpi_types
 
-    subroutine s_finalize_boundary_common_module()
+    impure subroutine s_finalize_boundary_common_module()
 
 #ifndef MFC_POST_PROCESS
         if (bc_io) then

src/common/m_checker_common.fpp

@@ -24,7 +24,7 @@ contains
 
     !> Checks compatibility of parameters in the input file.
         !! Used by all three stages
-    subroutine s_check_inputs_common
+    impure subroutine s_check_inputs_common
 
 #ifndef MFC_PRE_PROCESS
         call s_check_inputs_time_stepping
@@ -60,7 +60,7 @@ contains
 
     !> Checks constraints on the time-stepping parameters.
         !! Called by s_check_inputs_common for simulation and post-processing
-    subroutine s_check_inputs_time_stepping
+    impure subroutine s_check_inputs_time_stepping
         if (cfl_dt) then
             @:PROHIBIT(cfl_target < 0 .or. cfl_target > 1._wp)
             @:PROHIBIT(t_stop <= 0)
@@ -76,7 +76,7 @@ contains
 
     !> Checks constraints on the finite difference parameters.
         !! Called by s_check_inputs_common for simulation and post-processing
-    subroutine s_check_inputs_finite_difference
+    impure subroutine s_check_inputs_finite_difference
         @:PROHIBIT(all(fd_order /= (/dflt_int, 1, 2, 4/)), "fd_order must be 1, 2, or 4")
     end subroutine s_check_inputs_finite_difference
 
@@ -85,7 +85,7 @@ contains
 #ifndef MFC_SIMULATION
 
     ! Checks constraints on the total number of cells
-    subroutine s_check_total_cells
+    impure subroutine s_check_total_cells
         character(len=5) :: numStr !< for int to string conversion
 
         call s_int_to_str(2**(min(1, m) + min(1, n) + min(1, p))*num_procs, numStr)
@@ -100,7 +100,7 @@ contains
 
     !> Checks constraints on the bubble parameters.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_bubbles_euler
+    impure subroutine s_check_inputs_bubbles_euler
         @:PROHIBIT(bubbles_euler .and. nb < 1, "The Ensemble-Averaged Bubble Model requires nb >= 1")
         @:PROHIBIT(bubbles_euler .and. polydisperse .and. (nb == 1), "Polydisperse bubble dynamics requires nb > 1")
         @:PROHIBIT(bubbles_euler .and. polydisperse .and. (mod(nb, 2) == 0), "nb must be odd")
@@ -117,7 +117,7 @@ contains
 
     !> Checks constraints on the QBMM and polydisperse bubble parameters.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_qbmm_and_polydisperse
+    impure subroutine s_check_inputs_qbmm_and_polydisperse
         @:PROHIBIT(polydisperse .and. (.not. bubbles_euler), "Polydisperse bubble modeling requires the bubbles_euler flag to be set")
         @:PROHIBIT(polydisperse .and. f_is_default(poly_sigma), "Polydisperse bubble modeling requires poly_sigma to be set")
         @:PROHIBIT(polydisperse .and. poly_sigma <= 0)
@@ -127,15 +127,15 @@ contains
 
     !> Checks constraints on the adv_n flag.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_adv_n
+    impure subroutine s_check_inputs_adv_n
         @:PROHIBIT(adv_n .and. (.not. bubbles_euler))
         @:PROHIBIT(adv_n .and. num_fluids /= 1)
         @:PROHIBIT(adv_n .and. qbmm)
     end subroutine s_check_inputs_adv_n
 
     !> Checks constraints on the hypoelasticity parameters.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_hypoelasticity
+    impure subroutine s_check_inputs_hypoelasticity
         @:PROHIBIT(hypoelasticity .and. model_eqns /= 2)
 #ifdef MFC_SIMULATION
         @:PROHIBIT(elasticity .and. fd_order /= 4)
@@ -144,7 +144,7 @@ contains
 
     !> Checks constraints on the hyperelasticity parameters.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_hyperelasticity
+    impure subroutine s_check_inputs_hyperelasticity
         @:PROHIBIT(hyperelasticity .and. model_eqns == 1)
         @:PROHIBIT(hyperelasticity .and. model_eqns > 3)
 #ifdef MFC_SIMULATION
@@ -154,7 +154,7 @@ contains
 
     !> Checks constraints on the phase change parameters.
         !! Called by s_check_inputs_common for pre-processing and simulation
-    subroutine s_check_inputs_phase_change
+    impure subroutine s_check_inputs_phase_change
         @:PROHIBIT(relax .and. model_eqns /= 3, "phase change requires model_eqns = 3")
         @:PROHIBIT(relax .and. relax_model < 0, "relax_model must be in between 0 and 6")
         @:PROHIBIT(relax .and. relax_model > 6, "relax_model must be in between 0 and 6")
@@ -180,7 +180,7 @@ contains
 
     !> Checks constraints on dimensionality and the number of cells for the grid.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_simulation_domain
+    impure subroutine s_check_inputs_simulation_domain
         @:PROHIBIT(m == dflt_int, "m must be set")
         @:PROHIBIT(n == dflt_int, "n must be set")
         @:PROHIBIT(p == dflt_int, "p must be set")
@@ -193,7 +193,7 @@ contains
 
     !> Checks constraints on model equations and number of fluids in the flow.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_model_eqns_and_num_fluids
+    impure subroutine s_check_inputs_model_eqns_and_num_fluids
         @:PROHIBIT(all(model_eqns /= (/1, 2, 3, 4/)), "model_eqns must be 1, 2, 3, or 4")
         @:PROHIBIT(num_fluids /= dflt_int .and. num_fluids < 1, "num_fluids must be positive")
         @:PROHIBIT(model_eqns == 1 .and. num_fluids /= dflt_int, "num_fluids is not supported for model_eqns = 1")
@@ -207,7 +207,7 @@ contains
 
     !> Checks constraints regarding WENO order.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_weno
+    impure subroutine s_check_inputs_weno
         @:PROHIBIT(all(weno_order /= (/1, 3, 5, 7/)), "weno_order must be 1, 3, 5, or 7")
         @:PROHIBIT(m + 1 < weno_order, "m must be at least weno_order - 1")
         @:PROHIBIT(n > 0 .and. n + 1 < weno_order, "n must be at least weno_order - 1")
@@ -216,7 +216,7 @@ contains
 
     !> Checks constraints on the boundary conditions in the x-direction.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_bc
+    impure subroutine s_check_inputs_bc
         logical :: skip_check !< Flag to skip the check when iterating over
         !! x, y, and z directions, for special treatment of cylindrical coordinates
 
@@ -278,7 +278,7 @@ contains
 
     !> Checks constraints on the stiffened equation of state fluids parameters.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_stiffened_eos
+    impure subroutine s_check_inputs_stiffened_eos
         character(len=5) :: iStr !< for int to string conversion
         integer :: bub_fac !< For allowing an extra fluid_pp if there are subgrid bubbles_euler
         integer :: i
@@ -315,7 +315,7 @@ contains
 
     !> Checks constraints on the surface tension parameters.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_surface_tension
+    impure subroutine s_check_inputs_surface_tension
 
         integer :: i
 
@@ -345,7 +345,7 @@ contains
 
     !> Checks constraints on the inputs for moving boundaries.
         !! Called by s_check_inputs_common for all three stages
-    subroutine s_check_inputs_moving_bc
+    impure subroutine s_check_inputs_moving_bc
         #:for X, VB2, VB3 in [('x', 'vb2', 'vb3'), ('y', 'vb3', 'vb1'), ('z', 'vb1', 'vb2')]
             if (any((/bc_${X}$%vb1, bc_${X}$%vb2, bc_${X}$%vb3/) /= 0._wp)) then
                 if (bc_${X}$%beg == BC_SLIP_WALL) then
@@ -377,7 +377,7 @@ contains
         #:endfor
     end subroutine s_check_inputs_moving_bc
 
-    subroutine s_check_inputs_mhd
+    impure subroutine s_check_inputs_mhd
         @:PROHIBIT(mhd .and. num_fluids /= 1, "MHD is only available for single-component flows")
         @:PROHIBIT(mhd .and. model_eqns /= 2, "MHD is only available for the 5-equation model")
 

src/common/m_compile_specific.f90

@@ -14,7 +14,7 @@ module m_compile_specific
 
     !>  Creates a directory and all its parents if it does not exist
         !!  @param dir_name Directory path
-    subroutine s_create_directory(dir_name)
+    impure subroutine s_create_directory(dir_name)
         character(LEN=*), intent(in) :: dir_name
 
 #ifdef _WIN32
@@ -25,7 +25,7 @@ subroutine s_create_directory(dir_name)
 
     end subroutine s_create_directory
 
-    subroutine s_delete_file(filepath)
+    impure subroutine s_delete_file(filepath)
         character(LEN=*), intent(in) :: filepath
 
 #ifdef _WIN32
@@ -36,7 +36,7 @@ subroutine s_delete_file(filepath)
 
     end subroutine s_delete_file
 
-    subroutine s_delete_directory(dir_name)
+    impure subroutine s_delete_directory(dir_name)
         character(LEN=*), intent(in) :: dir_name
 
 #ifdef _WIN32
@@ -50,7 +50,7 @@ end subroutine s_delete_directory
     !>  Inquires on the existence of a directory
         !!  @param fileloc File directory location
         !!  @param dircheck Switch that indicates if directory exists
-    subroutine my_inquire(fileloc, dircheck)
+    impure subroutine my_inquire(fileloc, dircheck)
         character(LEN=*), intent(in) :: fileloc
         logical, intent(inout) :: dircheck
 
@@ -62,13 +62,13 @@ subroutine my_inquire(fileloc, dircheck)
 
     end subroutine my_inquire
 
-    subroutine s_get_cwd(cwd)
+    impure subroutine s_get_cwd(cwd)
         character(LEN=*), intent(out) :: cwd
 
         call GETCWD(cwd)
     end subroutine s_get_cwd
 
-    subroutine s_get_basename(dirpath, basename)
+    impure subroutine s_get_basename(dirpath, basename)
         character(LEN=*), intent(in) :: dirpath
         character(LEN=*), intent(out) :: basename
 

src/common/m_delay_file_access.f90

@@ -11,7 +11,7 @@ module m_delay_file_access
 
 contains
 
-    subroutine DelayFileAccess(ProcessRank)
+    impure subroutine DelayFileAccess(ProcessRank)
         integer, intent(in) :: ProcessRank
 
         integer :: iDelay, nFileAccessDelayIterations