Skip to content

Commit fe63e17

Browse files
committed
Added missing comments and removed author and date from common/m_var_conversion
1 parent 581122d commit fe63e17

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

src/common/m_variables_conversion.fpp

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,11 @@
11
!>
22
!! @file m_variables_conversion.f90
33
!! @brief Contains module m_variables_conversion
4-
!! @author A. Gupta
5-
!! @version 1.0
6-
!! @date NOV 14 2022
7-
8-
!> @brief This module features a procedural pointer for calculating pressure
9-
!! based on the model type and whether there are bubbles present.
10-
!! There are 3 different subroutines:
11-
!! 1) s_compute_pressure_from_energy => when model_eqns != 4 and there are no bubbles
12-
!! 2) s_compute_pressure_from_bubbles => when model_eqns != 4 and there are bubbles
13-
!! 3) s_compute_pressure_4eqns => when model_eqns == 4
144

5+
!> @brief This module consists of subroutines used in the conversion of the
6+
!! conservative variables into the primitive ones and vice versa. In
7+
!! addition, the module also contains the subroutines used to obtain
8+
!! the mixture variables and the subroutines used to compute pressure.
159
module m_variables_conversion
1610

1711
! Dependencies =============================================================
@@ -234,6 +228,18 @@ contains
234228

235229
end subroutine s_compute_pressure
236230

231+
!> This subroutine is designed for the gamma/pi_inf model
232+
!! and provided a set of either conservative or primitive
233+
!! variables, transfers the density, specific heat ratio
234+
!! function and the liquid stiffness function from q_vf to
235+
!! rho, gamma and pi_inf.
236+
!! @param q_vf conservative or primitive variables
237+
!! @param i cell index to transfer mixture variables
238+
!! @param j cell index to transfer mixture variables
239+
!! @param k cell index to transfer mixture variables
240+
!! @param rho density
241+
!! @param gamma specific heat ratio function
242+
!! @param pi_inf liquid stiffness
237243
subroutine s_convert_mixture_to_mixture_variables(q_vf, i, j, k, &
238244
rho, gamma, pi_inf, Re_K, G_K, G)
239245

0 commit comments

Comments
 (0)