Class to represent a system of phases and model interfacial transfers between them.
More...
|
| TypeName ("phaseSystem") |
| Runtime type information. More...
|
|
| phaseSystem (const fvMesh &mesh) |
| Construct from fvMesh. More...
|
|
virtual | ~phaseSystem () |
| Destructor. More...
|
|
const fvMesh & | mesh () const |
| Constant access the mesh. More...
|
|
const phaseModelList & | phases () const |
| Constant access the phase models. More...
|
|
phaseModelList & | phases () |
| Access the phase models. More...
|
|
const phasePairTable & | phasePairs () const |
| Constant access the phase pairs. More...
|
|
tmp< volScalarField > | rho () const |
| Return the mixture density. More...
|
|
tmp< volVectorField > | U () const |
| Return the mixture velocity. More...
|
|
const surfaceScalarField & | phi () const |
| Constant access the mixture flux. More...
|
|
surfaceScalarField & | phi () |
| Access the mixture flux. More...
|
|
const volScalarField & | dpdt () const |
| Constant access the rate of change of the pressure. More...
|
|
volScalarField & | dpdt () |
| Access the rate of change of the pressure. More...
|
|
tmp< volScalarField > | E (const phasePairKey &key) const |
| Return the aspect-ratio. More...
|
|
tmp< volScalarField > | sigma (const phasePairKey &key) const |
| Return the surface tension coefficient. More...
|
|
const IOMRFZoneList & | MRF () const |
| Return MRF zones. More...
|
|
fv::options & | fvOptions () const |
| Optional FV-options. More...
|
|
template<class modelType > |
const modelType & | lookupSubModel (const phasePair &key) const |
| Access a sub model between a phase pair. More...
|
|
template<class modelType > |
const modelType & | lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const |
| Access a sub model between two phases. More...
|
|
virtual void | solve () |
| Solve for the phase fractions. More...
|
|
virtual void | correct () |
| Correct the fluid properties other than the thermo and turbulence. More...
|
|
virtual void | correctKinematics () |
| Correct the kinematics. More...
|
|
virtual void | correctThermo () |
| Correct the thermodynamics. More...
|
|
virtual void | correctTurbulence () |
| Correct the turbulence. More...
|
|
virtual void | correctEnergyTransport () |
| Correct the energy transport e.g. alphat. More...
|
|
virtual bool | read () |
| Read base phaseProperties dictionary. More...
|
|
| 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...
|
|
virtual | ~IOdictionary () |
| Destructor. More...
|
|
virtual bool | global () const |
| Is object global. More...
|
|
virtual fileName | filePath () const |
| Return complete path + object name if the file exists. More...
|
|
| TypeName ("dictionary") |
|
| baseIOdictionary (const IOobject &) |
| Construct given an IOobject. More...
|
|
| baseIOdictionary (const IOobject &, const dictionary &) |
| Construct given an IOobject and dictionary. More...
|
|
| baseIOdictionary (const IOobject &, Istream &) |
| Construct given an IOobject and Istream. More...
|
|
virtual | ~baseIOdictionary () |
| Destructor. More...
|
|
const word & | name () const |
| Name function is needed to disambiguate those inherited. 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 baseIOdictionary &) |
| Assignment of other baseIOdictionary's entries to this. More...
|
|
| 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 &) |
| Construct as copy. More...
|
|
| regIOobject (const regIOobject &, bool registerCopy) |
| Construct as copy, transferring registry registration to copy. More...
|
|
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) |
| Construct as copy with new name, transfering registry registration. More...
|
|
| regIOobject (const IOobject &, const regIOobject &) |
| Construct as copy with new IO parameters. More...
|
|
virtual | ~regIOobject () |
| Destructor. More...
|
|
bool | checkIn () |
| Add object to registry. More...
|
|
bool | checkOut () |
| Remove object from registry. More...
|
|
virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) 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 valid=true) |
| Return Istream and check object type against that given. More...
|
|
void | close () |
| Close Istream. More...
|
|
virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. Return. 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 | readIfModified () |
| Read object if modified (as set by call to modified) More...
|
|
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const |
| Write using given format, version and compression. More...
|
|
virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More...
|
|
void | operator= (const 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, bool globalObject=false) |
| 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, bool globalObject=false) |
| 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...
|
|
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...
|
|
bool & | globalObject () |
| Is object same for all processors. More...
|
|
bool | globalObject () const |
| Is object same for all processors. 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 |
|
const fileName & | instance () const |
|
fileName & | instance () |
|
const fileName & | local () const |
|
fileName | path () const |
| Return complete path. More...
|
|
fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. More...
|
|
fileName | objectPath () const |
| Return complete path + object name. More...
|
|
fileName | localFilePath (const word &typeName) const |
| Helper for filePath that searches locally. More...
|
|
fileName | globalFilePath (const word &typeName) const |
| Helper for filePath that searches up if in parallel. More...
|
|
bool | readHeader (Istream &) |
| Read header. More...
|
|
template<class Type > |
bool | typeHeaderOk (const bool checkType=true) |
| Read header (uses typeFilePath to find file) and check header. 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) |
|
| 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 &) |
| Construct top-level dictionary from Istream,. More...
|
|
| dictionary (Istream &, const bool keepHeader) |
| Construct top-level dictionary from Istream,. 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, const Xfer< dictionary > &) |
| Construct by transferring parameter contents given parent dictionary. More...
|
|
| dictionary (const Xfer< dictionary > &) |
| Construct top-level dictionary by transferring parameter contents. More...
|
|
autoPtr< dictionary > | clone () const |
| Construct and return clone. More...
|
|
virtual | ~dictionary () |
| Destructor. More...
|
|
const dictionary & | parent () const |
| Return the parent dictionary. More...
|
|
const dictionary & | topDict () const |
| Return the top of the tree. 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 & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present otherwise error. More...
|
|
ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream. More...
|
|
template<class T > |
T | lookupType (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. 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 | 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 entry * | lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. 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...
|
|
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...
|
|
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...
|
|
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...
|
|
Xfer< dictionary > | xfer () |
| Transfer contents to the Xfer container. More...
|
|
bool | read (Istream &) |
| Read dictionary from Istream. More...
|
|
bool | read (Istream &, const bool keepHeader) |
| 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...
|
|
| dictionaryName () |
| Construct dictionaryName null. More...
|
|
| dictionaryName (const fileName &name) |
| Construct dictionaryName as copy of the given fileName. 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...
|
|
| ILList () |
| Null construct. More...
|
|
| ILList (T *a) |
| Construct given initial T. More...
|
|
| ILList (Istream &) |
| Construct from Istream. More...
|
|
| ILList (const ILList< LListBase, T > &) |
| Construct as copy. 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...
|
|
| UILList () |
| Null construct. More...
|
|
| UILList (T *a) |
| Construct given initial T. More...
|
|
| UILList (const UILList< LListBase, T > &) |
| Construct as copy. 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 > &) |
|
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...
|
|