programmer's documentation
Data Structures | Functions | Variables
cs_turbulence_model.h File Reference
#include "cs_defs.h"
Include dependency graph for cs_turbulence_model.h:

Go to the source code of this file.

Data Structures

struct  cs_turb_model_t
 Turbulence model general options descriptor. More...
 
struct  cs_turb_ref_values_t
 
struct  cs_turb_rans_model_t
 RANS turbulence model descriptor. More...
 
struct  cs_turb_les_model_t
 LES turbulence model descriptor. More...
 

Functions

cs_turb_model_tcs_get_glob_turb_model (void)
 Provide acces to cs_glob_turb_model. More...
 
cs_turb_ref_values_tcs_get_glob_turb_ref_values (void)
 Provide acces to cs_glob_turb_ref_values. More...
 
cs_turb_rans_model_tcs_get_glob_turb_rans_model (void)
 Provide acces to cs_glob_turb_rans_model. More...
 
cs_turb_les_model_tcs_get_glob_turb_les_model (void)
 Provide acces to cs_glob_turb_les_model. More...
 

Variables

const cs_turb_model_tcs_glob_turb_model
 
const cs_turb_ref_values_tcs_glob_turb_ref_values
 
const cs_turb_rans_model_tcs_glob_turb_rans_model
 
const cs_turb_les_model_tcs_glob_turb_les_model
 
const double cs_turb_xkappa
 
const double cs_turb_vdriest
 
const double cs_turb_cstlog
 
const double cs_turb_cstlog_rough
 
double cs_turb_cstlog_alpha
 
const double cs_turb_apow
 
const double cs_turb_bpow
 
double cs_turb_dpow
 
const double cs_turb_cmu
 
double cs_turb_cmu025
 
const double cs_turb_ce1
 
const double cs_turb_ce2
 
const double cs_turb_ce4
 
const double cs_turb_sigmak
 
double cs_turb_sigmae
 
const double cs_turb_crij1
 
const double cs_turb_crij2
 
const double cs_turb_crij3
 
const double cs_turb_crijp1
 
const double cs_turb_crijp2
 
const double cs_turb_cssge2
 
const double cs_turb_cssgs1
 
const double cs_turb_cssgs2
 
const double cs_turb_cssgr1
 
const double cs_turb_cssgr2
 
const double cs_turb_cssgr3
 
const double cs_turb_cssgr4
 
const double cs_turb_cssgr5
 
const double cs_turb_cebms1
 
const double cs_turb_cebms2
 
const double cs_turb_cebmr1
 
const double cebmr2
 
const double cebmr3
 
const double cebmr4
 
const double cebmr5
 
const double cebmr6
 
double cs_turb_csrij
 
const double cs_turb_cebme2
 
const double cs_turb_cebmmu
 
const double cs_turb_xcl
 
const double cs_turb_xa1
 
const double cs_turb_xct
 
const double cs_turb_xceta
 
const double cs_turb_cpale1
 
const double cs_turb_cpale2
 
const double cs_turb_cpale3
 
const double cs_turb_cpale4
 
const double cs_turb_cpalse
 
const double cs_turb_cpalmu
 
const double cs_turb_cpalc1
 
const double cs_turb_cpalc2
 
const double cs_turb_cpalct
 
const double cs_turb_cpalcl
 
const double cs_turb_cpalet
 
const double cs_turb_ckwsk1
 
const double cs_turb_ckwsk2
 
const double cs_turb_ckwsw1
 
const double cs_turb_ckwsw2
 
const double cs_turb_ckwbt1
 
const double cs_turb_ckwbt2
 
double cs_turb_ckwgm1
 
double cs_turb_ckwgm2
 
const double cs_turb_ckwa1
 
const double cs_turb_ckwc1
 
const double cs_turb_csab1
 
const double cs_turb_csab2
 
const double cs_turb_csasig
 
const double cs_turb_csav1
 
double cs_turb_csaw1
 
const double cs_turb_csaw2
 
const double cs_turb_csaw3
 
const double cs_turb_cssr1
 
const double cs_turb_cssr2
 
const double cs_turb_cssr3
 
const double cs_turb_ccaze2
 
const double cs_turb_ccazsc
 
const double cs_turb_ccaza
 
const double cs_turb_ccazb
 
const double cs_turb_ccazc
 
const double cs_turb_ccazd
 
const double cs_turb_xlesfl
 
const double cs_turb_ales
 
const double cs_turb_bles
 
const double cs_turb_csmago
 
const double cs_turb_xlesfd
 
double cs_turb_smagmx
 
const double cs_turb_cdries
 
const double cs_turb_cv2fa1
 
const double cs_turb_cv2fe2
 
const double cs_turb_cv2fmu
 
const double cs_turb_cv2fc1
 
const double cs_turb_cv2fc2
 
const double cs_turb_cv2fct
 
const double cs_turb_cv2fcl
 
const double cs_turb_cv2fet
 
const double cs_turb_cwale
 
const double cs_turb_xiafm
 
const double cs_turb_etaafm
 
const double cs_turb_c1trit
 
const double cs_turb_c2trit
 
const double cs_turb_c3trit
 
const double cs_turb_c4trit
 
const double cs_turb_cthafm
 
const double cs_turb_cthdfm
 

Function Documentation

cs_turb_les_model_t* cs_get_glob_turb_les_model ( void  )

Provide acces to cs_glob_turb_les_model.

needed to initialize structure with GUI

cs_turb_model_t* cs_get_glob_turb_model ( void  )

Provide acces to cs_glob_turb_model.

needed to initialize structure with GUI

cs_turb_rans_model_t* cs_get_glob_turb_rans_model ( void  )

Provide acces to cs_glob_turb_rans_model.

needed to initialize structure with GUI

cs_turb_ref_values_t* cs_get_glob_turb_ref_values ( void  )

Provide acces to cs_glob_turb_ref_values.

needed to initialize structure with GUI

Variable Documentation

const cs_turb_les_model_t* cs_glob_turb_les_model
const cs_turb_model_t* cs_glob_turb_model
const cs_turb_rans_model_t* cs_glob_turb_rans_model
const cs_turb_ref_values_t* cs_glob_turb_ref_values
const double cs_turb_ales

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.

const double cs_turb_apow

Werner and Wengle coefficient

const double cs_turb_bles

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.

const double cs_turb_bpow

Werner and Wengle coefficient

const double cs_turb_c1trit

Coefficient of turbulent DFM flow model.

const double cs_turb_c2trit

Coefficient of turbulent DFM flow model.

const double cs_turb_c3trit

Coefficient of turbulent DFM flow model.

const double cs_turb_c4trit

Coefficient of turbulent DFM flow model.

const double cs_turb_ccaza

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_ccazb

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_ccazc

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_ccazd

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_ccaze2

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_ccazsc

Constants of the Cazalbou rotation/curvature correction.

const double cs_turb_cdries

Van Driest constant appearing in the van Driest damping function applied to the Smagorinsky constant:

  • $ (1-\exp^{(-y^+/cdries}) $.

Useful if and only if iturb = 40 or 41.

const double cs_turb_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$).

const double cs_turb_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).

const double cs_turb_ce4

Coefficient of interfacial coefficient in k-eps, used in Lagrange treatment.

Constant $C_{\varepsilon 4}$ for the interfacial term (Lagrangian module) in case of two-way coupling. Useful in case of Lagrangian modelling, in $k-\varepsilon$ and $R_{ij}-\varepsilon$ with two-way coupling.

const double cs_turb_cebme2

Constant of the Rij-epsilon EBRSM.

const double cs_turb_cebmmu

Constant of the Rij-epsilon EBRSM.

const double cs_turb_cebmr1
const double cs_turb_cebms1

Constant of the Rij-epsilon EBRSM.

const double cs_turb_cebms2

Constant of the Rij-epsilon EBRSM.

const double cs_turb_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).

const double cs_turb_ckwbt1

Constant $\beta_1$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST).

const double cs_turb_ckwbt2

Constant $\beta_2$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST).

const double cs_turb_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.

double cs_turb_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).

Warning
: $\gamma_1$ is calculated before the call to usipsu. Hence, if $\beta_1$, $C_\mu$, $\kappa$ or $\sigma_{\omega 1}$ is modified in usipsu, cs_turb_ckwgm1 must also be modified in accordance.
double cs_turb_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).

Warning
: $\gamma_2$ is calculated before the call to usipsu. Hence, if $\beta_2$, $C_\mu$, $\kappa$ or $\sigma_{\omega 2}$ is modified in usipsu, cs_turb_ckwgm2 must also be modified in accordance.
const double cs_turb_ckwsk1

Constant $\sigma_{k1}$ for the $k-\omega$ SST model. Useful if and only if iturb=60.

const double cs_turb_ckwsk2

Constant $\sigma_{k2}$ for the $k-\omega$ SST model. Useful if and only if iturb=60.

const double cs_turb_ckwsw1

Constant $\sigma_{\omega 1}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST).

const double cs_turb_ckwsw2

Constant $\sigma_{\omega 2}$ for the $k-\omega$ SST model. Useful if and only if iturb=60 ( $k-\omega$ SST).

const double cs_turb_cmu

Constant $C_\mu$ for all the RANS turbulence models except for the v2f model (see cs_turb_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$).

double cs_turb_cmu025

$ C_\mu^\frac{1}{4} $

const double cs_turb_cpalc1

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalc2

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalcl

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalct

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpale1

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpale2

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpale3

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpale4

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalet

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalmu

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_cpalse

Specific constant of v2f "BL-v2k" (or phi-alpha).

const double cs_turb_crij1

Constant $C_1$ for the $R_{ij}-\varepsilon$ LRR model. Useful if and only if iturb=30 ( $R_{ij}-\varepsilon$ LRR).

const double cs_turb_crij2
const double cs_turb_crij3

Constant $C_3$ for the $R_{ij}-\varepsilon$ LRR model. Useful if and only if iturb=30 ( $R_{ij}-\varepsilon$ LRR).

const double cs_turb_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 cs_turb_rans_model_t::irijec=1 ( $R_{ij}-\varepsilon$ LRR).

const double cs_turb_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 cs_turb_rans_model_t::irijec=1 ( $R_{ij}-\varepsilon$ LRR).

const double cs_turb_csab1

Specific constant of Spalart-Allmaras.

const double cs_turb_csab2

Specific constant of Spalart-Allmaras.

const double cs_turb_csasig

Specific constant of Spalart-Allmaras.

const double cs_turb_csav1

Specific constant of Spalart-Allmaras.

double cs_turb_csaw1

Specific constant of Spalart-Allmaras.

const double cs_turb_csaw2

Specific constant of Spalart-Allmaras.

const double cs_turb_csaw3

Specific constant of Spalart-Allmaras.

const double cs_turb_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.

Useful if and only if iturb = 40.

Note
In theory Smagorinsky constant is 0.18. For a channel, 0.065 value is rather taken.
double cs_turb_csrij

Constant $C_s$ for the $R_{ij}-\varepsilon$ LRR model. Useful if and only if iturb=30 ( $R_{ij}-\varepsilon$ LRR).

const double cs_turb_cssge2

Constant $C_{\varepsilon 2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgr1

Constant $C_{r1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgr2

Constant $C_{r2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgr3

Constant $C_{r3}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgr4

constant $C_{r4}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgr5

Constant $C_{r1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgs1

Constant $C_{s1}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssgs2

Constant $C_{s2}$ for the $R_{ij}-\varepsilon$ SSG model. Useful if and only if iturb=31 ( $R_{ij}-\varepsilon$ SSG).

const double cs_turb_cssr1

Constant of the Spalart-Shur rotation/curvature correction.

const double cs_turb_cssr2

Constant of the Spalart-Shur rotation/curvature correction.

const double cs_turb_cssr3

Constant of the Spalart-Shur rotation/curvature correction.

const double cs_turb_cstlog

Constant of logarithmic smooth 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$).

double cs_turb_cstlog_alpha

Constant $ \alpha $ for logarithmic law function switching from rough to smooth: $ \dfrac{1}{\kappa} \ln(y u_k/(\nu + \alpha \xi u_k)) + cstlog $ ( $ \alpha = \exp \left( -\kappa (8.5 - 5.2) \right) $).

Useful if and only if iturb >= 10 (mixing length, $k-\varepsilon$, $R_{ij}-\varepsilon$, LES, v2f or $k-\omega$).

const double cs_turb_cstlog_rough

Constant of logarithmic rough law function: $ \dfrac{1}{\kappa} \ln(y/\xi) + cstlog_{rough} $ ( $ cstlog_{rough} = 8.5 $).

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$).

const double cs_turb_cthafm

Constant of GGDH and AFM on the thermal scalar.

const double cs_turb_cthdfm

Constant of GGDH and AFM on the thermal scalar.

const double cs_turb_cv2fa1

Constant $a_1$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fc1

Constant $C_1$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fc2

Constant $C_2$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fcl

Constant $C_L$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fct

Constant $C_T$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fe2

Constant $C_{\varepsilon 2}$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fet

Constant $C_\eta$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cv2fmu

Constant $C_\mu$ for the v2f $\varphi$-model. Useful if and only if iturb=50 (v2f $\varphi$-model).

const double cs_turb_cwale

Constant of the WALE LES method.

double cs_turb_dpow

Werner and Wengle coefficient

const double cs_turb_etaafm

Coefficient of turbulent AFM flow model.

double cs_turb_sigmae

Prandtl number for $\varepsilon$. Useful if and only if iturb= 20, 21, 30, 31 or 50 ( $k-\varepsilon$, $R_{ij}-\varepsilon$ or v2f).

const double cs_turb_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).

double cs_turb_smagmx

Maximum allowed value for the variable $C$ appearing in the LES dynamic model (the "square" comes from the fact that the variable of the dynamic model corresponds to the square of the constant of the Smagorinsky model). Any larger value yielded by the calculation procedure of the dynamic model will be clipped to $ smagmx^2$.

Useful if and only if iturb = 41.

const double cs_turb_vdriest

Van Driest constant. (= 25.6)

Useful if and only if cs_glob_wall_functions::iwallf = 5. (Two scales log law at the wall using Van Driest mixing length expression).

const double cs_turb_xa1

Constant in the expression of Ce1' for the Rij-epsilon EBRSM.

const double cs_turb_xceta

Constant of the Rij-epsilon EBRSM.

const double cs_turb_xcl

Constant of the Rij-epsilon EBRSM.

const double cs_turb_xct

Constant of the Rij-epsilon EBRSM.

const double cs_turb_xiafm

Coefficient of turbulent AFM flow model.

const double cs_turb_xkappa

Karman constant. (= 0.42)

Useful if and only if iturb >= 10. (mixing length, $k-\varepsilon$, $R_{ij}-\varepsilon$, LES, v2f or $k-\omega$).

const double cs_turb_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}$.

Useful if and only if iturb = 41.

const double cs_turb_xlesfl

Constant used in the definition of LES filtering diameter: $ \delta = \text{xlesfl} . (\text{ales} . volume)^{\text{bles}} $.