momentumTransportModel Class Referenceabstract

Abstract base class for turbulence models (RAS, LES and laminar). More...

Inheritance diagram for momentumTransportModel:
Collaboration diagram for momentumTransportModel:

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 Timetime () const
 
const fvMeshmesh () const
 
virtual const dictionarycoeffDict () 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 volVectorFieldU () const
 Access function to velocity field. More...
 
const surfaceScalarFieldalphaRhoPhi () const
 Access function to phase flux field. More...
 
virtual tmp< surfaceScalarFieldphi () const
 Return the volumetric flux field. More...
 
const class Foam::viscosityproperties () const
 Access function to fluid properties. More...
 
const volScalarField::Boundaryy () const
 Return the near wall distance. More...
 
virtual tmp< volScalarFieldnu () const
 Return the laminar viscosity. More...
 
virtual tmp< scalarFieldnu (const label patchi) const
 Return the laminar viscosity on patchi. More...
 
virtual tmp< volScalarFieldnut () const =0
 Return the turbulence viscosity. More...
 
virtual tmp< scalarFieldnut (const label patchi) const =0
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldnuEff () const =0
 Return the effective viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const =0
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const =0
 Return the turbulence kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const =0
 Return the turbulence kinetic energy dissipation rate. More...
 
virtual tmp< volScalarFieldomega () const =0
 Return the turbulence specific dissipation rate. More...
 
virtual tmp< volSymmTensorFieldsigma () const =0
 Return the stress tensor [m^2/s^2]. More...
 
virtual tmp< fvVectorMatrixdivDevTauCorr (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 fileNamecaseName () 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...
 
labeleventNo ()
 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...
 
IstreamreadStream (const word &, const bool read=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) 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 fileNamecaseName (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 &registry, 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 &registry, 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 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< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () 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 fileNamelocal () 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< IOobjectinfo () 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...
 
 dictionary (const dictionary &parentDict, dictionary &&)
 Move constructor transferring parameter contents. More...
 
 dictionary (dictionary &&)
 Move constructor. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
bool isNull () const
 Return whether this dictionary is null. More...
 
const dictionarytopDict () 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 entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
const entrylookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present, trying a list. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
ITstreamlookupBackwardsCompatible (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,. 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 lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. 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 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...
 
const entrylookupScopedEntryPtr (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...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
dictionarysubDictPtr (const word &)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
const dictionarysubDictBackwardsCompatible (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 dictionaryoptionalSubDict (const word &) const
 Find and return a sub-dictionary if found. More...
 
const dictionaryscopedDict (const word &) const
 Find and return a sub-dictionary by scoped lookup. More...
 
dictionaryscopedDict (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< keyTypekeys (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...
 
ITstreamoperator[] (const word &) const
 Find and return entry. More...
 
void operator= (const dictionary &)
 
void operator= (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 fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 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...
 
Tfirst ()
 Return the first entry. More...
 
const Tfirst () const
 Return the first entry. More...
 
Tlast ()
 Return the last entry. More...
 
const Tlast () const
 Return the last entry. More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *p)
 Remove and return element. More...
 
Tremove (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 iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () 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< IOdictionaryreadModelDict (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 TimerunTime_
 
const fvMeshmesh_
 
const volVectorFieldU_
 
const surfaceScalarFieldalphaRhoPhi_
 
const surfaceScalarFieldphi_
 
const viscosityviscosity_
 

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 Treference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const Tconst_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< dictionaryNew (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...
 

Detailed Description

Abstract base class for turbulence models (RAS, LES and laminar).

Source files

Definition at line 57 of file momentumTransportModel.H.

Constructor & Destructor Documentation

◆ momentumTransportModel() [1/2]

momentumTransportModel ( const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const viscosity viscosity 
)

Construct from components.

Definition at line 92 of file momentumTransportModel.C.

References momentumTransportModel::alphaRhoPhi(), IOobject::group(), IOobject::groupName(), and regIOobject::rename().

Here is the call graph for this function:

◆ momentumTransportModel() [2/2]

Disallow default bitwise copy construction.

◆ ~momentumTransportModel()

virtual ~momentumTransportModel ( )
inlinevirtual

Destructor.

Definition at line 119 of file momentumTransportModel.H.

Member Function Documentation

◆ readModelDict()

◆ New() [1/2]

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 
)
inlinestaticprotected

◆ TypeName()

TypeName ( "momentumTransport"  )

Runtime type information.

◆ read()

bool read ( )
pure virtual

Read model coefficients if they have changed.

Reimplemented from regIOobject.

Definition at line 129 of file momentumTransportModel.C.

References regIOobject::read().

Here is the call graph for this function:

◆ time()

const Time& time ( ) const
inline

Definition at line 128 of file momentumTransportModel.H.

References momentumTransportModel::runTime_.

◆ mesh()

const fvMesh& mesh ( ) const
inline

Definition at line 133 of file momentumTransportModel.H.

References momentumTransportModel::mesh_.

Referenced by dispersedTurbulentDispersionModel::continuousTurbulence().

Here is the caller graph for this function:

◆ coeffDict()

◆ groupName()

word groupName ( const word name) const
inline

Definition at line 141 of file momentumTransportModel.H.

References momentumTransportModel::alphaRhoPhi_, IOobject::group(), IOobject::groupName(), and dictionaryName::name().

Here is the call graph for this function:

◆ GName()

word GName ( ) const
inline

Helper function to return the name of the turbulence G field.

Definition at line 147 of file momentumTransportModel.H.

References Foam::typedName().

Referenced by omegaWallFunctionFvPatchScalarField::calculate(), epsilonWallFunctionFvPatchScalarField::updateCoeffs(), and omegaWallFunctionFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ U()

◆ alphaRhoPhi()

const surfaceScalarField& alphaRhoPhi ( ) const
inline

Access function to phase flux field.

Definition at line 159 of file momentumTransportModel.H.

References momentumTransportModel::alphaRhoPhi_.

Referenced by momentumTransportModel::momentumTransportModel(), and momentumTransportModel::New().

Here is the caller graph for this function:

◆ phi()

Foam::tmp< Foam::surfaceScalarField > phi ( ) const
virtual

Return the volumetric flux field.

Reimplemented in compressibleMomentumTransportModel.

Definition at line 117 of file momentumTransportModel.C.

Referenced by momentumTransportModel::New().

Here is the caller graph for this function:

◆ properties()

const class Foam::viscosity& properties ( ) const
inline

Access function to fluid properties.

Definition at line 168 of file momentumTransportModel.H.

References momentumTransportModel::viscosity_.

◆ y()

◆ nu() [1/2]

◆ nu() [2/2]

virtual tmp<scalarField> nu ( const label  patchi) const
inlinevirtual

Return the laminar viscosity on patchi.

Definition at line 183 of file momentumTransportModel.H.

References viscosity::nu(), and patchi.

Here is the call graph for this function:

◆ nut() [1/2]

◆ nut() [2/2]

virtual tmp<scalarField> nut ( const label  patchi) const
pure virtual

Return the turbulence viscosity on patch.

◆ nuEff() [1/2]

virtual tmp<volScalarField> nuEff ( ) const
pure virtual

Return the effective viscosity.

Referenced by turbulenceFields::execute(), and fixedShearStressFvPatchVectorField::updateCoeffs().

Here is the caller graph for this function:

◆ nuEff() [2/2]

virtual tmp<scalarField> nuEff ( const label  patchi) const
pure virtual

Return the effective viscosity on patch.

◆ k()

◆ epsilon()

◆ omega()

virtual tmp<volScalarField> omega ( ) const
pure virtual

Return the turbulence specific dissipation rate.

Referenced by phaseTurbulenceStabilisation::addSup(), and turbulenceFields::execute().

Here is the caller graph for this function:

◆ sigma()

virtual tmp<volSymmTensorField> sigma ( ) const
pure virtual

Return the stress tensor [m^2/s^2].

Referenced by turbulenceFields::execute().

Here is the caller graph for this function:

◆ divDevTauCorr()

Foam::tmp< Foam::fvVectorMatrix > divDevTauCorr ( const tmp< volTensorField > &  devTauCorr,
volVectorField U 
) const
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 136 of file momentumTransportModel.C.

References Foam::fvm::divc(), Foam::fvc::flux(), and U.

Here is the call graph for this function:

◆ validate()

void validate ( )
virtual

Validate the fields after construction.

Update derived fields as required

Definition at line 157 of file momentumTransportModel.C.

◆ predict()

void predict ( )
pure virtual

Predict the momentum transport coefficients if possible.

without solving momentum transport model equations

Definition at line 161 of file momentumTransportModel.C.

◆ correct()

void correct ( )
pure virtual

Solve the momentum transport model equations.

and correct the momentum transport coefficients

Definition at line 165 of file momentumTransportModel.C.

◆ operator=()

void operator= ( const momentumTransportModel )
delete

Disallow default bitwise assignment.

◆ New() [2/2]

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 
)
inline

Member Data Documentation

◆ runTime_

const Time& runTime_
protected

Definition at line 65 of file momentumTransportModel.H.

Referenced by momentumTransportModel::time().

◆ mesh_

const fvMesh& mesh_
protected

Definition at line 66 of file momentumTransportModel.H.

Referenced by momentumTransportModel::mesh().

◆ U_

const volVectorField& U_
protected

Definition at line 68 of file momentumTransportModel.H.

Referenced by momentumTransportModel::U().

◆ alphaRhoPhi_

const surfaceScalarField& alphaRhoPhi_
protected

◆ phi_

const surfaceScalarField& phi_
protected

Definition at line 70 of file momentumTransportModel.H.

◆ viscosity_

const viscosity& viscosity_
protected

Definition at line 72 of file momentumTransportModel.H.

Referenced by momentumTransportModel::properties().


The documentation for this class was generated from the following files: