8.0
general documentation
Variables
turbulence options
Module for calculation options
+ Collaboration diagram for turbulence options:

Variables

integer(c_int), pointer, save iturb
  turbulence model More...
 
integer(c_int), pointer, save itytur
 Class of turbulence model (integer value iturb/10) More...
 
integer(c_int), pointer, save hybrid_turb
 Activation of Hybrid RANS/LES model (only valid for iturb equal to 60 or 51) More...
 
integer(c_int), pointer, save irccor
 Activation of rotation/curvature correction for eddy viscosity turbulence models. More...
 
integer(c_int), pointer, save itycor
 Type of rotation/curvature correction for eddy viscosity turbulence models. More...
 
integer(c_int), pointer, save idirsm
 Turbulent diffusion model for second moment closure. More...
 
integer(c_int), pointer, save iwallf
 Wall functions Indicates the type of wall function used for the velocity boundary conditions on a frictional wall. More...
 
integer(c_int), pointer, save iwalfs
 Wall functions for scalar. More...
 
integer(c_int), pointer, save iclkep
 Indicates the clipping method used for $k$ and $\varepsilon$, for the $k-\epsilon$ and v2f models. More...
 
integer(c_int), pointer, save igrhok
 Indicates if the term $\frac{2}{3}\grad \rho k$ is taken into account in the velocity equation. More...
 
integer(c_int), pointer, save igrake
 Indicates if the terms related to gravity are taken into account in the equations of $k-\epsilon$. More...
 
integer(c_int), pointer, save igrari
 Indicates if the terms related to gravity are taken into account in the equations of $R_{ij}-\varepsilon$. More...
 
integer(c_int), pointer, save ikecou
 Indicates if the coupling of the source terms of $k$ and $\epsilon$ or $k$ and $\omega$ is taken into account or not. More...
 
integer(c_int), pointer, save reinit_turb
 Advanced re-init for EBRSM and k-omega models. More...
 
integer(c_int), pointer, save irijco
 Coupled solving of $ \tens{R} $. More...
 
integer(c_int), pointer, save irijnu
 pseudo eddy viscosity in the matrix of momentum equation to partially implicit $ \divv \left( \rho \tens{R} \right) $ More...
 
integer(c_int), pointer, save irijrb
 accurate treatment of $ \tens{R} $ at the boundary (see condli) More...
 
integer(c_int), pointer, save irijec
 Indicates if the wall echo terms in $R_{ij}-\epsilon$ LRR model are taken into account: More...
 
integer(c_int), pointer, save idifre
 whole treatment of the diagonal part of the diffusion tensor of $ \tens{R} $ and $ \varepsilon $ More...
 
integer(c_int), pointer, save iclsyr
 partial implicitation of symmetry BCs of $ \tens{R} $ More...
 
integer(c_int), pointer, save iclptr
 partial implicitation of wall BCs of $ \tens{R} $ More...
 
integer(c_int), pointer, save idries
 Activates or the van Driest wall-damping for the Smagorinsky constant (the Smagorinsky constant is multiplied by the damping function $1-e^{-y^+/ cdries}$, where $y^+$ designates the non-dimensional distance to the nearest wall). More...
 
integer(c_int), pointer, save iicc
 Applied or not the Internal Consistency Constraint (ICC) for the HTLES model, in order to recover the correct RANS behavior when the energy ratio is forced to one in the RANS region: More...
 
integer(c_int), pointer, save ishield
 Applied or not the two-fold shielding function ( $f_s(\xi_K,\xi_D)$ of HTLES, to properly control the RANS-to-LES transition in the vicinity of the wall: More...
 
integer, save ikwcln = 1
 Wall boundary condition on omega in k-omega SST 0: Deprecated Neumann boundary condition 1: Dirichlet boundary condition consistent with Menter's original model: w_wall = 60*nu/(beta*d**2) More...
 
integer(c_int), pointer, save i_les_balance
 Activates or not the LES balance module. More...
 
integer, save nvarcl
 number of variable (deprecated, used only for compatibility) More...
 

Detailed Description

Variable Documentation

◆ hybrid_turb

integer(c_int), pointer, save hybrid_turb

Activation of Hybrid RANS/LES model (only valid for iturb equal to 60 or 51)

◆ i_les_balance

integer(c_int), pointer, save i_les_balance

Activates or not the LES balance module.

  • 0: false (default)
  • 1: true Useful if iturb =40, 41 or 42

◆ iclkep

integer(c_int), pointer, save iclkep

Indicates the clipping method used for $k$ and $\varepsilon$, for the $k-\epsilon$ and v2f models.

  • 0: clipping in absolute value
  • 1: coupled clipping based on physical relationships
    Useful if and only if iturb = 20, 21 or 50 ( $k-\epsilon$ and v2f models). The results obtained with the method corresponding to iclkep =1 showed in some cases a substantial sensitivity to the values of the length scale almax.
    The option iclkep = 1 is therefore not recommended, and, if chosen, must be used cautiously.

◆ iclptr

integer(c_int), pointer, save iclptr

partial implicitation of wall BCs of $ \tens{R} $

  • 1: true
  • 0: false (default)

◆ iclsyr

integer(c_int), pointer, save iclsyr

partial implicitation of symmetry BCs of $ \tens{R} $

  • 1: true (default)
  • 0: false

◆ idifre

integer(c_int), pointer, save idifre

whole treatment of the diagonal part of the diffusion tensor of $ \tens{R} $ and $ \varepsilon $

  • 1: true (default)
  • 0: simplified treatment

◆ idirsm

integer(c_int), pointer, save idirsm

Turbulent diffusion model for second moment closure.

  • 0: scalar diffusivity (Shir model)
  • 1: tensorial diffusivity (Daly and Harlow model, default model)

◆ idries

integer(c_int), pointer, save idries

Activates or the van Driest wall-damping for the Smagorinsky constant (the Smagorinsky constant is multiplied by the damping function $1-e^{-y^+/ cdries}$, where $y^+$ designates the non-dimensional distance to the nearest wall).

  • 1: true
  • 0: false The default value is 1 for the Smagorinsky model and 0 for the dynamic model.
    The van Driest wall-damping requires the knowledge of the distance to the nearest wall for each cell in the domain. Refer to keyword icdpar for potential limitations.
    Useful if and only if iturb = 40 or 41

◆ igrake

integer(c_int), pointer, save igrake

Indicates if the terms related to gravity are taken into account in the equations of $k-\epsilon$.

  • 1: true (default if $ \rho $ is variable)
  • 0: false Useful if and only if iturb = 20, 21, 50 or 60 and (gx, gy, gz}) $\ne$ (0,0,0) and the density is not uniform.

◆ igrari

integer(c_int), pointer, save igrari

Indicates if the terms related to gravity are taken into account in the equations of $R_{ij}-\varepsilon$.

  • 1: true (default if $ \rho $ is variable)
  • 0: false Useful if and only if iturb = 30 or 31 and (gx, gy, gz}) $\ne$ (0,0,0) ( $R_{ij}-\epsilon$ model with gravity) and the density is not uniform.

◆ igrhok

integer(c_int), pointer, save igrhok

Indicates if the term $\frac{2}{3}\grad \rho k$ is taken into account in the velocity equation.

  • 1: true
  • 0: false in the velocity
    Useful if and only if iturb = 20, 21, 50 or 60.
    This term may generate non-physical velocities at the wall. When it is not explicitly taken into account, it is implicitly included into the pressure.

◆ iicc

integer(c_int), pointer, save iicc

Applied or not the Internal Consistency Constraint (ICC) for the HTLES model, in order to recover the correct RANS behavior when the energy ratio is forced to one in the RANS region:

  • 1: True (default)
  • 0: False Useful if and only if hybrid_turb=4

◆ ikecou

integer(c_int), pointer, save ikecou

Indicates if the coupling of the source terms of $k$ and $\epsilon$ or $k$ and $\omega$ is taken into account or not.

  • 1: true,
  • 0: false
    If ikecou = 0 in $k-\epsilon$ model, the term in $\epsilon$ in the equation of $k$ is made implicit.
    ikecou is initialised to 0 if iturb = 21 or 60, and to 1 if iturb = 20.
    ikecou = 1 is forbidden when using the v2f model (iturb = 50).
    Useful if and only if iturb = 20, 21 or 60 ( $k-\epsilon$ and $k-\omega$ models)

◆ ikwcln

integer, save ikwcln = 1

Wall boundary condition on omega in k-omega SST 0: Deprecated Neumann boundary condition 1: Dirichlet boundary condition consistent with Menter's original model: w_wall = 60*nu/(beta*d**2)

◆ irccor

integer(c_int), pointer, save irccor

Activation of rotation/curvature correction for eddy viscosity turbulence models.

  • 0: false
  • 1: true

◆ irijco

integer(c_int), pointer, save irijco

Coupled solving of $ \tens{R} $.

  • 1: true
  • 0: false (default)

◆ irijec

integer(c_int), pointer, save irijec

Indicates if the wall echo terms in $R_{ij}-\epsilon$ LRR model are taken into account:

  • 1: true,
  • 0: false (default)
    Useful if and only if iturb = 30 ( $R_{ij}-\epsilon$ LRR).
    It is not recommended to take these terms into account: they have an influence only near the walls, their expression is hardly justifiable according to some authors and, in the configurations studied with code_saturne, they did not bring any improvement in the results.
    In addition, their use induces an increase in the calculation time.
    The wall echo terms imply the calculation of the distance to the wall for every cell in the domain. See icdpar for potential restrictions due to this.

◆ irijnu

integer(c_int), pointer, save irijnu

pseudo eddy viscosity in the matrix of momentum equation to partially implicit $ \divv \left( \rho \tens{R} \right) $

  • 1: true
  • 0: false (default) The goal is to improve the stability of the calculation. The usefulness of irijnu = 1 has however not been clearly demonstrated.
    Since the system is solved in incremental form, this extra turbulent viscosity does not change the final solution for steady flows. However, for unsteady flows, the parameter nswrsm should be increased.
    Useful if and only if iturb = 30 or 31 ( $R_{ij}-\epsilon$ model).

◆ irijrb

integer(c_int), pointer, save irijrb

accurate treatment of $ \tens{R} $ at the boundary (see condli)

  • 1: true
  • 0: false (default)

◆ ishield

integer(c_int), pointer, save ishield

Applied or not the two-fold shielding function ( $f_s(\xi_K,\xi_D)$ of HTLES, to properly control the RANS-to-LES transition in the vicinity of the wall:

  • 1: True (default)
  • 0: False Useful if and only if hybrid_turb=4

◆ iturb

integer(c_int), pointer, save iturb

turbulence model

  • 0: no turbulence model (laminar flow)
  • 10: mixing length model
  • 20: standard $ k-\varepsilon $ model
  • 21: $ k-\varepsilon $ model with Linear Production (LP) correction
  • 30: $ R_{ij}-\epsilon $ (LRR)
  • 31: $ R_{ij}-\epsilon $ (SSG)
  • 32: $ R_{ij}-\epsilon $ (EBRSM)
  • 40: LES (constant Smagorinsky model)
  • 41: LES ("classical" dynamic Smagorisky model)
  • 42: LES (WALE)
  • 50: v2f phi-model
  • 51: v2f $ BL-v^2-k $
  • 60: $ k-\omega $ SST
  • 70: Spalart-Allmaras model

◆ itycor

integer(c_int), pointer, save itycor

Type of rotation/curvature correction for eddy viscosity turbulence models.

  • 1 Cazalbou correction (default when irccor=1 and itytur=2 or 5)
  • 2 Spalart-Shur correction (default when irccor=1 and iturb=60 or 70)

◆ itytur

integer(c_int), pointer, save itytur

Class of turbulence model (integer value iturb/10)

◆ iwalfs

integer(c_int), pointer, save iwalfs

Wall functions for scalar.

  • 0: three layer wall function of Arpaci and Larsen
  • 1: Van Driest wall function

◆ iwallf

integer(c_int), pointer, save iwallf

Wall functions Indicates the type of wall function used for the velocity boundary conditions on a frictional wall.

  • 0: no wall functions
  • 1: one scale of friction velocities (power law)
  • 2: one scale of friction velocities (log law)
  • 3: two scales of friction velocities (log law)
  • 4: two scales of friction velocities (log law) (scalable wall functions)
  • 5: two scales of friction velocities (mixing length based on V. Driest analysis)
  • 6: wall function unifying rough and smooth friction regimes
  • 7: All $ y^+ $ for low Reynolds models
    iwallf is initialised to 2 for iturb = 10, 40, 41 or 70 (mixing length, LES and Spalart Allmaras).
    iwallf is initialised to 0 for iturb = 0, 32, 50 or 51
    iwallf is initialised to 3 for iturb = 20, 21, 30, 31 or 60 ( $k-\epsilon$, $R_{ij}-\epsilon$ LRR, $R_{ij}-\epsilon$ SSG and $ k-\omega$ SST models).
    The v2f model (iturb=50) is not designed to use wall functions (the mesh must be low Reynolds).
    The value iwallf = 3 is not compatible with iturb=0, 10, 40 or 41 (laminar, mixing length and LES).
    Concerning the $k-\epsilon$ and $R_{ij}-\epsilon$ models, the two-scales model is usually at least as satisfactory as the one-scale model.
    The scalable wall function allows to virtually shift the wall when necessary in order to be always in a logarithmic layer. It is used to make up for the problems related to the use of High-Reynolds models on very refined meshes.
    Useful if iturb is different from 50.

◆ nvarcl

integer, save nvarcl

number of variable (deprecated, used only for compatibility)

◆ reinit_turb

integer(c_int), pointer, save reinit_turb

Advanced re-init for EBRSM and k-omega models.

  • 1: true
  • 0: false (default)