Finite volume models. More...
Public Member Functions | |
TypeName ("fvModels") | |
Runtime type information. More... | |
fvModels (const fvMesh &mesh) | |
Construct from components with list of field names. More... | |
fvModels (const fvModels &)=delete | |
Disallow default bitwise copy construction. More... | |
virtual | ~fvModels () |
Destructor. More... | |
virtual bool | global () const |
Declare fvModels to be a global dictionary. More... | |
virtual bool | addsSupToField (const word &fieldName) const |
Return true if an fvModel adds a source term to the given. More... | |
virtual scalar | maxDeltaT () const |
Return the maximum time-step for stable operation. More... | |
virtual void | correct () |
Correct the fvModels. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for an equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for an equation with a specified name. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a compressible equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for a compressible equation with a specified name. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for a phase equation with a specified name. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const volScalarField &alpha, const geometricOneField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const geometricOneField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | source (const geometricOneField &alpha, const geometricOneField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for a phase equation. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | d2dt2 (const GeometricField< Type, fvPatchField, volMesh > &field) const |
Return source for an equation with a second time derivative. More... | |
template<class Type > | |
tmp< fvMatrix< Type > > | d2dt2 (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Return source for an equation with a second time derivative. More... | |
virtual void | preUpdateMesh () |
Prepare for mesh update. More... | |
virtual bool | movePoints () |
Update for mesh motion. More... | |
virtual void | topoChange (const polyTopoChangeMap &) |
Update topology using the given map. More... | |
virtual void | mapMesh (const polyMeshMap &) |
Update from another mesh using the given map. More... | |
virtual void | distribute (const polyDistributionMap &) |
Redistribute or update using the given distribution map. More... | |
virtual bool | readData (Istream &) |
ReadData function which reads the fvModels dictionary. More... | |
virtual bool | writeData (Ostream &os) const |
Write data to Ostream. More... | |
virtual bool | read () |
Read the fvModels dictionary if it has changed. More... | |
void | operator= (const fvModels &)=delete |
Disallow default bitwise assignment. More... | |
template<class Type , class ... AlphaRhoFieldTypes> | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const geometricOneField &alpha, const geometricOneField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const volScalarField &alpha, const geometricOneField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | source (const geometricOneField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | d2dt2 (const GeometricField< Type, fvPatchField, volMesh > &field) const |
template<class Type > | |
Foam::tmp< Foam::fvMatrix< Type > > | d2dt2 (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const |
Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, fvModels > | |
MeshObject (const fvMesh &mesh) | |
MeshObject (const fvMesh &mesh, const IOobject &io) | |
virtual | ~MeshObject () |
const fvMesh & | mesh () const |
Public Member Functions inherited from UpdateableMeshObject< fvMesh > | |
UpdateableMeshObject (const word &typeName, const objectRegistry &obr) | |
UpdateableMeshObject (const word &typeName, const IOobject &io) | |
Public Member Functions inherited from DistributeableMeshObject< fvMesh > | |
DistributeableMeshObject (const word &typeName, const objectRegistry &obr) | |
DistributeableMeshObject (const word &typeName, const IOobject &io) | |
Public Member Functions inherited from MoveableMeshObject< fvMesh > | |
MoveableMeshObject (const word &typeName, const objectRegistry &obr) | |
MoveableMeshObject (const word &typeName, const IOobject &io) | |
Public Member Functions inherited from GeometricMeshObject< fvMesh > | |
GeometricMeshObject (const word &typeName, const objectRegistry &obr) | |
GeometricMeshObject (const word &typeName, const IOobject &io) | |
Public Member Functions inherited from TopologicalMeshObject< fvMesh > | |
TopologicalMeshObject (const word &typeName, const objectRegistry &obr) | |
TopologicalMeshObject (const word &typeName, const IOobject &io) | |
Public Member Functions inherited from meshObject | |
ClassName ("meshObject") | |
meshObject (const word &typeName, const objectRegistry &obr) | |
meshObject (const word &typeName, const IOobject &io) | |
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 | 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 &) |
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... | |
word | modelName (const char *name) const |
Return the name of the object within this model. 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) |
template<class Name > | |
Foam::word | modelName (Name name, const word &model) |
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... | |
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< 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,. 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 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... | |
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... | |
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= (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... | |
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... | |
Public Member Functions inherited from PtrListDictionary< fvModel > | |
PtrListDictionary (const label size) | |
Construct given initial list size. More... | |
PtrListDictionary (const PtrListDictionary &) | |
Copy constructor. More... | |
PtrListDictionary (PtrListDictionary &&) | |
Move constructor. More... | |
PtrListDictionary (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
PtrListDictionary (Istream &) | |
Construct from Istream. More... | |
autoPtr< fvModel > | set (const label, const word &key, fvModel *) |
Set element to pointer provided and return old element. More... | |
autoPtr< fvModel > | set (const label, const word &key, autoPtr< fvModel > &) |
Set element to autoPtr value provided and return old element. More... | |
autoPtr< fvModel > | set (const label, const word &key, tmp< fvModel > &) |
Set element to tmp value provided and return old element. More... | |
const fvModel & | operator[] (const word &key) const |
Find and return entry. More... | |
fvModel & | operator[] (const word &key) |
Find and return entry. More... | |
Public Member Functions inherited from DictionaryBase< PtrList< fvModel >, fvModel > | |
DictionaryBase (const label size=128) | |
Construct given initial table size. More... | |
DictionaryBase (const DictionaryBase &) | |
Copy constructor. More... | |
DictionaryBase (DictionaryBase &&) | |
Move constructor. More... | |
DictionaryBase (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
DictionaryBase (Istream &) | |
Construct from Istream using default Istream constructor class. More... | |
bool | found (const word &) const |
Search DictionaryBase for given keyword. More... | |
const fvModel * | lookupPtr (const word &) const |
Find and return an entry if present, otherwise return nullptr. More... | |
fvModel * | lookupPtr (const word &) |
Find and return an entry if present, otherwise return nullptr. More... | |
const fvModel * | lookup (const word &) const |
Find and return entry. More... | |
fvModel * | lookup (const word &) |
Find and return entry. More... | |
wordList | toc () const |
Return the table of contents. More... | |
wordList | sortedToc () const |
Return the table of contents as a sorted list. More... | |
void | insert (const word &, fvModel *) |
Add at head of dictionary. More... | |
void | append (const word &, fvModel *) |
Add at tail of dictionary. More... | |
fvModel * | remove (const word &) |
Remove and return entry specified by keyword. More... | |
void | clear () |
Clear the dictionary. More... | |
void | transfer (DictionaryBase< PtrList< fvModel >, fvModel > &) |
Transfer the contents of the argument into this DictionaryBase. More... | |
void | operator= (const DictionaryBase &) |
const fvModel * | operator[] (const word &key) const |
Find and return entry. More... | |
fvModel * | operator[] (const word &key) |
Find and return entry. More... | |
Public Member Functions inherited from PtrList< fvModel > | |
PtrList () | |
Null Constructor. More... | |
PtrList (const label) | |
Construct with size specified. More... | |
PtrList (const PtrList< fvModel > &) | |
Copy constructor. More... | |
PtrList (const PtrList< fvModel > &, const CloneArg &) | |
Copy constructor with additional argument for clone. More... | |
PtrList (PtrList< fvModel > &&) | |
Move constructor. More... | |
PtrList (PtrList< fvModel > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
PtrList (const SLPtrList< fvModel > &) | |
Construct as copy of SLPtrList<T> More... | |
PtrList (Istream &, const INew &) | |
Construct from Istream using given Istream constructor class. More... | |
PtrList (Istream &) | |
Construct from Istream using default Istream constructor class. More... | |
~PtrList () | |
Destructor. More... | |
void | setSize (const label) |
Reset size of PtrList. If extending the PtrList, new entries are. More... | |
void | resize (const label) |
Alias for setSize(const label) More... | |
void | clear () |
Clear the PtrList, i.e. set size to zero deleting all the. More... | |
void | append (fvModel *) |
Append an element at the end of the list. More... | |
void | append (const autoPtr< fvModel > &) |
void | append (const tmp< fvModel > &) |
void | transfer (PtrList< fvModel > &) |
Transfer the contents of the argument PtrList into this PtrList. More... | |
bool | set (const label) const |
Is element set. More... | |
autoPtr< fvModel > | set (const label, fvModel *) |
Set element to given T* and return old element (can be nullptr) More... | |
autoPtr< fvModel > | set (const label, const autoPtr< fvModel > &) |
Set element to given autoPtr<T> and return old element. More... | |
autoPtr< fvModel > | set (const label, const tmp< fvModel > &) |
Set element to given tmp<T> and return old element. More... | |
void | reorder (const labelUList &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
void | operator= (const PtrList< fvModel > &) |
Assignment operator. More... | |
void | operator= (PtrList< fvModel > &&) |
Move assignment operator. More... | |
Public Member Functions inherited from UPtrList< T > | |
UPtrList () | |
Null Constructor. More... | |
UPtrList (const label) | |
Construct with size specified. More... | |
UPtrList (UPtrList< T > &, bool reuse) | |
Construct as copy or re-use as specified. More... | |
label | size () const |
Return the number of elements in the UPtrList. More... | |
bool | empty () const |
Return true if the UPtrList is empty (ie, size() is zero) More... | |
T & | first () |
Return reference to the first element of the list. More... | |
const T & | first () const |
Return reference to first element of the list. More... | |
T & | last () |
Return reference to the last element of the list. More... | |
const T & | last () const |
Return reference to the last element of the list. More... | |
void | setSize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | resize (const label) |
Reset size of UPtrList. This can only be used to set the size. More... | |
void | clear () |
Clear the UPtrList, i.e. set size to zero. More... | |
void | transfer (UPtrList< T > &) |
Transfer the contents of the argument UPtrList into this. More... | |
bool | set (const label) const |
Is element set. More... | |
T * | set (const label, T *) |
Set element. Return old element (can be nullptr). More... | |
void | reorder (const labelUList &oldToNew) |
Reorders elements. Ordering does not have to be done in. More... | |
void | shuffle (const labelUList &newToOld) |
Reorders elements. Ordering does not have to be done in. More... | |
template<class T2 > | |
UPtrList< T2 > | convert () |
Convert to list of different pointer type. More... | |
template<class T2 > | |
UPtrList< const T2 > | convert () const |
Convert to list of different pointer type. More... | |
const T & | operator[] (const label) const |
Return element const reference. More... | |
T & | operator[] (const label) |
Return element reference. More... | |
const T * | operator() (const label) const |
Return element const pointer. More... | |
iterator | begin () |
Return an iterator to begin traversing the UPtrList. More... | |
iterator | end () |
Return an iterator to end traversing the UPtrList. More... | |
const_iterator | cbegin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | cend () const |
Return an const_iterator to end traversing the UPtrList. More... | |
const_iterator | begin () const |
Return an const_iterator to begin traversing the UPtrList. More... | |
const_iterator | end () const |
Return an const_iterator to end traversing the UPtrList. More... | |
template<class T2 > | |
Foam::UPtrList< T2 > | convert () |
template<class T2 > | |
Foam::UPtrList< const T2 > | convert () const |
Friends | |
Ostream & | operator<< (Ostream &os, const fvModels &models) |
Ostream operator. More... | |
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 |
Public Types inherited from UPtrList< T > | |
typedef T | value_type |
Type of values the UPtrList contains. More... | |
typedef T & | reference |
Type that can be used for storing into UPtrList::value_type objects. More... | |
typedef const T & | const_reference |
Type that can be used for storing into constant UPtrList::value_type. More... | |
Static Public Member Functions inherited from MeshObject< fvMesh, UpdateableMeshObject, fvModels > | |
static fvModels & | New (fvMesh &mesh) |
static const fvModels & | New (const fvMesh &mesh) |
static fvModels & | New (fvMesh &mesh, const Args &... args) |
static const fvModels & | New (const fvMesh &mesh, const Args &... args) |
static bool | Delete (const fvMesh &mesh) |
static bool | found (const fvMesh &mesh) |
Return true if this MeshObject is found in the mesh registry. More... | |
Static Public Member Functions inherited from meshObject | |
template<class Mesh > | |
static void | movePoints (objectRegistry &) |
template<class Mesh > | |
static void | topoChange (objectRegistry &, const polyTopoChangeMap &) |
template<class Mesh > | |
static void | mapMesh (objectRegistry &, const polyMeshMap &) |
template<class Mesh > | |
static void | distribute (objectRegistry &, const polyDistributionMap &) |
template<class Mesh > | |
static void | addPatch (objectRegistry &, const label patchi) |
template<class Mesh > | |
static void | reorderPatches (objectRegistry &, const labelUList &newToOld, const bool validBoundary) |
template<class Mesh , template< class > class MeshObjectType> | |
static void | clear (objectRegistry &) |
template<class Mesh , template< class > class FromType, template< class > class ToType> | |
static void | clearUpto (objectRegistry &) |
Clear all meshObject derived from FromType up to (but not including) More... | |
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 Name > | |
static word | modelName (Name name, const word &model) |
Return the name of the object within the given model. 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 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 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... | |
Protected Member Functions inherited from DictionaryBase< PtrList< fvModel >, fvModel > | |
void | addEntries () |
Protected Member Functions inherited from PtrList< fvModel > | |
void | read (Istream &, const INew &inewt) |
Read from Istream using given Istream constructor class. More... | |
Protected Attributes inherited from MeshObject< fvMesh, UpdateableMeshObject, fvModels > | |
const fvMesh & | mesh_ |
Protected Attributes inherited from DictionaryBase< PtrList< fvModel >, fvModel > | |
HashTable< fvModel *> | hashedTs_ |
HashTable of the entries held on the IDLListType for quick lookup. More... | |
Construct from components with list of field names.
Definition at line 139 of file fvModels.C.
References IOstream::ASCII, Foam::count(), dict, forAllConstIter, found, dictionary::lookup(), Foam::name(), IOobject::name(), fvModel::New(), PtrListDictionary< T >::set(), and PtrList< T >::setSize().
|
inlinevirtual |
Destructor.
Definition at line 113 of file fvModels.H.
TypeName | ( | "fvModels" | ) |
Runtime type information.
|
inlinevirtual |
Declare fvModels to be a global dictionary.
Reimplemented from dictionary.
Definition at line 120 of file fvModels.H.
References fvModels::addsSupToField(), alpha(), fvModels::correct(), fvModels::d2dt2(), fvModels::distribute(), fvModels::mapMesh(), fvModels::maxDeltaT(), fvModels::movePoints(), fvModels::operator=(), fvModels::preUpdateMesh(), fvModels::read(), fvModels::readData(), rho, fvModels::topoChange(), and fvModels::writeData().
Return true if an fvModel adds a source term to the given.
field's transport equation
Definition at line 224 of file fvModels.C.
References forAll.
Referenced by forAll(), and fvModels::global().
|
virtual |
Return the maximum time-step for stable operation.
Definition at line 240 of file fvModels.C.
References forAll, maxDeltaT, and Foam::min().
Referenced by fvModels::global(), and if().
|
virtual |
Correct the fvModels.
e.g. solve equations, update model, for film, Lagrangian etc.
Definition at line 353 of file fvModels.C.
References forAll.
Referenced by fvModels::global(), and if().
tmp<fvMatrix<Type> > source | ( | const GeometricField< Type, fvPatchField, volMesh > & | field | ) | const |
Return source for an equation.
tmp<fvMatrix<Type> > source | ( | const GeometricField< Type, fvPatchField, volMesh > & | field, |
const word & | fieldName | ||
) | const |
Return source for an equation with a specified name.
tmp<fvMatrix<Type> > source | ( | const volScalarField & | rho, |
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Return source for a compressible equation.
tmp<fvMatrix<Type> > source | ( | const volScalarField & | rho, |
const GeometricField< Type, fvPatchField, volMesh > & | field, | ||
const word & | fieldName | ||
) | const |
Return source for a compressible equation with a specified name.
tmp<fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Return source for a phase equation.
tmp<fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field, | ||
const word & | fieldName | ||
) | const |
Return source for a phase equation with a specified name.
tmp<fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const geometricOneField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Return source for a phase equation.
tmp<fvMatrix<Type> > source | ( | const geometricOneField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Return source for a phase equation.
tmp<fvMatrix<Type> > source | ( | const geometricOneField & | alpha, |
const geometricOneField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Return source for a phase equation.
tmp<fvMatrix<Type> > d2dt2 | ( | const GeometricField< Type, fvPatchField, volMesh > & | field | ) | const |
Return source for an equation with a second time derivative.
Referenced by fvModels::d2dt2(), fvModels::global(), and fvModels::source().
tmp<fvMatrix<Type> > d2dt2 | ( | const GeometricField< Type, fvPatchField, volMesh > & | field, |
const word & | fieldName | ||
) | const |
Return source for an equation with a second time derivative.
|
virtual |
Prepare for mesh update.
Definition at line 255 of file fvModels.C.
References forAll.
Referenced by fvModels::global().
|
virtual |
Update for mesh motion.
Implements MoveableMeshObject< fvMesh >.
Definition at line 266 of file fvModels.C.
References forAll.
Referenced by fvModels::global().
|
virtual |
Update topology using the given map.
Implements UpdateableMeshObject< fvMesh >.
Definition at line 281 of file fvModels.C.
References forAll.
Referenced by fvModels::global().
|
virtual |
Update from another mesh using the given map.
Implements UpdateableMeshObject< fvMesh >.
Definition at line 292 of file fvModels.C.
References forAll.
Referenced by fvModels::global().
|
virtual |
Redistribute or update using the given distribution map.
Implements DistributeableMeshObject< fvMesh >.
Definition at line 303 of file fvModels.C.
References forAll.
Referenced by fvModels::global().
ReadData function which reads the fvModels dictionary.
required for regIOobject read operation
Reimplemented from regIOobject.
Definition at line 314 of file fvModels.C.
References IOstream::bad().
Referenced by fvModels::global().
Write data to Ostream.
Reimplemented from MeshObject< fvMesh, UpdateableMeshObject, fvModels >.
Definition at line 321 of file fvModels.C.
References IOstream::good(), and dictionary::write().
Referenced by fvModels::global().
|
virtual |
Read the fvModels dictionary if it has changed.
and update the models
Reimplemented from regIOobject.
Definition at line 328 of file fvModels.C.
References forAll, mesh, fvModel::name(), Foam::blockMeshTools::read(), fvModel::read(), fvMesh::time(), and TimeState::timeIndex().
Referenced by fvModels::global().
Disallow default bitwise assignment.
Referenced by fvModels::global().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const GeometricField< Type, fvPatchField, volMesh > & | field, |
const word & | fieldName, | ||
const dimensionSet & | ds, | ||
const AlphaRhoFieldTypes &... | alphaRhos | ||
) | const |
Definition at line 30 of file fvModelsTemplates.C.
References fvModel::addsSupToField(), Foam::endl(), forAll, Foam::Info, DictionaryBase< IDLListType, T >::insert(), fvModel::name(), and tmp< T >::ref().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const GeometricField< Type, fvPatchField, volMesh > & | field | ) | const |
Definition at line 77 of file fvModelsTemplates.C.
References IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const GeometricField< Type, fvPatchField, volMesh > & | field, |
const word & | fieldName | ||
) | const |
Definition at line 87 of file fvModelsTemplates.C.
References Foam::dimTime, and Foam::dimVolume.
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const volScalarField & | rho, |
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Definition at line 98 of file fvModelsTemplates.C.
References IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const volScalarField & | rho, |
const GeometricField< Type, fvPatchField, volMesh > & | field, | ||
const word & | fieldName | ||
) | const |
Definition at line 109 of file fvModelsTemplates.C.
References Foam::dimTime, and Foam::dimVolume.
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Definition at line 121 of file fvModelsTemplates.C.
References IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field, | ||
const word & | fieldName | ||
) | const |
Definition at line 133 of file fvModelsTemplates.C.
References Foam::dimTime, and Foam::dimVolume.
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const geometricOneField & | alpha, |
const geometricOneField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Definition at line 146 of file fvModelsTemplates.C.
References IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const volScalarField & | alpha, |
const geometricOneField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Definition at line 158 of file fvModelsTemplates.C.
References Foam::dimless, and IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > source | ( | const geometricOneField & | alpha, |
const volScalarField & | rho, | ||
const GeometricField< Type, fvPatchField, volMesh > & | field | ||
) | const |
Definition at line 185 of file fvModelsTemplates.C.
References fvModels::d2dt2(), and IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > d2dt2 | ( | const GeometricField< Type, fvPatchField, volMesh > & | field | ) | const |
Definition at line 199 of file fvModelsTemplates.C.
References Foam::fvc::d2dt2(), fvModels::d2dt2(), and IOobject::name().
Foam::tmp<Foam::fvMatrix<Type> > d2dt2 | ( | const GeometricField< Type, fvPatchField, volMesh > & | field, |
const word & | fieldName | ||
) | const |
Definition at line 209 of file fvModelsTemplates.C.
References Foam::dimTime, Foam::dimVolume, and Foam::sqr().