kEpsilonViscosity

kEpsilonViscosity is an auxiliary kernel that computes the turbulent dynamic viscosity used in the k– family of turbulence models. It forms the closure term for the Reynolds stresses in the momentum equations:

where the turbulent time scale and the effective coefficient depend on the selected k– variant and the local flow state.

This object implements:

  • Standard, Low-Re, Two-Layer, and Realizable viscosity formulations,

  • Several wall treatments (Newton, incremental, linearized, non-equilibrium),

  • Two-layer near-wall blending methods (Wolfstein (1969), NORRIS III (1975), Xu et al. (1998)),

  • Low-Re damping functions for the StandardLowRe model,

  • Realizable variable ,

  • Optional scale limiting for the time scale,

  • Bulk and near-wall formulations that match Menter-type corrections Menter (1994).

Turbulent viscosity in the bulk region

Away from walls (or when [bulk_wall_treatment=false]), the turbulent viscosity is computed as:

where:

  • is the turbulent kinetic energy,

  • is the fluid density,

  • depends on the k– variant,

  • is the turbulent time scale (possibly limited).

Turbulent time scale

The base time scale is:

If [scale_limiter=standard], the time scale is limited using:

where:

  • is the molecular kinematic viscosity,

  • is a model constant,

  • The second term becomes important near walls or when becomes too large.

If [scale_limiter=none], then .

Effective coefficient

The meaning of varies based on the selected turbulence variant:

Standard k–

StandardLowRe

Low-Re models use a damping function :

where is computed as:

with:

and is the wall distance (supplied via a functor).

Realizable k–

The realizable model computes dynamically as a function of strain and rotation:

where:

  • ,

  • .

This value replaces the standard constant everywhere in the model.

Two-layer models (StandardTwoLayer and RealizableTwoLayer)

Two-layer models blend between:

  • an outer k– viscosity,

  • an inner near-wall viscosity based on two-layer relations.

Let:

  • ,

  • = near-wall turbulent viscosity from the chosen flavor (Wolfstein, Norris–Reynolds, or Xu), see the theory section for more details.

Using the wall-distance Reynolds number , the two-layer blending function is:

with:

  • ,

  • chosen such that at .

The final viscosity is:

Near-wall bulk treatment

When [bulk_wall_treatment=true], the kernel applies wall functions to compute in wall-bounded cells.

The procedure:

  1. Identify the minimum wall distance in the cell.

  2. Compute the tangential velocity and friction velocity .

  3. Compute the nondimensional wall distance:

  1. Classify into:

  • Viscous sublayer: ,

  • Log‑layer: (see theory for more details),

  • Buffer layer: linear blending between the two regimes.

Four wall-function types are supported:

  • eq_newton

  • eq_incremental

  • eq_linearized

  • neq (non-equilibrium using local )

Each provides a different method for computing and the corresponding .

This wall-function implementation is fully consistent with the finite-volume INSFVTurbulentViscosity models used in the Navier–Stokes FV physics.

Wall distance requirements

The following variants require a wall-distance functor:

  • StandardTwoLayer

  • RealizableTwoLayer

  • StandardLowRe

If a required functor is missing, the kernel throws an error during construction.

Interaction with k and kernels

kEpsilonViscosity is tightly coupled with the k and kernels:

  • It uses k and to compute viscosity.

  • The k and kernels require to compute production and destruction terms.

  • Realizable and nonlinear models require strain/rotation invariants also used by k and kernels.

  • Two-layer models require consistency between: - -equation two-layer region, - viscosity two-layer region.

This object must therefore be included in every k– turbulence simulation.

Input Parameters

  • epsilonCoupled turbulent kinetic energy dissipation rate. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Coupled turbulent kinetic energy dissipation rate. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • muDynamic viscosity. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Dynamic viscosity. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • rhoDensity. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Density. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • tkeCoupled turbulent kinetic energy. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Coupled turbulent kinetic energy. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • uThe velocity in the x direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the x direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • variableThe name of the variable that this object applies to

    C++ Type:AuxVariableName

    Unit:(no unit assumed)

    Controllable:No

    Description:The name of the variable that this object applies to

Required Parameters

  • C_mu0.09Base turbulent kinetic energy closure constant C_mu.

    Default:0.09

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Base turbulent kinetic energy closure constant C_mu.

  • Ca00.667Realizable k-epsilon coefficient Ca0 used in the C_mu expression.

    Default:0.667

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Realizable k-epsilon coefficient Ca0 used in the C_mu expression.

  • Ca11.25Realizable k-epsilon coefficient Ca1 used in the C_mu expression.

    Default:1.25

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Realizable k-epsilon coefficient Ca1 used in the C_mu expression.

  • Ca21Realizable k-epsilon coefficient Ca2 used in the C_mu expression.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Realizable k-epsilon coefficient Ca2 used in the C_mu expression.

  • Ca30.9Realizable k-epsilon coefficient Ca3 used in the C_mu expression.

    Default:0.9

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Realizable k-epsilon coefficient Ca3 used in the C_mu expression.

  • Cd00.091Low-Re coefficient Cd0 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

    Default:0.091

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Low-Re coefficient Cd0 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

  • Cd10.0042Low-Re coefficient Cd1 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

    Default:0.0042

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Low-Re coefficient Cd1 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

  • Cd20.00011Low-Re coefficient Cd2 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

    Default:0.00011

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Low-Re coefficient Cd2 used in the f_mu damping function for the Standard k-epsilon Low-Re model.

  • Ct1Time-scale constant Ct used in the k-epsilon time scale T = max(Te, Ct*sqrt(nu/epsilon)) when scale_limiter='standard'.

    Default:1

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Time-scale constant Ct used in the k-epsilon time scale T = max(Te, Ct*sqrt(nu/epsilon)) when scale_limiter='standard'.

  • blockThe list of blocks (ids or names) that this object will be applied

    C++ Type:std::vector<SubdomainName>

    Controllable:No

    Description:The list of blocks (ids or names) that this object will be applied

  • boundaryThe list of boundaries (ids or names) from the mesh where this object applies

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:The list of boundaries (ids or names) from the mesh where this object applies

  • bulk_wall_treatmentFalseIf true, use classical wall functions for near-wall cells.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:If true, use classical wall functions for near-wall cells.

  • check_boundary_restrictedTrueWhether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

    Default:True

    C++ Type:bool

    Controllable:No

    Description:Whether to check for multiple element sides on the boundary in the case of a boundary restricted, element aux variable. Setting this to false will allow contribution to a single element's elemental value(s) from multiple boundary sides on the same element (example: when the restricted boundary exists on two or more sides of an element, such as at a corner of a mesh

  • execute_onLINEAR TIMESTEP_ENDThe list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

    Default:LINEAR TIMESTEP_END

    C++ Type:ExecFlagEnum

    Options:NONE, INITIAL, LINEAR, LINEAR_CONVERGENCE, NONLINEAR, NONLINEAR_CONVERGENCE, POSTCHECK, TIMESTEP_END, TIMESTEP_BEGIN, MULTIAPP_FIXED_POINT_END, MULTIAPP_FIXED_POINT_BEGIN, MULTIAPP_FIXED_POINT_CONVERGENCE, FINAL, CUSTOM, PRE_DISPLACE

    Controllable:No

    Description:The list of flag(s) indicating when this object should be executed. For a description of each flag, see https://mooseframework.inl.gov/source/interfaces/SetupInterface.html.

  • k_epsilon_variantStandardk-epsilon model variant used for viscosity.

    Default:Standard

    C++ Type:MooseEnum

    Options:Standard, StandardLowRe, StandardTwoLayer, Realizable, RealizableTwoLayer

    Controllable:No

    Description:k-epsilon model variant used for viscosity.

  • mu_t_ratio_max100000Maximum allowable mu_t_ratio : mu/mu_t.

    Default:100000

    C++ Type:double

    Unit:(no unit assumed)

    Controllable:No

    Description:Maximum allowable mu_t_ratio : mu/mu_t.

  • scale_limiterstandardThe method used to limit the k-epsilon time scale: 'none' or 'standard' (max(T_e, sqrt(nu/epsilon))).

    Default:standard

    C++ Type:MooseEnum

    Options:none, standard

    Controllable:No

    Description:The method used to limit the k-epsilon time scale: 'none' or 'standard' (max(T_e, sqrt(nu/epsilon))).

  • two_layer_flavorWolfsteinTwo-layer formulation to use for 2L variants (Wolfstein, NorrisReynolds, Xu).

    Default:Wolfstein

    C++ Type:MooseEnum

    Options:Wolfstein, NorrisReynolds, Xu

    Controllable:No

    Description:Two-layer formulation to use for 2L variants (Wolfstein, NorrisReynolds, Xu).

  • vThe velocity in the y direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the y direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • wThe velocity in the z direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:The velocity in the z direction. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • wall_distanceDistance to the closest wall; required for two-layer and Low-Re k-epsilon variants. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

    C++ Type:MooseFunctorName

    Unit:(no unit assumed)

    Controllable:No

    Description:Distance to the closest wall; required for two-layer and Low-Re k-epsilon variants. A functor is any of the following: a variable, a functor material property, a function, a postprocessor or a number.

  • wall_treatmenteq_newtonThe method used for computing the wall functions.

    Default:eq_newton

    C++ Type:MooseEnum

    Options:eq_newton, eq_incremental, eq_linearized, neq

    Controllable:No

    Description:The method used for computing the wall functions.

  • wallsBoundaries that correspond to solid walls.

    C++ Type:std::vector<BoundaryName>

    Controllable:No

    Description:Boundaries that correspond to solid walls.

Optional Parameters

  • control_tagsAdds user-defined labels for accessing object parameters via control logic.

    C++ Type:std::vector<std::string>

    Controllable:No

    Description:Adds user-defined labels for accessing object parameters via control logic.

  • enableTrueSet the enabled status of the MooseObject.

    Default:True

    C++ Type:bool

    Controllable:Yes

    Description:Set the enabled status of the MooseObject.

  • search_methodnearest_node_connected_sidesChoice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).

    Default:nearest_node_connected_sides

    C++ Type:MooseEnum

    Options:nearest_node_connected_sides, all_proximate_sides

    Controllable:No

    Description:Choice of search algorithm. All options begin by finding the nearest node in the primary boundary to a query point in the secondary boundary. In the default nearest_node_connected_sides algorithm, primary boundary elements are searched iff that nearest node is one of their nodes. This is fast to determine via a pregenerated node-to-elem map and is robust on conforming meshes. In the optional all_proximate_sides algorithm, primary boundary elements are searched iff they touch that nearest node, even if they are not topologically connected to it. This is more CPU-intensive but is necessary for robustness on any boundary surfaces which has disconnections (such as Flex IGA meshes) or non-conformity (such as hanging nodes in adaptively h-refined meshes).

  • seed0The seed for the master random number generator

    Default:0

    C++ Type:unsigned int

    Controllable:No

    Description:The seed for the master random number generator

  • use_displaced_meshFalseWhether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:Whether or not this object should use the displaced mesh for computation. Note that in the case this is true but no displacements are provided in the Mesh block the undisplaced mesh will still be used.

Advanced Parameters

  • prop_getter_suffixAn optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

    C++ Type:MaterialPropertyName

    Unit:(no unit assumed)

    Controllable:No

    Description:An optional suffix parameter that can be appended to any attempt to retrieve/get material properties. The suffix will be prepended with a '_' character.

  • use_interpolated_stateFalseFor the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

    Default:False

    C++ Type:bool

    Controllable:No

    Description:For the old and older state use projected material properties interpolated at the quadrature points. To set up projection use the ProjectedStatefulMaterialStorageAction.

Material Property Retrieval Parameters

Input Files

References

  1. Florian R Menter. Two-equation eddy-viscosity turbulence models for engineering applications. AIAA journal, 32(8):1598–1605, 1994.[BibTeX]
  2. H LEE NORRIS III. Turbulent channel flow with a moving wavy boundary. Stanford University, 1975.[BibTeX]
  3. M. Wolfstein. The velocity and temperature distribution in one-dimensional flow with turbulence augmentation and pressure gradient. International Journal of Heat and Mass Transfer, 12(3):301–318, 1969.[BibTeX]
  4. Wen Xu, Q Chen, and FTM Nieuwstadt. A new turbulence model for near-wall natural convection. International Journal of Heat and Mass Transfer, 41(21):3161–3176, 1998.[BibTeX]