comment cleanup

Author: sbryngelson

src/common/m_boundary_common.fpp

@@ -1,10 +1,10 @@
 !>
 !! @file
-!! @brief Contains module m_global_parameters
+!! Contains module m_global_parameters
 
 #:include 'case.fpp'
 
-!> @brief Defines global parameters for the computational domain, simulation algorithm, and initial conditions
+!> Defines global parameters for the computational domain, simulation algorithm, and initial conditions
 module m_global_parameters
 
 #ifdef MFC_MPI
@@ -113,13 +113,8 @@ module m_global_parameters
     ! idwint are the same otherwise. Stands for "InDices With BUFFer".
     type(int_bounds_info) :: idwbuff(1:3)
 
-    !> The order of the finite-difference (fd) approximations of the first-order derivatives that need to be evaluated when the CoM
-    !! or flow probe data files are to be written at each time step
-    integer :: fd_order
-
-    !> The finite-difference number is given by MAX(1, fd_order/2). Essentially, it is a measure of the half-size of the
-    !! finite-difference stencil for the selected order of accuracy.
-    integer :: fd_number
+    integer :: fd_order   !< Finite-difference order for CoM/probe derivative approximations
+    integer :: fd_number  !< FD half-stencil size: MAX(1, fd_order/2)
 
     !> @name lagrangian subgrid bubble parameters
     !> @{!
@@ -130,8 +125,6 @@ module m_global_parameters
     integer               :: shear_num          !< Number of shear stress components
     integer, dimension(3) :: shear_indices      !< Indices of the stress components that represent shear stress
     integer               :: shear_BC_flip_num  !< Number of shear stress components to reflect for boundary conditions
-    !> Indices of shear stress components to reflect for boundary conditions. Size: (1:3, 1:shear_BC_flip_num) for (x/y/z,
-    !! [indices])
     integer, dimension(3, 2) :: shear_BC_flip_indices  !< Shear stress BC reflection indices (1:3, 1:shear_BC_flip_num)
     logical                  :: parallel_io            !< Format of the data files
     logical                  :: file_per_process       !< type of data output
@@ -141,8 +134,6 @@ module m_global_parameters
     real(wp)                 :: mixlayer_vel_coef      !< Coefficient for the hyperbolic tangent streamwise velocity profile
     logical                  :: mixlayer_perturb       !< Superimpose instability waves to surrounding fluid flow
     integer                  :: mixlayer_perturb_nk    !< Number of Fourier modes for perturbation with mixlayer_perturb flag
-    !> Peak wavenumber of prescribed energy spectra with mixlayer_perturb flag Default value (k0 = 0.4446) is most unstable mode
-    !! obtained from linear stability analysis See Michalke (1964, JFM) for details
     real(wp)                   :: mixlayer_perturb_k0  !< Peak wavenumber for mixlayer perturbation (default: most unstable mode)
     logical                    :: simplex_perturb
     type(simplex_noise_params) :: simplex_params
@@ -161,8 +152,7 @@ module m_global_parameters
     integer                                :: elliptic_smoothing_iters
     integer, allocatable, dimension(:)     :: proc_coords         !< Processor coordinates in MPI_CART_COMM
     type(int_bounds_info), dimension(3)    :: nidx
-    integer, allocatable, dimension(:,:,:) :: neighbor_ranks
-    !! Neighbor ranks
+    integer, allocatable, dimension(:,:,:) :: neighbor_ranks  !< Neighbor ranks
 
     integer, allocatable, dimension(:) :: start_idx  !< Starting cell-center index of local processor in global grid
 
@@ -175,19 +165,11 @@ module m_global_parameters
     ! Initial Condition Parameters
     integer :: num_patches  !< Number of patches composing initial condition
 
-    !> Database of the initial condition patch parameters (icpp) for each of the patches employed in the configuration of the
-    !! initial condition. Note that the maximum allowable number of patches, num_patches_max, may be changed in the module
-    !! m_derived_types.f90.
     type(ic_patch_parameters), dimension(num_patches_max) :: patch_icpp      !< IC patch parameters (max: num_patches_max)
     integer                                               :: num_bc_patches  !< Number of boundary condition patches
     logical                                               :: bc_io           !< whether or not to save BC data
-    !> Boundary condition patch parameters Database of the boundary condition patch parameters for each of the patches employed in
-    !! the configuration of the boundary conditions
-    type(bc_patch_parameters), dimension(num_bc_patches_max) :: patch_bc
+    type(bc_patch_parameters), dimension(num_bc_patches_max) :: patch_bc  !< BC patch parameters
 
-    ! Fluids Physical Parameters
-    !> Database of the physical parameters of each of the fluids that is present in the flow. These include the stiffened gas
-    !! equation of state parameters, and the Reynolds numbers.
     type(physical_parameters), dimension(num_fluids_max) :: fluid_pp  !< Stiffened gas EOS parameters and Reynolds numbers per fluid
 
     ! Subgrid Bubble Parameters
@@ -213,9 +195,7 @@ module m_global_parameters
     integer                                               :: Np
     type(ib_patch_parameters), dimension(num_patches_max) :: patch_ib  !< Immersed boundary patch parameters
     type(vec3_dt), allocatable, dimension(:)              :: airfoil_grid_u, airfoil_grid_l
-    !! Database of the immersed boundary patch parameters for each of the patches employed in the configuration of the initial
-    !! condition. Note that the maximum allowable number of patches, num_patches_max, may be changed in the module
-    !! m_derived_types.f90.
+    ! IB patch parameters database (max count: num_patches_max in m_derived_types.f90).
     !> @}
 
     !> @name Non-polytropic bubble gas compression
@@ -255,12 +235,8 @@ module m_global_parameters
     type(pres_field)                       :: mv
     real(wp)                               :: Bx0  !< Constant magnetic field in the x-direction (1D)
 
-    !> The number of cells that are necessary to be able to store enough boundary conditions data to march the solution in the
-    !! physical computational domain to the next time-step.
     integer :: buff_size  !< Number of ghost cells for boundary condition storage
     logical :: fft_wrt
-    !> AMDFlang workaround: keep a dummy logical to avoid a compiler case-optimization bug when a parameter+GPU-kernel conditional
-    !! is false
     logical :: dummy  !< AMDFlang workaround for case-optimization + GPU-kernel bug
 
     ! Variables for hardcoded initial conditions that are read from input files
@@ -269,8 +245,7 @@ module m_global_parameters
 
 contains
 
-    !> Assigns default values to user inputs prior to reading them in. This allows for an easier consistency check of these
-    !! parameters once they are read from the input file.
+    !> Assigns default values to user inputs prior to reading them in.
     impure subroutine s_assign_default_values_to_user_inputs
 
         integer :: i  !< Generic loop operator
@@ -944,7 +919,7 @@ contains
 
     end subroutine s_initialize_global_parameters_module
 
-    !> @brief Configures MPI parallel I/O settings and allocates processor coordinate arrays.
+    !> Configures MPI parallel I/O settings and allocates processor coordinate arrays.
     impure subroutine s_initialize_parallel_io
 
 #ifdef MFC_MPI
@@ -978,7 +953,7 @@ contains
 
     end subroutine s_initialize_parallel_io
 
-    !> @brief Deallocates all global grid, index, and equation-of-state parameter arrays.
+    !> Deallocates all global grid, index, and equation-of-state parameter arrays.
     impure subroutine s_finalize_global_parameters_module
 
         integer :: i