Skip to content

Fix incorrect and misleading comments across src/ #1624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
BakaOverflow wants to merge 1 commit into
base: master
Choose a base branch
from
+10 −11
Draft

Fix incorrect and misleading comments across src/ #1624

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/common/m_derived_types.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,8 +303,8 @@ module m_derived_types
real(wp), dimension(6) :: tau_e !< Elastic stresses added to primitive variables if hypoelasticity = True
real(wp) :: R0 !< Bubble size
real(wp) :: V0 !< Bubble velocity
real(wp) :: p0 !< Bubble size
real(wp) :: m0 !< Bubble velocity
real(wp) :: p0 !< Bubble pressure
real(wp) :: m0 !< Bubble mass
integer :: hcid !< Hardcoded initial condition ID
real(wp) :: cf_val !< Color function value
real(wp) :: Y(1:num_species) !< Species mass fractions
Expand Down
4 changes: 2 additions & 2 deletions src/common/m_helper.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ contains
elemental function double_factorial(n_in) result(R_result)

integer, intent(in) :: n_in
integer, parameter :: int64_kind = selected_int_kind(18) !< 18 bytes for 64-bit integer
integer, parameter :: int64_kind = selected_int_kind(18) !< kind holding >= 18 decimal digits (64-bit integer)
integer(kind=int64_kind) :: R_result
integer :: i

Expand All @@ -533,7 +533,7 @@ contains
elemental function factorial(n_in) result(R_result)

integer, intent(in) :: n_in
integer, parameter :: int64_kind = selected_int_kind(18) !< 18 bytes for 64-bit integer
integer, parameter :: int64_kind = selected_int_kind(18) !< kind holding >= 18 decimal digits (64-bit integer)
integer(kind=int64_kind) :: R_result
integer :: i

Expand Down
3 changes: 1 addition & 2 deletions src/common/m_mpi_common.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ contains
impure subroutine s_initialize_mpi_common_module

#ifdef MFC_MPI
! Allocating buff_send/recv and. Please note that for the sake of simplicity, both variables are provided sufficient storage
! Allocating buff_send/recv. Please note that for the sake of simplicity, both variables are provided sufficient storage
! to hold the largest buffer in the computational domain.

if (qbmm .and. .not. polytropic) then
Expand Down Expand Up @@ -426,7 +426,6 @@ contains
end subroutine s_mpi_reduce_min

!> Reduce a 2-element variable to its global maximum value with the owning processor rank (MPI_MAXLOC).
!> Reduce a local value to its global maximum with location (rank) across all ranks
impure subroutine s_mpi_reduce_maxloc(var_loc)

real(wp), dimension(2), intent(inout) :: var_loc
Expand Down
2 changes: 1 addition & 1 deletion src/common/m_precision_select.f90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ module m_precision_select
implicit none

! Define the available precision types
integer, parameter :: half_precision = 2 !< selected_real_kind(3, 4)
integer, parameter :: half_precision = 2 !< hardcoded half-precision kind (approx. selected_real_kind(3, 4))
integer, parameter :: single_precision = selected_real_kind(6, 37)
integer, parameter :: double_precision = selected_real_kind(15, 307)
integer, parameter :: hp = half_precision
Expand Down
4 changes: 2 additions & 2 deletions src/simulation/m_collisions.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@

#:include 'macros.fpp'

!> @brief Ghost-node immersed boundary method: locates ghost/image points, computes interpolation coefficients, and corrects the
!! flow state
!> @brief Immersed-boundary collision handling: detects IB-IB and IB-wall contacts and applies soft-sphere collision forces and
!! torques
module m_collisions

use m_derived_types !< Definitions of the derived types
Expand Down
2 changes: 1 addition & 1 deletion src/simulation/m_data_output.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ module m_data_output
!> @{
real(wp) :: icfl_max !< ICFL criterion maximum
real(wp) :: vcfl_max !< VCFL criterion maximum
real(wp) :: Rc_min !< Rc criterion maximum
real(wp) :: Rc_min !< Rc criterion minimum
!> @}

type(scalar_field), allocatable, dimension(:) :: q_cons_temp_ds
Expand Down
2 changes: 1 addition & 1 deletion src/simulation/m_riemann_solver_hllc.fpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ contains
#:set SV = STENCIL_VAR
#:set SF = lambda offs: COORDS.format(STENCIL_IDX = SV + offs)
if (norm_dir == ${NORM_DIR}$) then
! 6-EQUATION MODEL WITH HLLC HLLC star-state flux with contact wave speed s_S
! 6-EQUATION MODEL WITH HLLC star-state flux with contact wave speed s_S
if (model_eqns == model_eqns_6eq) then
! 6-equation model (model_eqns=3): separate phasic internal energies
$:GPU_PARALLEL_LOOP(collapse=3, private='[i, j, k, l, q, vel_L, vel_R, Re_L, Re_R, alpha_L, alpha_R, Ys_L, &
Expand Down
Loading