Abstract base class for turbulence models (RAS, LES and laminar). More...
Public Member Functions | |
TypeName ("momentumTransport") | |
Runtime type information. More... | |
momentumTransportModel (const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity) | |
Construct from components. More... | |
momentumTransportModel (const momentumTransportModel &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~momentumTransportModel () |
Destructor. More... | |
virtual bool | read ()=0 |
Read model coefficients if they have changed. More... | |
const Time & | time () const |
const fvMesh & | mesh () const |
virtual const dictionary & | coeffDict () const =0 |
Const access to the coefficients dictionary. More... | |
word | groupName (const word &name) const |
word | GName () const |
Helper function to return the name of the turbulence G field. More... | |
const volVectorField & | U () const |
Access function to velocity field. More... | |
const surfaceScalarField & | alphaRhoPhi () const |
Access function to phase flux field. More... | |
virtual tmp< surfaceScalarField > | phi () const |
Return the volumetric flux field. More... | |
const class Foam::viscosity & | properties () const |
Access function to fluid properties. More... | |
const volScalarField & | y () const |
Return the wall distance. More... | |
const volScalarField::Boundary & | yb () const |
Return the near wall distance. More... | |
virtual tmp< volScalarField > | nu () const |
Return the laminar viscosity. More... | |
virtual tmp< scalarField > | nu (const label patchi) const |
Return the laminar viscosity on patchi. More... | |
virtual tmp< volScalarField > | nut () const =0 |
Return the turbulence viscosity. More... | |
virtual tmp< scalarField > | nut (const label patchi) const =0 |
Return the turbulence viscosity on patch. More... | |
virtual tmp< volScalarField > | nuEff () const =0 |
Return the effective viscosity. More... | |
virtual tmp< scalarField > | nuEff (const label patchi) const =0 |
Return the effective viscosity on patch. More... | |
virtual tmp< volScalarField > | k () const =0 |
Return the turbulence kinetic energy. More... | |
virtual tmp< volScalarField > | epsilon () const =0 |
Return the turbulence kinetic energy dissipation rate. More... | |
virtual tmp< volScalarField > | omega () const =0 |
Return the turbulence specific dissipation rate. More... | |
virtual tmp< volSymmTensorField > | sigma () const =0 |
Return the stress tensor [m^2/s^2]. More... | |
virtual tmp< fvVectorMatrix > | divDevTauCorr (const tmp< volTensorField > &devTauCorr, volVectorField &U) const |
Return the explicit stress correction matrix. More... | |
virtual void | validate () |
Validate the fields after construction. More... | |
virtual void | predict ()=0 |
Predict the momentum transport coefficients if possible. More... | |
virtual void | correct ()=0 |
Solve the momentum transport model equations. More... | |
void | operator= (const momentumTransportModel &)=delete |
Disallow default bitwise assignment. More... | |
template<class MomentumTransportModel > | |
Foam::autoPtr< MomentumTransportModel > | New (const typename MomentumTransportModel::alphaField &alpha, const typename MomentumTransportModel::rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity) |
Public Member Functions inherited from IOdictionary | |
TypeName ("dictionary") | |
IOdictionary (const IOobject &) | |
Construct given an IOobject. More... | |
IOdictionary (const IOobject &, const dictionary &) | |
Construct given an IOobject and dictionary. More... | |
IOdictionary (const IOobject &, Istream &) | |
Construct given an IOobject and Istream. More... | |
IOdictionary (const IOdictionary &) | |
Copy constructor. More... | |
IOdictionary (IOdictionary &&) | |
Move constructor. More... | |
virtual | ~IOdictionary () |
Destructor. More... | |
virtual bool | global () const |
Return true as object is global, i.e. same for all processors. More... | |
virtual bool | readData (Istream &) |
ReadData function required for regIOobject read operation. More... | |
virtual bool | writeData (Ostream &) const |
WriteData function required for regIOobject write operation. More... | |
void | operator= (const IOdictionary &) |
Assignment of dictionary entries only. More... | |
void | operator= (IOdictionary &&) |
Move assignment of dictionary entries only. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &, const bool isTime=false) | |
Construct from IOobject. Optional flag for if IOobject is the. More... | |
regIOobject (const regIOobject &) | |
Copy constructor. More... | |
regIOobject (const regIOobject &&) | |
Move constructor. More... | |
regIOobject (const regIOobject &, bool registerCopy) | |
Copy constructor, transferring registry registration to copy. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy constructor with new name, transferring registry registration. More... | |
regIOobject (const IOobject &, const regIOobject &) | |
Copy constructor with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
virtual bool | globalFile () const |
Return true if object is global, i.e. same for all processors. More... | |
const fileName & | caseName () const |
fileName | path () const |
Return complete path. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
Remove object from registry. More... | |
void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const |
Is this object registered with the registry? More... | |
bool | ownedByRegistry () const |
Is this object owned by the registry? More... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release () |
Release ownership of this object from its registry. More... | |
label | eventNo () const |
Event number at last update. More... | |
label & | eventNo () |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (const word &, const bool read=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) More... | |
virtual bool | dependenciesModified () const |
Return true if the object's dependencies have been modified. More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const |
Write using given format, version and compression. More... | |
virtual bool | write (const bool write=true) const |
Write using setting from DB. More... | |
void | operator= (const IOobject &) |
Assign to IOobject. More... | |
void | operator= (const regIOobject &)=delete |
Disallow default assignment. More... | |
const fileName & | caseName (const bool global) const |
fileName | path (const bool global) const |
Return complete path including the processor sub-directory. More... | |
fileName | objectPath (const bool global) const |
Return complete path + object name including the processor. More... | |
fileName | filePath (const word &typeName, const bool global) const |
Return complete path + object name if the file exists. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
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. More... | |
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. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Construct from copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct from copy resetting name. More... | |
IOobject (const IOobject &io)=default | |
Copy constructor. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () const |
Return the optional note. More... | |
bool & | registerObject () |
Register object created from this IOobject with registry if true. More... | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. More... | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
const fileName & | caseName (const bool global) const |
fileName & | instance () const |
Return the instance directory, constant, system, <time> etc. More... | |
void | updateInstance () const |
If the instance is a time directory update to the current time. More... | |
const fileName & | local () const |
fileName | path (const bool global) const |
Return complete path including the processor sub-directory. More... | |
fileName | objectPath (const bool global) const |
Return complete path + object name including the processor. More... | |
fileName | relativePath () const |
Return the path relative to the case directory. More... | |
fileName | relativeObjectPath () const |
Return complete relativePath + object name. More... | |
fileName | filePath (const word &typeName, const bool global) const |
Return complete path + object name if the file exists. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
bool | headerOk () |
Read header of local object without type-checking. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &) const |
Write header. More... | |
bool | writeHeader (Ostream &, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
Public Member Functions inherited from dictionary | |
ClassName ("dictionary") | |
dictionary () | |
Construct top-level dictionary null. More... | |
dictionary (const fileName &name) | |
Construct top-level empty dictionary with given name. More... | |
dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
Construct given the entry name, parent dictionary and Istream,. More... | |
dictionary (Istream &, const bool keepHeader=false) | |
Construct top-level dictionary from Istream,. More... | |
template<class T , class ... KeysAndTs> | |
dictionary (const keyType &k, const T &t, const KeysAndTs &... keysAndTs) | |
Construct top-level dictionary with given T entries. More... | |
template<class T , class ... KeysAndTs> | |
dictionary (const fileName &name, const keyType &k, const T &t, const KeysAndTs &... keysAndTs) | |
Construct top-level dictionary with given name and T entries. More... | |
dictionary (const dictionary &parentDict, const dictionary &) | |
Construct as copy given the parent dictionary. More... | |
dictionary (const dictionary &) | |
Construct top-level dictionary as copy. More... | |
dictionary (const dictionary *) | |
Construct top-level dictionary as copy from pointer to dictionary. More... | |
autoPtr< dictionary > | clone () const |
Construct and return clone. More... | |
virtual | ~dictionary () |
Destructor. More... | |
const dictionary & | parent () const |
Return the parent dictionary. More... | |
bool | isNull () const |
Return whether this dictionary is null. More... | |
const dictionary & | topDict () const |
Return the top of the tree. More... | |
word | topDictKeyword () const |
Return the scoped keyword with which this dictionary can be. More... | |
label | startLineNumber () const |
Return line number of first token in dictionary. More... | |
label | endLineNumber () const |
Return line number of last token in dictionary. More... | |
SHA1Digest | digest () const |
Return the SHA1 digest of the dictionary contents. More... | |
tokenList | tokens () const |
Return the dictionary as a list of tokens. More... | |
bool | found (const word &, bool recursive=false, bool patternMatch=true) const |
Search dictionary for given keyword. More... | |
const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream pointer if present. More... | |
entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
Find and return an entry data stream pointer for manipulation. More... | |
const entry * | lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present, trying a list. More... | |
const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present otherwise error. More... | |
const entry & | lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
Find and return an entry data stream if present, trying a list. More... | |
ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return an entry data stream. More... | |
ITstream & | lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const |
Find and return an entry data stream, trying a list of keywords. More... | |
template<class T > | |
T | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, if not found throw a fatal error. More... | |
template<class T > | |
T | lookup (const word &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, with dimension checking and unit. More... | |
template<class T > | |
T | lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, trying a list of keywords in sequence,. More... | |
template<class T > | |
T | lookupBackwardsCompatible (const wordList &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, with dimension checking and unit. More... | |
template<class T > | |
T | lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, if not found return the given default. More... | |
template<class T > | |
T | lookupOrDefault (const word &, const unitConversion &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T with dimension checking and unit. More... | |
template<class T > | |
T | lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, trying a list of keywords in sequence,. More... | |
template<class T > | |
T | lookupOrDefaultBackwardsCompatible (const wordList &, const unitConversion &, const T &, bool recursive=false, bool patternMatch=true) const |
Find and return a T, with dimension checking and unit. More... | |
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. More... | |
template<class T > | |
bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
Find an entry if present, and assign to T. More... | |
template<class T > | |
bool | readIfPresent (const word &, const unitConversion &, T &, bool recursive=false, bool patternMatch=true) const |
Find an entry if present, and assign to T, with dimension. More... | |
const entry * | lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const |
Find and return an entry data stream pointer if present,. More... | |
template<class T > | |
T | lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const |
Find and return a T,. More... | |
template<class T > | |
const T & | lookupCompoundScoped (const word &keyword, bool recursive, bool patternMatch) const |
Find return the reference to the compound T,. More... | |
bool | isDict (const word &) const |
Check if entry is a sub-dictionary. More... | |
const dictionary * | subDictPtr (const word &) const |
Find and return a sub-dictionary pointer if present. More... | |
dictionary * | subDictPtr (const word &) |
Find and return a sub-dictionary pointer if present. More... | |
const dictionary & | subDict (const word &) const |
Find and return a sub-dictionary. More... | |
dictionary & | subDict (const word &) |
Find and return a sub-dictionary for manipulation. More... | |
const dictionary & | subDictBackwardsCompatible (const wordList &) const |
Find and return a sub-dictionary, trying a list of keywords in. More... | |
dictionary | subOrEmptyDict (const word &, const bool mustRead=false) const |
Find and return a sub-dictionary as a copy, or. More... | |
const dictionary & | optionalSubDict (const word &) const |
Find and return a sub-dictionary if found. More... | |
const dictionary & | scopedDict (const word &) const |
Find and return a sub-dictionary by scoped lookup. More... | |
dictionary & | scopedDict (const word &) |
Find and return a sub-dictionary by scoped lookup. More... | |
wordList | toc () const |
Return the table of contents. More... | |
wordList | sortedToc () const |
Return the sorted table of contents. More... | |
List< keyType > | keys (bool patterns=false) const |
Return the list of available keys or patterns. More... | |
bool | substituteKeyword (const word &keyword) |
Substitute the given keyword prepended by '$' with the. More... | |
bool | substituteScopedKeyword (const word &keyword) |
Substitute the given scoped keyword prepended by '$' with the. More... | |
bool | add (entry *, bool mergeEntry=false) |
Add a new entry. More... | |
void | add (const entry &, bool mergeEntry=false) |
Add an entry. More... | |
void | add (const keyType &, const word &, bool overwrite=false) |
Add a word entry. More... | |
void | add (const keyType &, const string &, bool overwrite=false) |
Add a string entry. More... | |
void | add (const keyType &, const label, bool overwrite=false) |
Add a label entry. More... | |
void | add (const keyType &, const scalar, bool overwrite=false) |
Add a scalar entry. More... | |
void | add (const keyType &, const dictionary &, bool mergeEntry=false) |
Add a dictionary entry. More... | |
template<class T > | |
void | add (const keyType &, const T &, bool overwrite=false) |
Add a T entry. More... | |
void | set (entry *) |
Assign a new entry, overwrite any existing entry. More... | |
void | set (const entry &) |
Assign a new entry, overwrite any existing entry. More... | |
void | set (const keyType &, const dictionary &) |
Assign a dictionary entry, overwrite any existing entry. More... | |
template<class T > | |
void | set (const keyType &, const T &) |
Assign a T entry, overwrite any existing entry. More... | |
template<class T , class ... KeysAndTs> | |
void | set (const keyType &, const T &, const KeysAndTs &...) |
Assign multiple T entries, overwriting any existing entries. More... | |
bool | remove (const word &) |
Remove an entry specified by keyword. More... | |
bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false) |
Change the keyword for an entry,. More... | |
bool | merge (const dictionary &) |
Merge entries from the given dictionary. More... | |
void | clear () |
Clear the dictionary. More... | |
void | transfer (dictionary &) |
Transfer the contents of the argument and annul the argument. More... | |
bool | read (Istream &, const bool keepHeader=false) |
Read dictionary from Istream, optionally keeping the header. More... | |
void | write (Ostream &, const bool subDict=true) const |
Write dictionary, normally with sub-dictionary formatting. More... | |
ITstream & | operator[] (const word &) const |
Find and return entry. More... | |
void | operator= (const dictionary &) |
void | operator+= (const dictionary &) |
Include entries from the given dictionary. More... | |
void | operator|= (const dictionary &) |
Conditionally include entries from the given dictionary. More... | |
void | operator<<= (const dictionary &) |
Unconditionally include entries from the given dictionary. More... | |
template<class T , class ... KeysAndTs> | |
void | set (const keyType &k, const T &t, const KeysAndTs &... keysAndTs) |
Public Member Functions inherited from dictionaryName | |
dictionaryName () | |
Construct dictionaryName null. More... | |
dictionaryName (const fileName &name) | |
Construct dictionaryName as copy of the given fileName. More... | |
dictionaryName (dictionaryName &&name) | |
Move constructor. More... | |
const fileName & | name () const |
Return the dictionary name. More... | |
fileName & | name () |
Return the dictionary name. More... | |
const word | dictName () const |
Return the local dictionary name (final part of scoped name) More... | |
void | operator= (const dictionaryName &name) |
void | operator= (dictionaryName &&name) |
Public Member Functions inherited from ILList< LListBase, T > | |
ILList () | |
Null construct. More... | |
ILList (T *a) | |
Construct given initial T. More... | |
ILList (Istream &) | |
Construct from Istream. More... | |
ILList (const ILList< LListBase, T > &) | |
Copy constructor. More... | |
ILList (ILList< LListBase, T > &&) | |
Move constructor. More... | |
template<class CloneArg > | |
ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg) | |
Copy constructor with additional argument for clone. More... | |
template<class INew > | |
ILList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
~ILList () | |
Destructor. More... | |
bool | eraseHead () |
Remove the head element specified from the list and delete it. More... | |
bool | erase (T *p) |
Remove the specified element from the list and delete it. More... | |
void | clear () |
Clear the contents of the list. More... | |
void | transfer (ILList< LListBase, T > &) |
Transfer the contents of the argument into this List. More... | |
void | operator= (const ILList< LListBase, T > &) |
Assignment operator. More... | |
void | operator= (ILList< LListBase, T > &&) |
Move assignment operator. More... | |
Public Member Functions inherited from UILList< LListBase, T > | |
UILList () | |
Null construct. More... | |
UILList (T *a) | |
Construct given initial T. More... | |
UILList (const UILList< LListBase, T > &) | |
Copy constructor. More... | |
UILList (UILList< LListBase, T > &&) | |
Move constructor. More... | |
T * | first () |
Return the first entry. More... | |
const T * | first () const |
Return the first entry. More... | |
T * | last () |
Return the last entry. More... | |
const T * | last () const |
Return the last entry. More... | |
T * | removeHead () |
Remove and return head. More... | |
T * | remove (T *p) |
Remove and return element. More... | |
T * | remove (iterator &it) |
Remove and return specified by iterator. More... | |
void | operator= (const UILList< LListBase, T > &) |
Assignment operator. More... | |
void | operator= (UILList< LListBase, T > &&) |
Move assignment operator. More... | |
iterator | begin () |
const iterator & | end () |
const_iterator | cbegin () const |
const const_iterator & | cend () const |
const_iterator | begin () const |
const const_iterator & | end () const |
const_reverse_iterator | crbegin () const |
const const_reverse_iterator & | crend () const |
const_reverse_iterator | rbegin () const |
const const_reverse_iterator & | rend () const |
bool | operator== (const UILList< LListBase, T > &) const |
Equality operation on ULists of the same type. More... | |
bool | operator!= (const UILList< LListBase, T > &) const |
The opposite of the equality operation. Takes linear time. More... | |
Static Protected Member Functions | |
static typeIOobject< IOdictionary > | readModelDict (const objectRegistry &obr, const word &group, bool registerObject=false) |
template<class MomentumTransportModel > | |
static autoPtr< MomentumTransportModel > | New (const typename MomentumTransportModel::alphaField &alpha, const typename MomentumTransportModel::rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity) |
Protected Attributes | |
const Time & | runTime_ |
const fvMesh & | mesh_ |
const volVectorField & | U_ |
const surfaceScalarField & | alphaRhoPhi_ |
const surfaceScalarField & | phi_ |
const viscosity & | viscosity_ |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from UILList< LListBase, T > | |
typedef T | value_type |
Type of values the DLList contains. More... | |
typedef T & | reference |
Type that can be used for storing into DLList::value_type. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant. More... | |
typedef label | size_type |
The type that can represent the size of a DLList. More... | |
typedef LListBase::iterator | LListBase_iterator |
typedef LListBase::const_iterator | LListBase_const_iterator |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
template<class Stream > | |
static Stream & | writeBanner (Stream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
template<class Stream > | |
static Stream & | writeDivider (Stream &os) |
Write the standard file section divider. More... | |
template<class Stream > | |
static Stream & | writeEndDivider (Stream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from dictionary | |
static autoPtr< dictionary > | New (Istream &) |
Construct top-level dictionary on freestore from Istream. More... | |
Static Public Attributes inherited from IOdictionary | |
static bool | writeDictionaries |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static constexpr const char * | foamFile = "FoamFile" |
Keyword for the FoamFile header sub-dictionary. More... | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Static Public Attributes inherited from dictionary | |
static const dictionary | null |
Null dictionary. More... | |
static bool | writeOptionalEntries |
If true write optional keywords and values. More... | |
Protected Member Functions inherited from IOdictionary | |
IOdictionary (const IOobject &io, const word &wantedType) | |
Construct given an IOobject, supply wanted typeName. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
Read header, check readOpt flags and read data if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType) |
Read header using typeGlobalFile to find file. More... | |
Abstract base class for turbulence models (RAS, LES and laminar).
Definition at line 57 of file momentumTransportModel.H.
momentumTransportModel | ( | const volVectorField & | U, |
const surfaceScalarField & | alphaRhoPhi, | ||
const surfaceScalarField & | phi, | ||
const viscosity & | viscosity | ||
) |
Construct from components.
Definition at line 93 of file momentumTransportModel.C.
References momentumTransportModel::alphaRhoPhi(), IOobject::group(), IOobject::groupName(), and regIOobject::rename().
|
delete |
Disallow default bitwise copy construction.
|
inlinevirtual |
Destructor.
Definition at line 119 of file momentumTransportModel.H.
|
staticprotected |
Definition at line 46 of file momentumTransportModel.C.
References TimePaths::constant(), IOobject::group(), IOobject::groupName(), typeIOobject< Type >::headerOk(), IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, IOobject::registerObject(), and objectRegistry::time().
Referenced by laminarModel< BasicMomentumTransportModel >::New(), LESModel< BasicMomentumTransportModel >::New(), RASModel< BasicMomentumTransportModel >::New(), and momentumTransportModel::New().
|
inlinestaticprotected |
Referenced by filmCompressibleMomentumTransportModel::New(), phaseCompressibleMomentumTransportModel::New(), and phaseIncompressibleMomentumTransportModel::New().
TypeName | ( | "momentumTransport" | ) |
Runtime type information.
|
pure virtual |
Read model coefficients if they have changed.
Reimplemented from regIOobject.
Definition at line 136 of file momentumTransportModel.C.
References regIOobject::read().
|
inline |
Definition at line 128 of file momentumTransportModel.H.
References momentumTransportModel::runTime_.
|
inline |
Definition at line 133 of file momentumTransportModel.H.
References momentumTransportModel::mesh_.
Referenced by dispersedTurbulentDispersionModel::continuousTurbulence().
|
pure virtual |
Const access to the coefficients dictionary.
Referenced by interfaceTurbulenceDamping::interfaceTurbulenceDamping(), turbulentMixingLengthDissipationRateFvScalarFieldSource::sourceValue(), turbulentMixingLengthFrequencyFvScalarFieldSource::sourceValue(), turbulentMixingLengthDissipationRateInletFvPatchScalarField::updateCoeffs(), turbulentMixingLengthFrequencyInletFvPatchScalarField::updateCoeffs(), and VoFTurbulenceDamping::VoFTurbulenceDamping().
Definition at line 141 of file momentumTransportModel.H.
References momentumTransportModel::alphaRhoPhi_, IOobject::group(), IOobject::groupName(), and dictionaryName::name().
|
inline |
Helper function to return the name of the turbulence G field.
Definition at line 147 of file momentumTransportModel.H.
References Foam::typedName().
|
inline |
Access function to velocity field.
Definition at line 153 of file momentumTransportModel.H.
References momentumTransportModel::U_.
Referenced by viscousHeating::addSup(), NicenoKEqn< BasicMomentumTransportModel >::bubbleG(), LaheyKEpsilon< BasicMomentumTransportModel >::bubbleG(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), NicenoKEqn< BasicMomentumTransportModel >::correctNut(), SmagorinskyZhang< BasicMomentumTransportModel >::correctNut(), LaheyKEpsilon< BasicMomentumTransportModel >::correctNut(), turbulenceIntensity::execute(), momentumTransportModel::New(), nutURoughWallFunctionFvPatchScalarField::nut(), nutUSpaldingWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().
|
inline |
Access function to phase flux field.
Definition at line 159 of file momentumTransportModel.H.
References momentumTransportModel::alphaRhoPhi_.
Referenced by specieFluxBase::calcPhiYif(), momentumTransportModel::momentumTransportModel(), and momentumTransportModel::New().
|
virtual |
Return the volumetric flux field.
Reimplemented in compressibleMomentumTransportModel.
Definition at line 118 of file momentumTransportModel.C.
Referenced by momentumTransportModel::New().
|
inline |
Access function to fluid properties.
Definition at line 168 of file momentumTransportModel.H.
References momentumTransportModel::viscosity_.
const Foam::volScalarField & y | ( | ) | const |
Return the wall distance.
Definition at line 124 of file momentumTransportModel.C.
References DemandDrivenMeshObject< fvMesh, DeletableMeshObject, wallDist >::New(), and wallDist::y().
const Foam::volScalarField::Boundary & yb | ( | ) | const |
Return the near wall distance.
Definition at line 130 of file momentumTransportModel.C.
References DemandDrivenMeshObject< fvMesh, DeletableMeshObject, nearWallDist >::New(), and nearWallDist::y().
Referenced by nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutkWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::nut(), fWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().
|
inlinevirtual |
Return the laminar viscosity.
Definition at line 180 of file momentumTransportModel.H.
References viscosity::nu().
Referenced by alphatJayatillekeWallFunctionFvPatchScalarField::alphat(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), kappaEff::htcByRhoCp(), forcesBase::mu(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutkWallFunctionFvPatchScalarField::nut(), nutURoughWallFunctionFvPatchScalarField::nut(), nutUSpaldingWallFunctionFvPatchScalarField::nut(), nutUWallFunctionFvPatchScalarField::nut(), porousBafflePressureFvPatchField< Type >::updateCoeffs(), fWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), nutkWallFunctionFvPatchScalarField::yPlus(), nutLowReWallFunctionFvPatchScalarField::yPlus(), nutUSpaldingWallFunctionFvPatchScalarField::yPlus(), nutURoughWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().
|
inlinevirtual |
Return the laminar viscosity on patchi.
Definition at line 186 of file momentumTransportModel.H.
References viscosity::nu(), and patchi.
|
pure virtual |
Return the turbulence viscosity.
Referenced by continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), turbulenceFields::execute(), kappaEff::htcByRhoCp(), nutWallFunctionFvPatchScalarField::nutw(), and compressibleMultiphaseVoF::thermophysicalPredictor().
|
pure virtual |
Return the turbulence viscosity on patch.
|
pure virtual |
Return the effective viscosity.
Referenced by turbulenceFields::execute(), and fixedShearStressFvPatchVectorField::updateCoeffs().
|
pure virtual |
Return the effective viscosity on patch.
|
pure virtual |
Return the turbulence kinetic energy.
Referenced by phaseTurbulenceStabilisation::addSup(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), turbulenceFields::execute(), turbulenceIntensity::execute(), DispersionRASModel< CloudType >::kModel(), continuousGasKEqn< BasicMomentumTransportModel >::kSource(), NicenoKEqn< BasicMomentumTransportModel >::kSource(), continuousGasKEpsilon< BasicMomentumTransportModel >::kSource(), LaheyKEpsilon< BasicMomentumTransportModel >::kSource(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkRoughWallFunctionFvPatchScalarField::nut(), nutkWallFunctionFvPatchScalarField::nut(), continuousGasKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), NicenoKEqn< BasicMomentumTransportModel >::phaseTransferCoeff(), continuousGasKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), fWallFunctionFvPatchScalarField::updateCoeffs(), kLowReWallFunctionFvPatchScalarField::updateCoeffs(), v2WallFunctionFvPatchScalarField::updateCoeffs(), and nutkWallFunctionFvPatchScalarField::yPlus().
|
pure virtual |
Return the turbulence kinetic energy dissipation rate.
Referenced by phaseTurbulenceStabilisation::addSup(), continuousGasKEpsilon< BasicMomentumTransportModel >::correctNut(), DispersionRASModel< CloudType >::epsilonModel(), continuousGasKEpsilon< BasicMomentumTransportModel >::epsilonSource(), LaheyKEpsilon< BasicMomentumTransportModel >::epsilonSource(), turbulenceFields::execute(), continuousGasKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), LaheyKEpsilon< BasicMomentumTransportModel >::phaseTransferCoeff(), and fWallFunctionFvPatchScalarField::updateCoeffs().
|
pure virtual |
Return the turbulence specific dissipation rate.
Referenced by phaseTurbulenceStabilisation::addSup(), and turbulenceFields::execute().
|
pure virtual |
Return the stress tensor [m^2/s^2].
Referenced by turbulenceFields::execute().
|
virtual |
Return the explicit stress correction matrix.
for the momentum equation. Combined with the implicit part by divDevTau Also creates and registers the devTauCorrFlux field which is cached in the matrix if fluxRequired.
Definition at line 143 of file momentumTransportModel.C.
References Foam::fvm::divc(), Foam::fvc::flux(), and U.
|
virtual |
Validate the fields after construction.
Update derived fields as required
Definition at line 164 of file momentumTransportModel.C.
|
pure virtual |
Predict the momentum transport coefficients if possible.
without solving momentum transport model equations
Definition at line 168 of file momentumTransportModel.C.
|
pure virtual |
Solve the momentum transport model equations.
and correct the momentum transport coefficients
Definition at line 172 of file momentumTransportModel.C.
|
delete |
Disallow default bitwise assignment.
|
inline |
Definition at line 31 of file momentumTransportModelTemplates.C.
References alpha(), momentumTransportModel::alphaRhoPhi(), IOobject::db(), UILList< LListBase, T >::end(), Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::group(), Foam::Info, dictionary::lookup(), Foam::nl, momentumTransportModel::phi(), momentumTransportModel::readModelDict(), rho, and momentumTransportModel::U().
|
protected |
Definition at line 65 of file momentumTransportModel.H.
Referenced by momentumTransportModel::time().
|
protected |
Definition at line 66 of file momentumTransportModel.H.
Referenced by momentumTransportModel::mesh().
|
protected |
Definition at line 68 of file momentumTransportModel.H.
Referenced by momentumTransportModel::U().
|
protected |
Definition at line 69 of file momentumTransportModel.H.
Referenced by momentumTransportModel::alphaRhoPhi(), and momentumTransportModel::groupName().
|
protected |
Definition at line 70 of file momentumTransportModel.H.
|
protected |
Definition at line 72 of file momentumTransportModel.H.
Referenced by momentumTransportModel::properties().