My Project
programmer's documentation
Functions/Subroutines | Variables
cstphy Module Reference

Functions/Subroutines

subroutine physical_constants_init
 Initialize Fortran physical constants API. This maps Fortran pointers to global C structure members. More...
 
subroutine fluid_properties_init
 Initialize Fortran fluid properties API. This maps Fortran pointers to global C structure members. More...
 
subroutine turb_reference_values_init
 Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members. More...
 
subroutine turb_model_constants_init
 Initialize Fortran turbulence model constants. This maps Fortran pointers to global C real numbers. More...
 

Variables

double precision tkelvi
 Temperature in Kelvin correponding to 0 degrees Celsius (= +273,15) More...
 
double precision xcal2j
 Calories (1 cvar_al = xcal2j J) More...
 
double precision stephn
 Stephan constant for the radiative module $\sigma$ in $W.m^{-2}.K^{-4}$. More...
 
double precision rair
 Perfect gas constant for air (mixture) More...
 
double precision kboltz
 Boltzmann constant ( $J.K^{-1}$) More...
 
double precision cs_physical_constants_r
 Ideal gas constant ( $J.mol^{-1}.K^{-1}$) More...
 
real(c_double), pointer, save gx
 Gravity. More...
 
real(c_double), pointer, save gy
 
real(c_double), pointer, save gz
 
integer(c_int), pointer, save icorio
 Coriolis effects. More...
 
integer(c_int), pointer, save ixyzp0
 Physical constants of the fluid filling xyzp0 indicator. More...
 
integer(c_int), pointer, save icp
 indicates if the isobaric specific heat $C_p$ is variable: More...
 
integer(c_int), pointer, save icv
 isochoric specific heat $ C_v $ More...
 
integer(c_int), pointer, save irovar
 variable density field $ \rho $: More...
 
integer(c_int), pointer, save ivivar
 variable viscosity field $ \mu $: More...
 
integer(c_int), pointer, save ivsuth
 Sutherland law for laminar viscosity and thermal conductivity Only useful in gas mix (igmix) specific physics. More...
 
real(c_double), pointer, save ro0
 reference density.
More...
 
real(c_double), pointer, save viscl0
 reference molecular dynamic viscosity.
More...
 
real(c_double), pointer, save p0
 reference pressure for the total pressure.
More...
 
real(c_double), pointer, save pred0
 reference value for the reduced pressure $P^*$ (see ro0).
More...
 
real(c_double), dimension(:), pointer, save xyzp0
 coordinates of the reference point $\vect{x}_0$ for the total pressure. More...
 
real(c_double), pointer, save t0
 reference temperature. More...
 
double precision, save eint0
 Reference internal energy for the barotropic compressible module. More...
 
real(c_double), pointer, save cp0
 reference specific heat. More...
 
real(c_double), pointer, save cv0
 Reference isochoric specific heat. More...
 
real(c_double), pointer, save xmasmr
 Molar mass of the perfect gas in $ kg/mol $ (if ieos=1) More...
 
integer(c_int), pointer, save ipthrm
 Uniform variable thermodynamic pressure for the low-Mach algorithm. More...
 
real(c_double), pointer, save pther
 Thermodynamic pressure for the current time step. More...
 
real(c_double), pointer, save pthera
 Thermodynamic pressure for the previous time step. More...
 
real(c_double), pointer, save pthermax
 pthermax: Thermodynamic maximum pressure for user clipping, used to model a venting effect More...
 
real(c_double), pointer, save sleak
 Leak surface. More...
 
real(c_double), pointer, save kleak
 Leak head loss (2.9 by default, from Idelcick) More...
 
real(c_double), pointer, save roref
 Initial reference density. More...
 
double precision, save xkappa
 $ \kappa $ Karman constant. (= 0.42) Useful if and only if iturb >= 10. (mixing length, $k-\varepsilon$, $R_{ij}-\varepsilon$, LES, v2f or $k-\omega$) More...
 
double precision, save cstlog
 constant of logarithmic law function: $ \dfrac{1}{\kappa} \ln(y^+) + cstlog $ ( $ cstlog = 5.2 $) constant of the logarithmic wall function. Useful if and only if iturb >= 10 (mixing length, $k-\varepsilon$, $R_{ij}-\varepsilon$, LES, v2f or $k-\omega$) More...
 
real(c_double), pointer, save ypluli
 limit value of $y^+$ for the viscous sublayer. ypluli depends on the chosen wall function: it is initialized to 10.88 for the scalable wall function (iwallf=4), otherwise it is initialized to $1/\kappa\approx 2,38$. In LES, ypluli is taken by default to be 10.88. More...
 
double precision, save apow
 Werner and Wengle coefficient. More...
 
double precision, save bpow
 Werner and Wengle coefficient. More...
 
double precision, save cpow
 Werner and Wengle coefficient. More...
 
double precision, save dpow
 Werner and Wengle coefficient. More...
 
real(c_double), pointer, save cmu
 constant $C_\mu$ for all the RANS turbulence models except for the v2f model (see cv2fmu for the value of $C_\mu$ in case of v2f modelling). Useful if and only if iturb = 20, 21, 30, 31 or 60 ( $k-\varepsilon$, $R_{ij}-\varepsilon$ or $k-\omega$) More...
 
real(c_double), pointer, save cmu025
 $ C_\mu^\frac{1}{4} $ More...
 
double precision, save ce1
 constant $C_{\varepsilon 1}$ for all the RANS turbulence models except for the v2f and the $k-\omega$ models. Useful if and only if iturb= 20, 21, 30 or 31 ( $k-\varepsilon$ or $R_{ij}-\varepsilon$) More...
 
double precision, save ce2
 constant $C_{\varepsilon 2}$ for the $k-\varepsilon$ and $R_{ij}-\varepsilon$ LRR models. Useful if and only if iturb= 20, 21 or 30 ( $k-\varepsilon$ or $R_{ij}-\varepsilon$ LRR) More...
 
double precision, save cnl1
 constant $C_{NL1}$ for the $k-\varepsilon$ model from Baglietto et al. (quadratric) Useful if and only if iturb= 23 More...
 
double precision, save cnl2
 constant $C_{NL2}$ for the $k-\varepsilon$ model from Baglietto et al. (quadratric) Useful if and only if iturb= 23 More...
 
double precision, save cnl3
 constant $C_{NL3}$ for the $k-\varepsilon$ model from Baglietto et al. (quadratric) Useful if and only if iturb= 23 More...
 
double precision, save cnl4
 constant $C_{NL4}$ for the $k-\varepsilon$ model from Baglietto et al. (quadratric) Useful if and only if iturb= 23 More...
 
double precision, save cnl5
 constant $C_{NL5}$ for the $k-\varepsilon$ model from Baglietto et al. (quadratric) Useful if and only if iturb= 23 More...
 
double precision, save ce4
 Coefficient of interfacial coefficient in k-eps, used in Lagrange treatment. More...
 
double precision, save sigmak
 Prandtl number for $k$ with $k-\varepsilon$ and v2f models. Useful if and only if iturb=20, 21 or 50 ( $k-\varepsilon$ or v2f) More...
 
real(c_double), pointer, save sigmae
 Prandtl number for $\varepsilon$. Useful if and only if iturb= 20, 21, 30, 31 or 50 ( $k-\varepsilon$, $R_{ij}-\varepsilon$ or v2f) More...
 
double precision, save crij1
 constant $C_1$ for the $R_{ij}-\varepsilon$ LRR model. Useful if and only if iturb=30 ( $R_{ij}-\varepsilon$ LRR) More...
 
double precision, save crij2
 constant $C_2$ for the $R_{ij}-\varepsilon$ LRR model. Useful if and only if iturb=30 ( $R_{ij}-\varepsilon$ LRR) More...
 
double precision, save crij3
 constant $C_3$ for the buoyant production term $R_{ij}-\varepsilon$ models. More...
 
double precision, save crijp1
 constant $C_1^\prime$ for the $R_{ij}-\varepsilon$ LRR model, corresponding to the wall echo terms. Useful if and only if iturb=30 and irijec=1 ( $R_{ij}-\varepsilon$ LRR) More...
 
double precision, save crijp2
 constant $C_2^\prime$ for the $R_{ij}-\varepsilon$ LRR model, corresponding to the wall echo terms. Useful if and only if iturb=30 and irijec=1 ( $R_{ij}-\varepsilon$ LRR) More...
 
double precision, save cssge2
 constant $C_{\varepsilon 2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgs1
 constant $C_{s1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgs2
 constant $C_{s2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgr1
 constant $C_{r1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgr2
 constant $C_{r2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgr3
 constant $C_{r3}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgr4
 constant $C_{r4}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cssgr5
 constant $C_{r1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG) More...
 
double precision, save cebms1
 constant of the Rij-epsilon EBRSM More...
 
double precision, save cebms2
 constant of the Rij-epsilon EBRSM More...
 
double precision, save cebmr1
 
double precision, save cebmr2
 
double precision, save cebmr3
 
double precision, save cebmr4
 
double precision, save cebmr5
 
double precision, save csrij
 constant $C_s$ for the $R_{ij}-\varepsilon$ models. More...
 
double precision, save cebme2
 constant of the Rij-epsilon EBRSM More...
 
double precision, save cebmmu
 constant of the Rij-epsilon EBRSM More...
 
double precision, save xcl
 constant of the Rij-epsilon EBRSM More...
 
double precision, save xa1
 constant in the expression of Ce1' for the Rij-epsilon EBRSM More...
 
double precision, save xct
 constant of the Rij-epsilon EBRSM More...
 
double precision, save xceta
 constant of the Rij-epsilon EBRSM More...
 
double precision, save cpale1
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpale2
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpale3
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpale4
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalse
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalmu
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalc1
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalc2
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalct
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalcl
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save cpalet
 specific constant of v2f "BL-v2k" (or phi-alpha) More...
 
double precision, save ckwsk1
 constant $\sigma_{k1}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 More...
 
double precision, save ckwsk2
 constant $\sigma_{k2}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 More...
 
double precision, save ckwsw1
 constant $\sigma_{\omega 1}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwsw2
 constant $\sigma_{\omega 2}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwbt1
 constant $\beta_1$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwbt2
 constant $\beta_2$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save cddes
 constant $ C_{DDES}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) and iddes=1 More...
 
double precision, save ckwgm1
 $\frac{\beta_1}{C_\mu}-\frac{\kappa^2}{\sqrt{C_\mu}\sigma_{\omega 1}}$ constant $\gamma_1$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwgm2
 $\frac{\beta_2}{C_\mu}-\frac{\kappa^2}{\sqrt{C_\mu}\sigma_{\omega 2}}$ constant $\gamma_2$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwa1
 specific constant of k-omega SST constant $a_1$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) More...
 
double precision, save ckwc1
 constant $ c_1 $ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST) specific constant of k-omega SST More...
 
double precision, save csab1
 specific constant of Spalart-Allmaras More...
 
double precision, save csab2
 specific constant of Spalart-Allmaras More...
 
double precision, save csasig
 specific constant of Spalart-Allmaras More...
 
double precision, save csav1
 specific constant of Spalart-Allmaras More...
 
double precision, save csaw1
 specific constant of Spalart-Allmaras More...
 
double precision, save csaw2
 specific constant of Spalart-Allmaras More...
 
double precision, save csaw3
 specific constant of Spalart-Allmaras More...
 
double precision, save cssr1
 constant of the Spalart-Shur rotation/curvature correction More...
 
double precision, save cssr2
 constant of the Spalart-Shur rotation/curvature correction More...
 
double precision, save cssr3
 constant of the Spalart-Shur rotation/curvature correction More...
 
double precision, save ccaze2
 constants of the Cazalbou rotation/curvature correction More...
 
double precision, save ccazsc
 constants of the Cazalbou rotation/curvature correction More...
 
double precision, save ccaza
 constants of the Cazalbou rotation/curvature correction More...
 
double precision, save ccazb
 constants of the Cazalbou rotation/curvature correction More...
 
double precision, save ccazc
 constants of the Cazalbou rotation/curvature correction More...
 
double precision, save ccazd
 constants of the Cazalbou rotation/curvature correction More...
 
real(c_double), pointer, save almax
 is a characteristic macroscopic length of the domain, used for the initialization of the turbulence and the potential clipping (with iclkep=1) More...
 
real(c_double), pointer, save uref
 the characteristic flow velocity, used for the initialization of the turbulence. Negative value: not initialized. More...
 
real(c_double), pointer, save xlomlg
 mixing length for the mixing length model More...
 
double precision, save xlesfl
 constant used in the definition of LES filtering diameter: $ \delta = \text{xlesfl} . (\text{ales} . volume)^{\text{bles}}$ xlesfl is a constant used to define, for each cell $\omega_i$, the width of the (implicit) filter: $\overline{\Delta}=xlesfl(ales*|\Omega_i|)^{bles}$
Useful if and only if iturb = 40 or 41 More...
 
double precision, save ales
 constant used to define, for each cell $Omega_i$, the width of the (implicit) filter: More...
 
double precision, save bles
 constant used to define, for each cell $Omega_i$, More...
 
double precision, save csmago
 Smagorinsky constant used in the Smagorinsky model for LES. The sub-grid scale viscosity is calculated by $\displaystyle\mu_{sg}= \rho C_{smago}^2\bar{\Delta}^2\sqrt{2\bar{S}_{ij}\bar{S}_{ij}}$ where $\bar{\Delta}$ is the width of the filter and $\bar{S}_{ij}$ the filtered strain rate. More...
 
double precision, save xlesfd
 ratio between explicit and explicit filter width for a dynamic model constant used to define, for each cell $\Omega_i$, the width of the explicit filter used in the framework of the LES dynamic model: $\widetilde{\overline{\Delta}}=xlesfd\overline{\Delta}$. More...
 
double precision, save smagmx
 maximum allowed value for the variable $C$ appearing in the LES dynamic model. Any larger value yielded by the calculation procedure of the dynamic model will be clipped to $ smagmx$. More...
 
double precision, save smagmn
 minimum allowed value for the variable $C$ appearing in the LES dynamic model. Any smaller value yielded by the calculation procedure of the dynamic model will be clipped to $ smagmn$. More...
 
double precision, save cdries
 van Driest constant appearing in the van Driest damping function applied to the Smagorinsky constant: More...
 
double precision, save volmin
 minimal control volume More...
 
double precision, save volmax
 maximal control volume More...
 
double precision, save voltot
 total domain volume More...
 
double precision, save cv2fa1
 constant $a_1$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fe2
 constant $C_{\varepsilon 2}$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fmu
 constant $C_\mu$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fc1
 constant $C_1$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fc2
 constant $C_2$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fct
 constant $C_T$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fcl
 constant $C_L$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cv2fet
 constant $C_\eta$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model) More...
 
double precision, save cwale
 constant of the WALE LES method More...
 
double precision, save xiafm
 coefficient of turbulent AFM flow model More...
 
double precision, save etaafm
 coefficient of turbulent AFM flow model More...
 
double precision, save c1trit
 coefficient of turbulent DFM flow model More...
 
double precision, save c2trit
 coefficient of turbulent DFM flow model More...
 
double precision, save c3trit
 coefficient of turbulent DFM flow model More...
 
double precision, save c4trit
 coefficient of turbulent DFM flow model More...
 
double precision, save cthafm
 constant of GGDH and AFM on the thermal scalar More...
 
double precision, save cthdfm
 constant of GGDH and AFM on the thermal scalar More...
 
double precision, save xclt
 constant of EB-AFM and EB-DFM More...
 
double precision, save rhebdfm
 constant of EB-DFM More...
 
double precision, save cthebdfm
 

Function/Subroutine Documentation

◆ fluid_properties_init()

subroutine cstphy::fluid_properties_init ( )

Initialize Fortran fluid properties API. This maps Fortran pointers to global C structure members.

◆ physical_constants_init()

subroutine cstphy::physical_constants_init ( )

Initialize Fortran physical constants API. This maps Fortran pointers to global C structure members.

◆ turb_model_constants_init()

subroutine cstphy::turb_model_constants_init ( )

Initialize Fortran turbulence model constants. This maps Fortran pointers to global C real numbers.

◆ turb_reference_values_init()

subroutine cstphy::turb_reference_values_init ( )

Initialize Fortran RANS turbulence model API. This maps Fortran pointers to global C structure members.