# coding=utf-8
"""turbulenceProperties class.
Use turbulenceProperties for versions prior to 3.0+
"""
from foamfile import FoamFile, foam_file_from_file
from collections import OrderedDict
[docs]class TurbulenceProperties(FoamFile):
"""Turbulence Properties class."""
# set default valus for this class
__default_values = OrderedDict()
__default_values['simulationType'] = 'laminar'
__RASModels = ('LRR', 'LamBremhorstKE', 'LaunderSharmaKE', 'LienCubicKE',
'LienLeschziner', 'RNGkEpsilon', 'SSG', 'ShihQuadraticKE',
'SpalartAllmaras', 'kEpsilon', 'kOmega', 'kOmegaSSTSAS',
'kkLOmega', 'qZeta', 'realizableKE', 'v2f', 'buoyantKEpsilon')
__LESModels = ('DeardorffDiffStress', 'Smagorinsky', 'SpalartAllmarasDDES',
'SpalartAllmarasDES', 'SpalartAllmarasIDDES', 'WALE',
'dynamicKEqn', 'dynamicLagrangian', 'kEqn', 'kOmegaSSTDES')
def __init__(self, values=None):
"""Init class."""
FoamFile.__init__(self, name='turbulenceProperties', cls='dictionary',
location='constant', default_values=self.__default_values,
values=values)
[docs] @classmethod
def from_file(cls, filepath):
"""Create a FoamFile from a file.
Args:
filepath: Full file path to dictionary.
"""
return cls(values=foam_file_from_file(filepath, cls.__name__))
[docs] @classmethod
def laminar(cls):
"""Laminar model."""
return cls()
[docs] @classmethod
def RAS(cls, 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
Args:
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.
"""
# check RASModel input
assert RASModel in cls.__RASModels, \
'{} is not a valid input for RASModel.' \
' Try one of the models below:\n{}'.format(RASModel, cls.__RASModels)
values = {'simulationType': 'RAS', 'RAS': {
'RASModel': RASModel,
'turbulence': FoamFile.convert_bool_value(turbulence),
'printCoeffs': FoamFile.convert_bool_value(printCoeffs)}
}
if RASModel_coeffs:
values['RAS'].update({'%sCoeffs' % RASModel: RASModel_coeffs})
return cls(values=values)
[docs] @classmethod
def LES(cls, LESModel='kEqn', delta='cubeRootVol', turbulence=True,
printCoeffs=True, LESModel_coeffs=None, delta_coeffs=None):
"""Large eddy simulation (LES) modelling.
Args:
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.
"""
assert LESModel in cls.__LESModels, \
'{} is not a valid input for LESModels.' \
' Try one of the models below:\n{}'.format(LESModel, cls.__LESModels)
values = {'simulationType': 'LES', 'LES': {
'LESModel': LESModel,
'delta': delta,
'turbulence': FoamFile.convert_bool_value(turbulence),
'printCoeffs': FoamFile.convert_bool_value(printCoeffs)}
}
if LESModel_coeffs:
values['LES'].update({'%sCoeffs' % LESModel: LESModel_coeffs})
if delta_coeffs:
values['LES'].update({'%sCoeffs' % delta_coeffs: delta_coeffs})
return cls(values=values)
@property
def isTurbulenceProperties(self):
"""Return True."""
return True
