butterfly.turbulenceProperties module

turbulenceProperties class.

Use turbulenceProperties for versions prior to 3.0+

class butterfly.turbulenceProperties.TurbulenceProperties(values=None)

Bases: butterfly.foamfile.FoamFile

Turbulence Properties class.

classmethod LES(LESModel='kEqn', delta='cubeRootVol', turbulence=True, printCoeffs=True, LESModel_coeffs=None, delta_coeffs=None)

Large eddy simulation (LES) modelling.

Parameters:

• LESModel –

  Name of LES turbulence model. Incompressible LES turbulence models.

  DeardorffDiffStress, Smagorinsky, SpalartAllmarasDDES, SpalartAllmarasDES, SpalartAllmarasIDDES, WALE, dynamicKEqn, dynamicLagrangian, kEqn, kOmegaSSTDES

  Compressible LES turbulence models.

  DeardorffDiffStress, Smagorinsky, SpalartAllmarasDDES, SpalartAllmarasDES, SpalartAllmarasIDDES, WALE, dynamicKEqn, dynamicLagrangian, kEqn, kOmegaSSTDES

• delta – Name of delta model.
• turbulence – Boolean switch to turn the solving of turbulence modelling on/off (default: True).
• printCoeffs – Boolean switch to print model coeffs to terminal at simulation start up (default: True).
• LESModel_coeffs – Dictionary of coefficients for the respective LESModel, to override the default coefficients.
• delta_coeffs – Dictionary of coefficients for the delta model.

classmethod RAS(RASModel='RNGkEpsilon', turbulence=True, printCoeffs=True, RASModel_coeffs=None)

Reynolds-averaged simulation (RAS) turbulence model.

Read more: http://cfd.direct/openfoam/user-guide/turbulence/ Watch this: https://www.youtube.com/watch?v=Eu_4ppppQmw

Parameters:

• RASModel –

  Name of RAS turbulence model (default: RNGkEpsilon). Incompressible RAS turbulence models:

  LRR, LamBremhorstKE, LaunderSharmaKE, LienCubicKE, LienLeschziner, RNGkEpsilon, SSG, ShihQuadraticKE, SpalartAllmaras, kEpsilon, kOmega, kOmegaSSTSAS, kkLOmega, qZeta, realizableKE, v2f

  Compressible RAS turbulence models:

  LRR, LaunderSharmaKE, RNGkEpsilon, SSG, SpalartAllmaras, buoyantKEpsilon, kEpsilon, kOmega, kOmegaSSTSAS, realizableKE, v2f

• turbulence – Boolean switch to turn the solving of turbulence modelling on/off (default: True).
• printCoeffs – Boolean switch to print model coeffs to terminal at simulation start up (default: True).
• RASModel_coeffs – Optional dictionary of coefficients for the respective RASModel, to override the default coefficients.

classmethod from_file(filepath)

Create a FoamFile from a file.

Parameters:filepath – Full file path to dictionary.

isTurbulenceProperties

Return True.

classmethod laminar()

Laminar model.