Collaboration diagram for Module for physical constants:

Modules
	Module for turbulence constants

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 is variable: More...

integer(c_int), pointer, save	icv
	isochoric specific heat 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 (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 (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...

Detailed Description

Variable Documentation

◆ cp0

real(c_double), pointer, save cp0

reference specific heat.

Useful if there is 1 <= n <= nscaus, so that iscalt = n and itherm = 1 (there is a "temperature" scalar), unless the user specifies the specific heat in the user subroutine cs_user_physical_properties (icp > 0) with the compressible module or coal combustion, cp0 is also needed even when there is no user scalar.

Note: None of the scalars from the specific physics is a temperature.; When using the Graphical Interface, cp0 is also used to calculate the diffusivity of the thermal scalars, based on their conductivity; it is therefore needed, unless the diffusivity is also specified in cs_user_physical_properties.

◆ cs_physical_constants_r

double precision cs_physical_constants_r

Ideal gas constant ( $J.mol^{-1}.K^{-1}$ )

◆ cv0

real(c_double), pointer, save cv0

Reference isochoric specific heat.

Useful for the compressible module (J/kg/K)

◆ eint0

double precision, save eint0

Reference internal energy for the barotropic compressible module.

◆ gx

real(c_double), pointer, save gx

Gravity.

◆ gy

real(c_double), pointer, save gy

◆ gz

real(c_double), pointer, save gz

◆ icorio

integer(c_int), pointer, save icorio

Coriolis effects.

◆ icp

integer(c_int), pointer, save icp

indicates if the isobaric specific heat $C_p$ is variable:

0: constant, no property field is declared
1: variable, is declared as a property field
When gas or coal combustion is activated, icp is automatically set to 0 (constant ). With the electric module, it is automatically set to 1. The user is not allowed to modify these default choices.
When icp = 1 is specified, the code automatically modifies this value to make icp designate the effective index-number of the property "specific heat". For each cell iel, the value of is then specified by the user in the appropriate subroutine (cs_user_physical_properties for the standard physics).
Useful if there is 1 $\leqslant$ N $\leqslant$ nscal so that iscsth(n)=1 (there is a scalar temperature) or with the compressible module for non perfect gases.

◆ icv

integer(c_int), pointer, save icv

isochoric specific heat $ C_v $

◆ ipthrm

integer(c_int), pointer, save ipthrm

Uniform variable thermodynamic pressure for the low-Mach algorithm.

1: true
0: false

◆ irovar

integer(c_int), pointer, save irovar

variable density field $\rho$ :

1: true, its variation law be given either in the GUI, or in the user subroutine cs_user_physical_properties .
See Define user laws for physical properties for more informations.
0: false, its value is the reference density ro0.

◆ ivivar

integer(c_int), pointer, save ivivar

variable viscosity field $\mu$ :

1: true, its variation law be given either in the GUI, or in the user subroutine cs_user_physical_properties .
See Define user laws for physical properties for more informations.
0: false, its value is the reference molecular dynamic viscosity viscl0

◆ ivsuth

integer(c_int), pointer, save ivsuth

Sutherland law for laminar viscosity and thermal conductivity Only useful in gas mix (igmix) specific physics.

1: Sutherland law
0: low temperature law (linear except for helium)

◆ ixyzp0

integer(c_int), pointer, save ixyzp0

Physical constants of the fluid filling xyzp0 indicator.

◆ kboltz

double precision kboltz

Boltzmann constant ( $J.K^{-1}$ )

◆ kleak

real(c_double), pointer, save kleak

Leak head loss (2.9 by default, from Idelcick)

◆ p0

real(c_double), pointer, save p0

reference pressure for the total pressure.

except with the compressible module, the total pressure $P$ is evaluated from the reduced pressure $P^*$ so that $P$ is equal to p0 at the reference position $\vect{x}_0$ (given by xyzp0). with the compressible module, the total pressure is solved directly. always Useful

◆ pred0

real(c_double), pointer, save pred0

reference value for the reduced pressure $P^*$ (see ro0).

It is especially used to initialise the reduced pressure and as a reference value for the outlet boundary conditions. For an optimised precision in the resolution of $P^*$ , it is wiser to keep pred0 to 0. With the compressible module, the "pressure" variable appearing in the equations directly represents the total pressure. It is therefore initialized to p0 and not pred0 (see ro0). Always useful, except with the compressible module

◆ pther

real(c_double), pointer, save pther

Thermodynamic pressure for the current time step.

◆ pthera

real(c_double), pointer, save pthera

Thermodynamic pressure for the previous time step.

◆ pthermax

real(c_double), pointer, save pthermax

pthermax: Thermodynamic maximum pressure for user clipping, used to model a venting effect

◆ rair

double precision rair

Perfect gas constant for air (mixture)

◆ ro0

real(c_double), pointer, save ro0

reference density.

Negative value: not initialized. Its value is not used in gas or coal combustion modelling (it will be calculated following the perfect gas law, with $P0$ and $T0$ ). With the compressible module, it is also not used by the code, but it may be (and often is) referenced by the user in user subroutines; it is therefore better to specify its value.

Always useful otherwise, even if a law defining the density is given by the user subroutines cs_user_physical_properties. indeed, except with the compressible module, CS does not use the total pressure $P$ when solving the Navier-Stokes equation, but a reduced pressure . $P^*=P-\rho_0\vect{g}.(\vect{x}-\vect{x}_0)+P^*_0-P_0$ . where $\vect{x_0}$ is a reference point (see xyzp0) and $P^*_0$ and $P_0$ are reference values (see pred0 and p0). Hence, the term $-\grad{P}+\rho\vect{g}$ in the equation is treated as $-\grad{P^*}+(\rho-\rho_0)\vect{g}$ . The closer ro0 is to the value of $\rho$ , the more $P^*$ will tend to represent only the dynamic part of the pressure and the faster and more precise its solution will be. Whatever the value of ro0, both $P$ and $P^*$ appear in the log and the post-processing outputs.. with the compressible module, the calculation is made directly on the total pressure

◆ roref

real(c_double), pointer, save roref

Initial reference density.

◆ sleak

real(c_double), pointer, save sleak

Leak surface.

◆ stephn

double precision stephn

Stephan constant for the radiative module $\sigma$ in $W.m^{-2}.K^{-4}$ .

◆ t0

real(c_double), pointer, save t0

reference temperature.

Useful for the specific physics gas or coal combustion (initialization of the density), for the electricity modules to initialize the domain temperature and for the compressible module (initializations). It must be given in Kelvin.

◆ tkelvi

double precision tkelvi

Temperature in Kelvin correponding to 0 degrees Celsius (= +273,15)

◆ viscl0

real(c_double), pointer, save viscl0

reference molecular dynamic viscosity.

Negative value: not initialized. Always useful, it is the used value unless the user specifies the viscosity in the subroutine cs_user_physical_properties

◆ xcal2j

double precision xcal2j

Calories (1 cvar_al = xcal2j J)

◆ xmasmr

real(c_double), pointer, save xmasmr

Molar mass of the perfect gas in $ kg/mol $ (if ieos=1)

Always useful

◆ xyzp0

real(c_double), dimension(:), pointer, save xyzp0

coordinates of the reference point $\vect{x}_0$ for the total pressure.

When there are no Dirichlet conditions for the pressure (closed domain), xyzp0 does not need to be specified (unless the total pressure has a clear physical meaning in the configuration treated).
When Dirichlet conditions on the pressure are specified but only through stantard outlet conditions (as it is in most configurations), xyzp0 does not need to be specified by the user, since it will be set to the coordinates of the reference outlet face (i.e. the code will automatically select a reference outlet boundary face and set xyzp0 so that equals p0 at this face). Nonetheless, if xyzp0 is specified by the user, the calculation will remain correct.
When direct Dirichlet conditions are specified by the user (specific value set on specific boundary faces), it is better to specify the corresponding reference point (i.e. specify where the total pressure is p0). This way, the boundary conditions for the reduced pressure will be close to pred0, ensuring an optimal precision in the resolution. If xyzp0 is not specified, the reduced pressure will be shifted, but the calculations will remain correct..
With the compressible module, the "pressure" variable appearing in the equations directly represents the total pressure. xyzp0 is therefore not used..

Always useful, except with the compressible module.

Modules

Variables