flow360.TurbulenceQuantities

flow360.TurbulenceQuantities#

TurbulenceQuantities(viscosity_ratio=None, modified_viscosity_ratio=None, modified_viscosity=None, specific_dissipation_rate=None, turbulent_kinetic_energy=None, turbulent_length_scale=None, turbulent_intensity=None)[source]#

TurbulenceQuantities() function specifies turbulence conditions for the Inflow or Freestream at boundaries. The turbulence properties that can be specified are listed below. All values are dimensional. For valid specifications as well as the default values, please see the Notes section below.

Parameters:
  • viscosity_ratio (>= 0) – The ratio between the turbulent viscosity and freestream laminar viscosity. Applicable to both KOmegaSST and SpalartAllmaras. Its value will be converted to modifiedTurbulentViscosityRatio when using SpalartAllmaras model.

  • modified_viscosity_ratio (>= 0) – The ratio between the modified turbulent viscosity (in SA model) and freestream laminar viscosity. Applicable to SpalartAllmaras.

  • modified_viscosity (>=0) – The modified turbulent viscosity, aka nuHat. Applicable to SpalartAllmaras.

  • specific_dissipation_rate (>= 0) – The turbulent specific dissipation rate. Applicable to KOmegaSST.

  • turbulent_kinetic_energy (>=0) – The turbulent kinetic energy. Applicable to KOmegaSST.

  • turbulent_length_scale (> 0) – The turbulent length scale is an estimation of the size of the eddies that are modeled/not resolved. Applicable to KOmegaSST.

  • turbulent_intensity (>= 0) – The turbulent intensity is related to the turbulent kinetic energy by \(k = 1.5(U_{ref} * I)^2\) where \(k\) is the dimensional turbulent kinetic energy, \(U_{ref}\) is the reference velocity and \(I\) is the turbulent intensity. The value represents the actual magnitude of intensity instead of percentage. Applicable to KOmegaSST.

Return type:

A matching tubulence specification object.

Raises:

ValueError – If the TurbulenceQuantities inputs do not represent a valid specification.