Condense verbose multi-line comments across codebase

Author: sbryngelson

src/common/include/macros.fpp

@@ -19,10 +19,7 @@
 #ifdef MFC_SIMULATION
 #ifdef __NVCOMPILER_GPU_UNIFIED_MEM
     block
-        ! Beginning in the 25.3 release, the structure of the cudafor module has been changed slightly. The module now includes, or
-        ! "uses" 3 submodules: cuda_runtime_api, gpu_reductions, and sort. The cudafor functionality has not changed. But for new
-        ! users, or users who have needed to work-around name conflicts in the module, it may be better to use cuda_runtime_api to
-        ! expose interfaces to the CUDA runtime calls described in Chapter 4 of this guide.
+        ! NVIDIA CUDA Fortran 25.3+: uses submodules (cuda_runtime_api, gpu_reductions, sort) See
         ! https://docs.nvidia.com/hpc-sdk/compilers/cuda-fortran-prog-guide/index.html#fortran-host-modules
 #if __NVCOMPILER_MAJOR__ < 25 || (__NVCOMPILER_MAJOR__ == 25 && __NVCOMPILER_MINOR__ < 3)
         use cudafor, gpu_sum => sum, gpu_maxval => maxval, gpu_minval => minval

src/common/m_helper_basic.fpp

@@ -125,8 +125,7 @@ contains
         logical, intent(in)                                :: igr
         logical, intent(in)                                :: ib
 
-        ! Determining the number of cells that are needed in order to store sufficient boundary conditions data as to iterate the
-        ! solution in the physical computational domain from one time-step iteration to the next one
+        ! Determine ghost cell buffer size for boundary conditions
 
         if (igr) then
             buff_size = (igr_order - 1)/2 + 2

src/common/m_mpi_common.fpp

@@ -1046,9 +1046,7 @@ contains
                     end do
                 else
                     if (cyl_coord .and. p > 0) then
-                        ! Implement pencil processor blocking if using cylindrical coordinates so that all cells in azimuthal
-                        ! direction are stored on a single processor. This is necessary for efficient application of Fourier filter
-                        ! near axis.
+                        ! Pencil blocking for cylindrical coordinates (Fourier filter near axis)
 
                         ! Initial values of the processor factorization optimization
                         num_procs_x = 1

src/common/m_phase_change.fpp

@@ -144,9 +144,7 @@ contains
                     ! case, MFL cannot be either 0 or 1, so I chose it to be 2
                     call s_infinite_pt_relaxation_k(j, k, l, 2, pS, p_infpT, q_cons_vf, rhoe, TS)
 
-                    ! check if pTg-equilibrium is required NOTE that NOTHING else needs to be updated OTHER than the individual
-                    ! partial densities given the outputs from the pT- and pTg-equilibrium solvers are just p and one of the partial
-                    ! masses (pTg- case)
+                    ! Check if pTg-equilibrium needed; only partial densities require updating
                     if ((relax_model == 6) .and. ((q_cons_vf(lp + contxb - 1)%sf(j, k, &
                         & l) > mixM*rM) .and. (q_cons_vf(vp + contxb - 1)%sf(j, k, &
                         & l) > mixM*rM)) .and. (pS < pCr) .and. (TS < TCr)) then
@@ -567,8 +565,7 @@ contains
             end if
         end if
 
-        ! Defining the correction in terms of an absolute value might not be the best practice. Maybe a good way to do this is to
-        ! partition the partial densities, giving a small percentage of the total reacting density
+        ! TODO: Consider partitioning partial densities instead of absolute-value correction
         MCT = 2*mixM
 
         ! correcting the partial densities of the reacting fluids. What to do for the nonreacting ones?

src/common/m_variables_conversion.fpp

@@ -300,9 +300,7 @@ contains
         real(wp)                            :: alpha_K_sum
         integer                             :: i, j !< Generic loop iterators
 #ifdef MFC_SIMULATION
-        ! Constraining the partial densities and the volume fractions within their physical bounds to make sure that any mixture
-        ! variables that are derived from them result within the limits that are set by the fluids physical parameters that make up
-        ! the mixture
+        ! Constrain partial densities and volume fractions within physical bounds
         if (num_fluids == 1 .and. bubbles_euler) then
             rho_K = alpha_rho_K(1)
             gamma_K = gammas(1)

src/post_process/m_data_output.fpp

@@ -22,13 +22,10 @@ module m_data_output
         & s_write_energy_data_file, s_close_formatted_database_file, s_close_intf_data_file, s_close_energy_data_file, &
         & s_finalize_data_output_module
 
-    ! Including the Silo Fortran interface library that features the subroutines and parameters that are required to write in the
-    ! Silo-HDF5 database format INCLUDE 'silo.inc'
+    ! Include Silo-HDF5 interface library
     include 'silo_f9x.inc'
 
-    ! Generic storage for flow variable(s) that are to be written to formatted database file(s). Note that for 1D simulations,
-    ! q_root_sf is employed to gather the flow variable(s) from all sub-domains on to the root process. If the run is not parallel,
-    ! but serial, then q_root_sf is equal to q_sf.
+    ! Flow variable storage; q_root_sf gathers to rank 0 in 1D parallel runs
     real(wp), allocatable, dimension(:,:,:), public :: q_sf
     real(wp), allocatable, dimension(:,:,:)         :: q_root_sf
     real(wp), allocatable, dimension(:,:,:)         :: cyl_q_sf
@@ -38,20 +35,15 @@ module m_data_output
     real(sp), allocatable, dimension(:,:,:)         :: q_root_sf_s
     real(sp), allocatable, dimension(:,:,:)         :: cyl_q_sf_s
 
-    ! The spatial and data extents array variables contain information about the minimum and maximum values of the grid and flow
-    ! variable(s), respectively. The purpose of bookkeeping this information is to boost the visualization of the Silo-HDF5 database
-    ! file(s) in VisIt.
+    ! Spatial and data extents for VisIt visualization
     real(wp), allocatable, dimension(:,:) :: spatial_extents
     real(wp), allocatable, dimension(:,:) :: data_extents
 
-    ! The size of the ghost zone layer at beginning of each coordinate direction (lo) and at end of each coordinate direction (hi).
-    ! Adding this information to Silo-HDF5 database file(s) is recommended since it supplies VisIt with connectivity information
-    ! between the sub-domains of a parallel data set.
+    ! Ghost zone layer sizes (lo/hi) for subdomain connectivity in VisIt
     integer, allocatable, dimension(:) :: lo_offset
     integer, allocatable, dimension(:) :: hi_offset
 
-    ! For Silo-HDF5 database format, this variable is used to keep track of the number of cell-boundaries, for the grid associated
-    ! with the local process, in each of the active coordinate directions.
+    ! Track cell-boundary count per active coordinate direction
     integer, allocatable, dimension(:) :: dims
 
     ! Locations of various folders in the case's directory tree, associated with the choice of the formatted database format. These
@@ -404,11 +396,7 @@ contains
     !> @brief Open (or create) the Silo-HDF5 or Binary formatted database slave and master files for a given time step.
     impure subroutine s_open_formatted_database_file(t_step)
 
-        ! Description: This subroutine opens a new formatted database file, or replaces an old one, and readies it for the data
-        ! storage of the grid and the flow variable(s) associated with the current time-step, t_step. This is performed by all the
-        ! local process(es). The root processor, in addition, must also generate a master formatted database file whose job will be
-        ! to link, and thus combine, the data from all of the local process(es). Note that for the Binary format, this extra task
-        ! that is assigned to the root process is not performed in multidimensions.
+        ! Open/create DB file for current time-step; rank 0 creates master file (Silo only)
 
         ! Time-step that is currently being post-processed
         integer, intent(in) :: t_step

src/post_process/m_derived_variables.fpp

@@ -42,16 +42,12 @@ contains
     !> Computation of parameters, allocation procedures, and/or any other tasks needed to properly setup the module
     impure subroutine s_initialize_derived_variables_module
 
-        ! Allocating the gradient magnitude of the density variable provided that numerical Schlieren function is outputted during
-        ! post-process
+        ! Allocate density gradient magnitude if Schlieren output requested
         if (schlieren_wrt) then
             allocate (gm_rho_sf(-offset_x%beg:m + offset_x%end, -offset_y%beg:n + offset_y%end, -offset_z%beg:p + offset_z%end))
         end if
 
-        ! Allocating the variables which will store the coefficients of the centered family of finite-difference schemes. Note that
-        ! sufficient space is allocated so that the coefficients up to any chosen order of accuracy may be bookkept. However, if
-        ! higher than fourth-order accuracy coefficients are wanted, the formulae required to compute these coefficients will have
-        ! to be implemented in the subroutine s_compute_finite_difference_coefficients.
+        ! Allocate FD coefficients (up to 4th order; higher orders need extension)
 
         ! Allocating centered finite-difference coefficients in x-direction
         if (omega_wrt(2) .or. omega_wrt(3) .or. schlieren_wrt .or. liutex_wrt) then
@@ -68,8 +64,7 @@ contains
             allocate (fd_coeff_z(-fd_number:fd_number, -offset_z%beg:p + offset_z%end))
         end if
 
-        ! Annotating the dimensionality of the dataset undergoing the post- process. A flag value of 1 indicates that the dataset is
-        ! 3D, while a flag value of 0 indicates that it is not.
+        ! Set flg=1 if 3D, else 0
         if (p > 0) then
             flg = 1
         else
@@ -136,8 +131,7 @@ contains
         ! Fluid bulk modulus for alternate sound speed
         real(wp) :: blkmod1, blkmod2
 
-        ! Computing speed of sound values from those of pressure, density, specific heat ratio function and the liquid stiffness
-        ! function
+        ! Compute speed of sound from pressure, density, gamma, liquid stiffness
         do k = -offset_z%beg, p + offset_z%end
             do j = -offset_y%beg, n + offset_y%end
                 do i = -offset_x%beg, m + offset_x%end
@@ -582,17 +576,13 @@ contains
             end do
         end if
 
-        ! Up until now, only the dot product of the gradient of the density field has been calculated and stored in the gradient
-        ! magnitude of density variable. So now we proceed to take the square-root as to complete the desired calculation.
+        ! Finalize Schlieren: take sqrt of accumulated dot product
         gm_rho_sf = sqrt(gm_rho_sf)
 
-        ! Determining the local maximum of the gradient magnitude of density and bookkeeping the result, along with rank of the
-        ! local processor
+        ! Find local max of density gradient magnitude with processor rank
         gm_rho_max = (/maxval(gm_rho_sf), real(proc_rank, wp)/)
 
-        ! Comparing the local maximum gradient magnitude of the density on this processor to the those computed on the remaining
-        ! processors. This allows for the global maximum to be computed and the rank of the processor on which it has occurred to be
-        ! recorded.
+        ! Compute global max density gradient across all processors
         if (num_procs > 1) call s_mpi_reduce_maxloc(gm_rho_max)
 
         ! Computing Numerical Schlieren Function

src/post_process/m_global_parameters.fpp

@@ -82,8 +82,7 @@ module m_global_parameters
     integer  :: n_start
     !> @}
 
-    ! NOTE: The variables m_root, x_root_cb and x_root_cc contain the grid data of the defragmented computational domain. They are
-    ! only used in 1D. For serial simulations, they are equal to m, x_cb and x_cc, respectively.
+    ! NOTE: m_root, x_root_cb, x_root_cc = defragmented grid (1D only; equals m, x_cb, x_cc in serial)
 
     !> @name Simulation Algorithm Parameters
     !> @{
@@ -138,8 +137,7 @@ module m_global_parameters
     ! Cell Indices for the (local) interior points (O-m, O-n, 0-p). Stands for "InDices With BUFFer".
     type(int_bounds_info) :: idwint(1:3)
 
-    ! Cell Indices for the entire (local) domain. In simulation, this includes the buffer region. idwbuff and idwint are the same
-    ! otherwise. Stands for "InDices With BUFFer".
+    ! Cell indices (InDices With BUFFer): includes buffer in simulation only
     type(int_bounds_info) :: idwbuff(1:3)
     integer               :: num_bc_patches
     logical               :: bc_io

src/post_process/p_main.fpp

@@ -61,9 +61,7 @@ program p_main
                 exit
             end if
         else
-            ! Modifies the time-step iterator so that it may reach the final time- step to be post-processed, in the case that this
-            ! one is not originally attainable through constant incrementation from the first time-step. This modification is
-            ! performed upon reaching the final time-step. In case that it is not needed, the post-processor is done and may exit.
+            ! Adjust time-step iterator to reach final step if needed, else exit
             if ((t_step_stop - t_step) < t_step_save .and. t_step_stop /= t_step) then
                 t_step = t_step_stop - t_step_save
             else if (t_step == t_step_stop) then

src/pre_process/m_assign_variables.fpp

@@ -66,8 +66,7 @@ contains
             allocate (alf_sum%sf(0:m, 0:n, 0:p))
         end if
 
-        ! Depending on multicomponent flow model, the appropriate procedure for assignment of the patch mixture or species primitive
-        ! variables to a cell in the domain is targeted by the procedure pointer
+        ! Select procedure pointer based on multicomponent flow model
 
         if (model_eqns == 1) then ! Gamma/pi_inf model
             s_assign_patch_primitive_variables => s_assign_patch_mixture_primitive_variables
@@ -258,8 +257,7 @@ contains
 #endif
         type(scalar_field), dimension(1:sys_size), intent(inout) :: q_prim_vf
 
-        ! Density, the specific heat ratio function and the liquid stiffness function, respectively, obtained from the combination
-        ! of primitive variables of the current and smoothing patches
+        ! Density, gamma, and liquid stiffness from current and smoothing patches
         real(wp)                       :: rho          !< density
         real(wp)                       :: gamma
         real(wp)                       :: lit_gamma    !< specific heat ratio
@@ -621,8 +619,7 @@ contains
     !> @brief Nullifies the patch primitive variable assignment procedure pointer.
     impure subroutine s_finalize_assign_variables_module
 
-        ! Nullifying procedure pointer to the subroutine assigning either the patch mixture or species primitive variables to a cell
-        ! in the computational domain
+        ! Nullify primitive variable assignment procedure pointer
         s_assign_patch_primitive_variables => null()
 
     end subroutine s_finalize_assign_variables_module