Base class for all compressible flow LES SGS models. More...
#include <compressibleLESModels/LESModel.H>
Base class for all compressible flow LES SGS models.
This class defines the basic interface for a compressible flow SGS model, and encapsulates data of value to all possible models. In particular this includes references to all the dependent fields (rho, U, phi), the physical viscosity mu, and the LESProperties dictionary, which contains the model selection and model coefficients.
Definition at line 71 of file LESModel.H.
Public Member Functions | |
TypeName ("LESModel") | |
Runtime type information. | |
declareRunTimeSelectionTable (autoPtr, LESModel, dictionary,(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel),(rho, U, phi, thermoPhysicalModel)) | |
LESModel (const word &type, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel) | |
Construct from components. | |
virtual | ~LESModel () |
Destructor. | |
const dictionary & | coeffDict () const |
Const access to the coefficients dictionary,. | |
const dimensionedScalar & | k0 () const |
Return the value of k0 which k is not allowed to be less than. | |
dimensionedScalar & | k0 () |
Allow k0 to be changed. | |
const volScalarField & | delta () const |
Access function to filter width. | |
virtual tmp< volScalarField > | k () const =0 |
Return the SGS turbulent kinetic energy. | |
virtual tmp< volScalarField > | epsilon () const =0 |
Return the SGS turbulent dissipation. | |
virtual tmp< volScalarField > | muSgs () const =0 |
Return the SGS turbulent viscosity. | |
virtual tmp< volScalarField > | muEff () const |
Return the effective viscosity. | |
virtual tmp< volScalarField > | alphaSgs () const =0 |
Return the SGS turbulent thermal diffusivity. | |
virtual tmp< volScalarField > | alphaEff () const =0 |
Return the SGS thermal conductivity. | |
virtual tmp< volSymmTensorField > | B () const =0 |
Return the sub-grid stress tensor. | |
virtual tmp< volSymmTensorField > | devRhoBeff () const =0 |
Return the deviatoric part of the effective sub-grid. | |
virtual tmp< fvVectorMatrix > | divDevRhoBeff (volVectorField &U) const =0 |
Returns div(rho*dev(B)). | |
virtual tmp< volScalarField > | mut () const |
Return the turbulence viscosity. | |
virtual tmp< volScalarField > | alphat () const |
Return the turbulence thermal diffusivity. | |
virtual tmp< volSymmTensorField > | R () const |
Return the Reynolds stress tensor. | |
virtual tmp< volSymmTensorField > | devRhoReff () const |
Return the effective stress tensor including the laminar stress. | |
virtual tmp< fvVectorMatrix > | divDevRhoReff (volVectorField &U) const |
Return the source term for the momentum equation. | |
void | correct () |
Correct Eddy-Viscosity and related properties. | |
virtual void | correct (const tmp< volTensorField > &gradU) |
Correct Eddy-Viscosity and related properties. | |
virtual bool | read ()=0 |
Read LESProperties dictionary. | |
![]() | |
TypeName ("turbulenceModel") | |
Runtime type information. | |
declareRunTimeNewSelectionTable (autoPtr, turbulenceModel, turbulenceModel,(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel),(rho, U, phi, thermoPhysicalModel)) | |
turbulenceModel (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel) | |
Construct from components. | |
virtual | ~turbulenceModel () |
Destructor. | |
const volScalarField & | rho () const |
Access function to density field. | |
const volVectorField & | U () const |
Access function to velocity field. | |
const surfaceScalarField & | phi () const |
Access function to flux field. | |
const basicThermo & | thermo () const |
Access function to thermophysical model. | |
const volScalarField & | mu () const |
Return the laminar viscosity. | |
const volScalarField & | alpha () const |
Return the laminar thermal conductivity. | |
virtual tmp< fvVectorMatrix > | divDevRhoReff (volVectorField &U) const =0 |
Return the source term for the momentum equation. | |
![]() | |
TypeName ("dictionary") | |
IOdictionary (const IOobject &) | |
Construct given an IOobject. | |
IOdictionary (const IOobject &, const dictionary &) | |
Construct given an IOobject and dictionary. | |
virtual | ~IOdictionary () |
const word & | name () const |
Name function is needed to disambiguate those inherited. | |
bool | readData (Istream &) |
ReadData function required for regIOobject read operation. | |
bool | writeData (Ostream &) const |
WriteData function required for regIOobject write operation. | |
virtual bool | write () const |
Write using setting from DB. | |
void | operator= (const IOdictionary &) |
Assignment of other IOdictionary's entries to this IOdictionary. | |
![]() | |
TypeName ("regIOobject") | |
Runtime type information. | |
regIOobject (const IOobject &, const bool isTime=false) | |
Construct from IOobject. Optional flag for if IOobject is the. | |
regIOobject (const regIOobject &) | |
Construct as copy. | |
regIOobject (const regIOobject &, bool registerCopy) | |
Construct as copy, and transferring registry registration to copy. | |
virtual | ~regIOobject () |
bool | checkIn () |
Add object to registry. | |
bool | checkOut () |
Remove object from registry. | |
bool | ownedByRegistry () const |
Is this object owned by the registry? | |
void | store () |
Transfer ownership of this object to its registry. | |
void | release () |
Release ownership of this object from its registry. | |
label | eventNo () const |
Event number at last update. | |
label & | eventNo () |
Event number at last update. | |
bool | upToDate (const word &) const |
Am I uptodate with respect to other regIOobjects. | |
bool | upToDate (const word &, const word &) const |
bool | upToDate (const word &, const word &, const word &) const |
bool | upToDate (const word &, const word &, const word &, const word &) const |
void | setUpToDate () |
Flag me as up to date. | |
virtual void | rename (const word &newName) |
Rename. | |
Istream & | readStream (const word &) |
Return Istream and check object type against that given. | |
void | close () |
Close Istream. | |
virtual bool | modified () const |
Return true if the object's file has been modified. | |
virtual bool | readIfModified () |
Read object if modified. | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const |
Write using given format, version and compression. | |
void | operator= (const IOobject &) |
![]() | |
TypeName ("IOobject") | |
Runtime type information. | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, registry, io options. | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, local, registry, io options. | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. | |
Foam::autoPtr< IOobject > | clone () const |
Clone. | |
virtual | ~IOobject () |
const Time & | time () const |
Return time. | |
const objectRegistry & | db () const |
Return the local objectRegistry. | |
const word & | headerClassName () const |
Return name of the class name read from header. | |
string & | note () |
Return non-constant access to the optional note. | |
const string & | note () const |
Return the optional note. | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. | |
fileName | objectPath () const |
Return complete path + object name. | |
fileName | filePath () const |
Return complete path + object name if the file exists. | |
bool | readHeader (Istream &) |
Read header. | |
bool | headerOk () |
Read and check header info. | |
bool | writeHeader (Ostream &) const |
Write header. | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. | |
![]() | |
ClassName ("dictionary") | |
dictionary () | |
Construct top-level dictionary null. | |
dictionary (const fileName &name) | |
Construct top-level empty dictionary with given name. | |
dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
Construct given the entry name, parent dictionary and Istream,. | |
dictionary (Istream &) | |
Construct top-level dictionary from Istream, reading entries. | |
dictionary (const dictionary &parentDict, const dictionary &) | |
Construct as copy given the parent dictionary. | |
dictionary (const dictionary &) | |
Construct top-level dictionary as copy. | |
dictionary (const dictionary *) | |
Construct top-level dictionary as copy from pointer to dictionary. | |
dictionary (const dictionary &parentDict, const Xfer< dictionary > &) | |
Construct by transferring parameter contents given parent dictionary. | |
dictionary (const Xfer< dictionary > &) | |
Construct top-level dictionary by transferring parameter contents. | |
autoPtr< dictionary > | clone () const |
Construct and return clone. | |
~dictionary () | |
const dictionary & | parent () const |
Return the parent dictionary. | |
label | startLineNumber () const |
Return line number of first token in dictionary. | |
label | endLineNumber () const |
Return line number of last token in dictionary. | |
SHA1Digest | digest () const |
Return the SHA1 digest of the dictionary contents. | |
bool | found (const word &, bool recursive=false) const |
Search dictionary for given keyword. | |
const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream pointer if present. | |
entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
Find and return an entry data stream pointer for manipulation. | |
const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present otherwise error. | |
ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return an entry data stream. | |
template<class T > | |
T | lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T,. | |
template<class T > | |
T | lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) |
Find and return a T, if not found return the given. | |
template<class T > | |
bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
Find an entry if present, and assign to T. | |
bool | isDict (const word &) const |
Check if entry is a sub-dictionary. | |
const dictionary * | subDictPtr (const word &) const |
Find and return a sub-dictionary pointer if present. | |
const dictionary & | subDict (const word &) const |
Find and return a sub-dictionary. | |
dictionary & | subDict (const word &) |
Find and return a sub-dictionary for manipulation. | |
dictionary | subOrEmptyDict (const word &) const |
Find and return a sub-dictionary as a copy, or. | |
wordList | toc () const |
Return the table of contents. | |
List< keyType > | keys (bool patterns=false) const |
Return the list of available keys or patterns. | |
bool | substituteKeyword (const word &keyword) |
Substitute the given keyword prepended by '$' with the. | |
bool | add (entry *, bool mergeEntry=false) |
Add a new entry. | |
void | add (const entry &, bool mergeEntry=false) |
Add an entry. | |
void | add (const keyType &, const word &, bool overwrite=false) |
Add a word entry. | |
void | add (const keyType &, const string &, bool overwrite=false) |
Add a string entry. | |
void | add (const keyType &, const label, bool overwrite=false) |
Add a label entry. | |
void | add (const keyType &, const scalar, bool overwrite=false) |
Add a scalar entry. | |
void | add (const keyType &, const dictionary &, bool mergeEntry=false) |
Add a dictionary entry. | |
template<class T > | |
void | add (const keyType &, const T &, bool overwrite=false) |
Add a T entry. | |
void | set (entry *) |
Assign a new entry, overwrite any existing entry. | |
void | set (const entry &) |
Assign a new entry, overwrite any existing entry. | |
void | set (const keyType &, const dictionary &) |
Assign a dictionary entry, overwrite any existing entry. | |
template<class T > | |
void | set (const keyType &, const T &) |
Assign a T entry, overwrite any existing entry. | |
bool | remove (const word &) |
Remove an entry specified by keyword. | |
bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false) |
Change the keyword for an entry,. | |
bool | merge (const dictionary &) |
Merge entries from the given dictionary. | |
void | clear () |
Clear the dictionary. | |
void | transfer (dictionary &) |
Transfer the contents of the argument and annul the argument. | |
Xfer< dictionary > | xfer () |
Transfer contents to the Xfer container. | |
bool | read (Istream &) |
Read dictionary from Istream. | |
void | write (Ostream &, bool subDict=true) const |
ITstream & | operator[] (const word &) const |
Find and return entry. | |
void | operator= (const dictionary &) |
void | operator+= (const dictionary &) |
Include entries from the given dictionary. | |
void | operator|= (const dictionary &) |
Conditionally include entries from the given dictionary. | |
void | operator<<= (const dictionary &) |
Unconditionally include entries from the given dictionary. | |
![]() | |
dictionaryName () | |
Construct dictionaryName null. | |
dictionaryName (const fileName &name) | |
Construct dictionaryName as copy of the given fileName. | |
fileName & | name () |
Return the dictionary name. | |
![]() | |
IDLList () | |
Null construct. | |
IDLList (const entry &a) | |
Construct given initial T. | |
IDLList (Istream &is, const INew &inewt) | |
Construct from Istream using given Istream constructor class. | |
IDLList (Istream &is) | |
Construct from Istream. | |
IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. | |
![]() | |
ILList () | |
Null construct. | |
ILList (entry *a) | |
Construct given initial T. | |
ILList (Istream &) | |
Construct from Istream. | |
ILList (const ILList< DLListBase, entry > &) | |
Construct as copy. | |
ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. | |
ILList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. | |
~ILList () | |
bool | eraseHead () |
Remove the head element specified from the list and delete it. | |
bool | erase (entry *p) |
Remove the specified element from the list and delete it. | |
void | transfer (ILList< DLListBase, entry > &) |
Transfer the contents of the argument into this List. | |
void | operator= (const ILList< DLListBase, entry > &) |
![]() | |
UILList () | |
Null construct. | |
UILList (entry *a) | |
Construct given initial T. | |
UILList (const UILList< DLListBase, entry > &) | |
Construct as copy. | |
entry * | first () |
Return the first entry. | |
const entry * | first () const |
Return the first entry. | |
entry * | last () |
Return the last entry. | |
const entry * | last () const |
Return the last entry. | |
entry * | removeHead () |
Remove and return head. | |
entry * | remove (entry *p) |
Remove and return element. | |
entry * | remove (iterator &it) |
Remove and return specified by iterator. | |
void | operator= (const UILList< DLListBase, entry > &) |
bool | operator== (const UILList< DLListBase, entry > &) const |
Equality operation on ULists of the same type. | |
bool | operator!= (const UILList< DLListBase, entry > &) const |
The opposite of the equality operation. Takes linear time. | |
![]() | |
DLListBase () | |
Null construct. | |
DLListBase (link *) | |
Construct given initial entry. | |
~DLListBase () | |
label | size () const |
Return number of elements in list. | |
bool | empty () const |
Return true if the list is empty. | |
void | insert (link *) |
Add at head of list. | |
void | append (link *) |
Add at tail of list. | |
bool | swapUp (link *) |
Swap this element with the one above unless it is at the top. | |
bool | swapDown (link *) |
Swap this element with the one below unless it is at the bottom. | |
link * | remove (link *) |
Remove and return element. | |
link * | replace (link *oldLink, link *newLink) |
Replace oldLink with newLink and return element. | |
link * | replace (iterator &oldIter, link *newLink) |
Replace oldIter with newLink and return element. | |
void | transfer (DLListBase &) |
Transfer the contents of the argument into this List. | |
iterator | begin () |
const iterator & | end () |
const_iterator | cbegin () const |
const const_iterator & | cend () const |
const_iterator | begin () const |
const const_iterator & | end () const |
Static Public Member Functions | |
static autoPtr< LESModel > | New (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel) |
Return a reference to the selected LES model. | |
![]() | |
static autoPtr< turbulenceModel > | New (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel) |
Return a reference to the selected turbulence model. |
Protected Member Functions | |
virtual void | printCoeffs () |
Print model coefficients. |
Protected Attributes | |
Switch | printCoeffs_ |
dictionary | coeffDict_ |
dimensionedScalar | k0_ |
autoPtr< LESdelta > | delta_ |
![]() | |
const Time & | runTime_ |
const fvMesh & | mesh_ |
const volScalarField & | rho_ |
const volVectorField & | U_ |
const surfaceScalarField & | phi_ |
const basicThermo & | thermophysicalModel_ |
LESModel | ( | const word & | type, |
const volScalarField & | rho, | ||
const volVectorField & | U, | ||
const surfaceScalarField & | phi, | ||
const basicThermo & | thermoPhysicalModel | ||
) |
|
inlinevirtual |
Destructor.
Definition at line 155 of file LESModel.H.
|
protectedvirtual |
Print model coefficients.
Definition at line 44 of file LESModel.C.
References Foam::endl(), Foam::Info, and Foam::type().
TypeName | ( | "LESModel" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
LESModel | , | ||
dictionary | , | ||
(const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const basicThermo &thermoPhysicalModel) | , | ||
(rho, U, phi, thermoPhysicalModel) | |||
) |
|
static |
Return a reference to the selected LES model.
Definition at line 96 of file LESModel.C.
References TimePaths::constant(), IOobject::db(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, Foam::Info, dictionary::lookup(), IOobject::MUST_READ, IOobject::NO_WRITE, phi, rho, IOobject::time(), and U.
|
inline |
Const access to the coefficients dictionary,.
which provides info. about choice of models, and all related data (particularly model coefficients).
Definition at line 166 of file LESModel.H.
References LESModel::coeffDict_.
|
inline |
Return the value of k0 which k is not allowed to be less than.
Definition at line 172 of file LESModel.H.
References LESModel::k0_.
|
inline |
|
inline |
Access function to filter width.
Definition at line 184 of file LESModel.H.
References LESModel::delta_.
Referenced by GenEddyVisc::epsilon(), and GenSGSStress::epsilon().
|
pure virtual |
Return the SGS turbulent kinetic energy.
Implements turbulenceModel.
Implemented in SpalartAllmaras, GenEddyVisc, and GenSGSStress.
|
pure virtual |
Return the SGS turbulent dissipation.
Implements turbulenceModel.
Implemented in SpalartAllmaras, GenEddyVisc, and GenSGSStress.
|
pure virtual |
Return the SGS turbulent viscosity.
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
Referenced by alphaSgsWallFunctionFvPatchScalarField::evaluate(), alphaSgsJayatillekeWallFunctionFvPatchScalarField::evaluate(), LESModel::muEff(), and LESModel::mut().
|
inlinevirtual |
Return the effective viscosity.
Implements turbulenceModel.
Definition at line 200 of file LESModel.H.
References mu, and LESModel::muSgs().
|
pure virtual |
Return the SGS turbulent thermal diffusivity.
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
Referenced by LESModel::alphat().
|
pure virtual |
Return the SGS thermal conductivity.
Implements turbulenceModel.
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
|
pure virtual |
Return the sub-grid stress tensor.
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
Referenced by LESModel::R().
|
pure virtual |
Return the deviatoric part of the effective sub-grid.
turbulence stress tensor including the laminar stress
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
Referenced by LESModel::devRhoReff().
|
pure virtual |
Returns div(rho*dev(B)).
This is the additional term due to the filtering of the NSE.
Implemented in SpalartAllmaras, GenSGSStress, and GenEddyVisc.
Referenced by LESModel::divDevRhoReff().
|
inlinevirtual |
Return the turbulence viscosity.
Implements turbulenceModel.
Definition at line 229 of file LESModel.H.
References LESModel::muSgs().
|
inlinevirtual |
Return the turbulence thermal diffusivity.
Definition at line 235 of file LESModel.H.
References LESModel::alphaSgs().
|
inlinevirtual |
Return the Reynolds stress tensor.
Implements turbulenceModel.
Definition at line 241 of file LESModel.H.
References LESModel::B().
|
inlinevirtual |
Return the effective stress tensor including the laminar stress.
Implements turbulenceModel.
Definition at line 247 of file LESModel.H.
References LESModel::devRhoBeff().
|
inlinevirtual |
Return the source term for the momentum equation.
Definition at line 253 of file LESModel.H.
References LESModel::divDevRhoBeff().
|
virtual |
Correct Eddy-Viscosity and related properties.
This calls correct(const tmp<volTensorField>& gradU) by supplying gradU calculated locally.
Implements turbulenceModel.
Definition at line 154 of file LESModel.C.
References correct(), and Foam::fvc::grad().
|
virtual |
Correct Eddy-Viscosity and related properties.
Reimplemented in SpalartAllmaras, GenSGSStress, GenEddyVisc, dynOneEqEddy, DeardorffDiffStress, oneEqEddy, lowReOneEqEddy, and Smagorinsky.
Definition at line 148 of file LESModel.C.
|
pure virtual |
Read LESProperties dictionary.
Implements turbulenceModel.
Implemented in SpalartAllmaras, GenSGSStress, GenEddyVisc, dynOneEqEddy, DeardorffDiffStress, oneEqEddy, lowReOneEqEddy, and Smagorinsky.
Definition at line 160 of file LESModel.C.
References regIOobject::read(), readIfPresent(), and Foam::type().
|
protected |
Definition at line 81 of file LESModel.H.
|
protected |
Definition at line 82 of file LESModel.H.
Referenced by LESModel::coeffDict().
|
protected |
Definition at line 84 of file LESModel.H.
Referenced by LESModel::k0().
Definition at line 86 of file LESModel.H.
Referenced by LESModel::delta().