List of Lagrangian models, constructed as a (Lagrangian) mesh object. Provides similar functions to the models themselves and forwards them to each model in turn. This is the high level model interface used by clouds when constructing their injections and transport equations. More...
Classes | |
| struct | modelTypeFieldSourceType< ModelType, FieldSourceType, ModelAndFieldSourceTypes ... > |
| struct | modelTypeFieldSourceType<> |
Public Member Functions | |
| TypeName ("LagrangianModels") | |
| Runtime type information. More... | |
| LagrangianModels (const LagrangianModels &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~LagrangianModels () |
| Destructor. More... | |
| virtual bool | global () const |
| Declare LagrangianModels to be a global dictionary. More... | |
| bool | addsSupToField (const word &) const |
| Return true if the LagrangianModels adds a source term to the. More... | |
| template<class Type , template< class > class PrimitiveField> | |
| bool | addsSupToField (const LagrangianSubField< Type, PrimitiveField > &field) const |
| Return true if the LagrangianModels adds a source term to the. More... | |
| void | correct () |
| Correct the LagrangianModels. More... | |
| LagrangianSubMesh | preModify (LagrangianMesh &mesh) const |
| Identify elements in the Lagrangian mesh which are to be. More... | |
| LagrangianSubMesh | modify (LagrangianMesh &mesh, const LagrangianSubMesh &modifiedMesh) const |
| Instantaneously modify and/or create and remove elements in the. More... | |
| void | calculate (const LagrangianSubScalarField &deltaT, const bool final) |
| Solve equations and/or update continually changing properties. More... | |
| template<class ... ModelAndFieldSourceTypes> | |
| HashTable< word > | modelTypeFieldSourceTypes () const |
| Return a table of field source types that are chosen to match given. More... | |
| tmp< LagrangianSubScalarField > | source (const LagrangianSubScalarField &deltaT) const |
| Return the fractional source. More... | |
| template<class Type , template< class > class PrimitiveField> | |
| tmp< LagrangianEqn< Type > > | source (const LagrangianSubScalarField &deltaT, const LagrangianSubField< Type, PrimitiveField > &field) const |
| Return source for an equation. More... | |
| template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField> | |
| tmp< LagrangianEqn< Type > > | sourceProxy (const LagrangianSubScalarField &deltaT, const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnField) const |
| Return source for an equation. More... | |
| template<class Type , template< class > class PrimitiveField> | |
| tmp< LagrangianEqn< Type > > | source (const LagrangianSubScalarField &deltaT, const LagrangianSubField< scalar, PrimitiveField > &m, const LagrangianSubField< Type, PrimitiveField > &field) const |
| Return source for a mass-weighted equation. More... | |
| template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField> | |
| tmp< LagrangianEqn< Type > > | sourceProxy (const LagrangianSubScalarField &deltaT, const LagrangianSubField< scalar, PrimitiveField > &m, const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnField) const |
| Return source for a mass-weighted equation. More... | |
| virtual bool | movePoints () |
| Update for mesh motion. Only for mesh object. Does nothing. 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 | read () |
| Read the LagrangianModels dictionary if it has changed. More... | |
| virtual bool | readData (Istream &) |
| ReadData function which reads the LagrangianModels dictionary. More... | |
| virtual bool | writeData (Ostream &os) const |
| writeData function required by regIOobject but not used More... | |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool write) const |
| Write the LagrangianModels. More... | |
| void | operator= (const LagrangianModels &)=delete |
| Disallow default bitwise assignment. More... | |
| template<class Type , template< class > class PrimitiveField, class ... AlphaRhoFieldTypes> | |
| Foam::tmp< Foam::LagrangianEqn< Type > > | sourceTerm (const LagrangianSubField< Type, PrimitiveField > &eqnField, const LagrangianSubScalarField &deltaT, const AlphaRhoFieldTypes &... alphaRhoFields) const |
| template<class ... ModelAndFieldSourceTypes> | |
| Foam::HashTable< Foam::word > | modelTypeFieldSourceTypes () const |
| template<class Type , template< class > class PrimitiveField> | |
| Foam::tmp< Foam::LagrangianEqn< Type > > | source (const LagrangianSubScalarField &deltaT, const LagrangianSubField< Type, PrimitiveField > &field) const |
| template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField> | |
| Foam::tmp< Foam::LagrangianEqn< Type > > | sourceProxy (const LagrangianSubScalarField &deltaT, const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnField) const |
| template<class Type , template< class > class PrimitiveField> | |
| Foam::tmp< Foam::LagrangianEqn< Type > > | source (const LagrangianSubScalarField &deltaT, const LagrangianSubField< scalar, PrimitiveField > &m, const LagrangianSubField< Type, PrimitiveField > &field) const |
| template<class Type , template< class > class PrimitiveField, template< class > class PrimitiveEqnField> | |
| Foam::tmp< Foam::LagrangianEqn< Type > > | sourceProxy (const LagrangianSubScalarField &deltaT, const LagrangianSubField< scalar, PrimitiveField > &m, const LagrangianSubField< Type, PrimitiveField > &field, const LagrangianSubField< Type, PrimitiveEqnField > &eqnField) const |
 Public Member Functions inherited from DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels > | |
| virtual const word & | type () const |
| Runtime type information. More... | |
| virtual | ~DemandDrivenMeshObject () |
| const LagrangianMesh & | mesh () const |
| 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 (regIOobject &&) | |
| Move constructor. More... | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Copy constructor, transferring registry registration to copy. More... | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy constructor with new name, transferring registry registration. More... | |
| regIOobject (const IOobject &, const regIOobject &) | |
| Copy constructor with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| virtual bool | globalFile () const |
| Return true if object is global, i.e. same for all processors. More... | |
| const fileName & | caseName () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | registered () const |
| Is this object registered with the registry? More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| void | store () |
| Transfer ownership of this object to its registry. More... | |
| void | release () |
| Release ownership of this object from its registry. More... | |
| label | eventNo () const |
| Event number at last update. More... | |
| label & | eventNo () |
| Event number at last update. More... | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. More... | |
| void | setUpToDate () |
| Set up to date (obviously) More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool read=true) |
| Return Istream and check object type against that given. More... | |
| void | close () |
| Close Istream. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) More... | |
| virtual bool | dependenciesModified () const |
| Return true if the object's dependencies have been modified. More... | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | write (const bool write=true) const |
| Write using setting from DB. More... | |
| void | operator= (const IOobject &)=delete |
| Assign to IOobject. More... | |
| void | operator= (const regIOobject &)=delete |
| Disallow default assignment. More... | |
| const fileName & | caseName (const bool global) const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | filePath (const bool global) const |
| Return complete path + object name if the file exists. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, registry, io options. More... | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from name, instance, local, registry, io options. More... | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Construct from copy resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Construct from copy resetting name. More... | |
| IOobject (const IOobject &io)=default | |
| Copy constructor. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| virtual | ~IOobject () |
| Destructor. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const word & | name () const |
| Return name. More... | |
| const word & | headerClassName () const |
| Return name of the class name read from header. More... | |
| word & | headerClassName () |
| Return name of the class name read from header. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| bool & | registerObject () |
| Register object created from this IOobject with registry if true. More... | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. More... | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () const |
| Return the instance directory, constant, system, <time> etc. More... | |
| void | updateInstance () const |
| If the instance is a time directory update to the current time. More... | |
| void | updateTimeInstance () const |
| Update instance 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 bool global) const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read header of local object without type-checking. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &) const |
| Write header. More... | |
| bool | writeHeader (Ostream &, const word &objectType) const |
| Write header. Allow override of type. More... | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. More... | |
| void | operator= (const IOobject &) |
| template<class Name > | |
| Foam::word | groupName (Name name, const word &group) |
| Public Member Functions inherited from TopoChangeableMeshObject< Mesh > | |
| template<class Type > | |
| TopoChangeableMeshObject (Type &mo) | |
| Public Member Functions inherited from DistributeableMeshObject< Mesh > | |
| template<class Type > | |
| DistributeableMeshObject (Type &mo) | |
| Public Member Functions inherited from MoveableMeshObject< Mesh > | |
| template<class Type > | |
| MoveableMeshObject (Type &mo) | |
| Public Member Functions inherited from DeletableMeshObject< Mesh > | |
| template<class Type > | |
| DeletableMeshObject (Type &mo) | |
| virtual | ~DeletableMeshObject ()=default |
| Virtual destructor to make class polymorphic. More... | |
| 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) | |
| Construct an empty sub-dictionary with given name and parent. More... | |
| dictionary (const fileName &name, const dictionary &parentDict, Istream &) | |
| Construct given the 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... | |
| template<class ... Entries> | |
| dictionary (const std::tuple< const Entries &... > &) | |
| Construct top-level dictionary with given entries. More... | |
| template<class ... Entries> | |
| dictionary (const fileName &name, const std::tuple< const Entries &... > &) | |
| Construct top-level dictionary with given name and entries. More... | |
| template<class ... Entries> | |
| dictionary (const fileName &name, const dictionary &parentDict, const std::tuple< const Entries &... > &) | |
| Construct dictionary with given name, parent and entries. More... | |
| template<class ... Entries> | |
| dictionary (const dictionary &dict, const std::tuple< const Entries &... > &) | |
| Construct dictionary as copy and add a list of entries. 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... | |
| virtual label | startLineNumber () const |
| Return line number of first token in dictionary. More... | |
| virtual label | endLineNumber () const |
| Return line number of last token in dictionary. More... | |
| SHA1Digest | digest () const |
| Return the SHA1 digest of the dictionary contents. More... | |
| tokenList | tokens () const |
| Return the dictionary as a list of tokens. More... | |
| bool | found (const word &, bool recursive=false, bool patternMatch=true) const |
| Search dictionary for given keyword. More... | |
| const entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present. More... | |
| entry * | lookupEntryPtr (const word &, bool recursive, bool patternMatch) |
| Find and return an entry data stream pointer for manipulation. More... | |
| const entry * | lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present, trying a list. More... | |
| const entry & | lookupEntry (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present otherwise error. More... | |
| const entry & | lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream if present, trying a list. More... | |
| ITstream & | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream. More... | |
| ITstream & | lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const |
| Find and return an entry data stream, trying a list of keywords. More... | |
| template<class T > | |
| T | lookup (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, if not found throw a fatal error. More... | |
| template<class T > | |
| T | lookup (const word &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, trying a list of keywords in sequence,. More... | |
| template<class T > | |
| T | lookupBackwardsCompatible (const wordList &, const unitConversion &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T, with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &, const T &, const bool writeDefault=writeOptionalEntries > 0) const |
| Find and return a T, if not found return the given default. More... | |
| template<class T > | |
| T | lookupOrDefault (const word &, const unitConversion &, const T &, const bool writeDefault=writeOptionalEntries > 0) const |
| Find and return a T with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrDefaultBackwardsCompatible (const wordList &, const T &) const |
| Find and return a T, trying a list of keywords in sequence,. More... | |
| template<class T > | |
| T | lookupOrDefaultBackwardsCompatible (const wordList &, const unitConversion &, const T &) const |
| Find and return a T, with dimension checking and unit. More... | |
| template<class T > | |
| T | lookupOrAddDefault (const word &, const T &) |
| Find and return a T, if not found return the given. More... | |
| template<class T > | |
| bool | readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const |
| Find an entry if present, and assign to T. More... | |
| template<class T > | |
| bool | readIfPresent (const word &, const unitConversion &, T &, bool recursive=false, bool patternMatch=true) const |
| Find an entry if present, and assign to T, with dimension. More... | |
| const entry * | lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const |
| Find and return an entry data stream pointer if present,. More... | |
| template<class T > | |
| T | lookupScoped (const word &, bool recursive=false, bool patternMatch=true) const |
| Find and return a T,. More... | |
| template<class T > | |
| const T & | lookupCompoundScoped (const word &keyword, bool recursive, bool patternMatch) const |
| Find return the reference to the compound T,. More... | |
| bool | isDict (const word &) const |
| Check if entry is a sub-dictionary. More... | |
| const dictionary * | subDictPtr (const word &) const |
| Find and return a sub-dictionary pointer if present. More... | |
| dictionary * | subDictPtr (const word &) |
| Find and return a sub-dictionary pointer if present. More... | |
| const dictionary & | subDict (const word &) const |
| Find and return a sub-dictionary. More... | |
| dictionary & | subDict (const word &) |
| Find and return a sub-dictionary for manipulation. More... | |
| const dictionary & | subDictBackwardsCompatible (const wordList &) const |
| Find and return a sub-dictionary, trying a list of keywords in. More... | |
| const dictionary & | subOrEmptyDict (const word &, const bool mustRead=false) const |
| Find and return a sub-dictionary. 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 | 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 ... Entries> | |
| void | set (const entry &e, const Entries &...) |
| Assign multiple entries, overwriting any existing entries. More... | |
| template<class T , class ... Entries> | |
| void | set (const keyType &, const T &, const Entries &...) |
| Assign multiple T entries, overwriting any existing entries. More... | |
| bool | remove (const word &) |
| Remove an entry specified by keyword. More... | |
| void | remove (const wordList &) |
| Remove entries specified by keywords. More... | |
| bool | changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false) |
| Change the keyword for an entry,. More... | |
| bool | merge (const dictionary &) |
| Merge entries from the given dictionary. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (dictionary &) |
| Transfer the contents of the argument and annul the argument. More... | |
| bool | read (Istream &, const bool keepHeader=false) |
| Read dictionary from Istream, optionally keeping the header. More... | |
| void | write (Ostream &, const bool subDict=true) const |
| Write dictionary, normally with sub-dictionary formatting. More... | |
| ITstream & | operator[] (const word &) const |
| Find and return entry. More... | |
| void | operator= (const dictionary &) |
| void | operator+= (const dictionary &) |
| Include entries from the given dictionary. More... | |
| void | operator|= (const dictionary &) |
| Conditionally include entries from the given dictionary. More... | |
| void | operator<<= (const dictionary &) |
| Unconditionally include entries from the given dictionary. More... | |
| template<class ... Entries> | |
| std::tuple< const Entries &... > | entries (const Entries &... entries) |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const T &defaultValue, const bool writeDefault) const |
| template<class T > | |
| T | lookupOrDefault (const word &keyword, const unitConversion &defaultUnits, const T &defaultValue, const bool writeDefault) const |
| template<class ... Entries> | |
| void | set (const entry &e, const Entries &... entries) |
| template<class T , class ... Entries> | |
| void | set (const keyType &k, const T &t, const Entries &... entries) |
| 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< LagrangianModel > | |
| 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... | |
| label | findIndex (const word &key) const |
| Return the index of the given the key or -1 if not found. More... | |
| List< label > | findIndices (const wordRe &key) const |
| Return the indices for all matches. More... | |
| void | append (const word &key, LagrangianModel *) |
| Append an element at the end of the list. More... | |
| void | append (const word &key, const autoPtr< LagrangianModel > &) |
| Append an element at the end of the list. More... | |
| void | append (const word &key, const tmp< LagrangianModel > &) |
| Append an element at the end of the list. More... | |
| void | append (LagrangianModel *) |
| Append an element at the end of the list. More... | |
| void | append (const autoPtr< LagrangianModel > &) |
| Append an element at the end of the list. More... | |
| void | append (const tmp< LagrangianModel > &) |
| Append an element at the end of the list. More... | |
| autoPtr< LagrangianModel > | set (const label, const word &key, LagrangianModel *) |
| Set element to pointer provided and return old element. More... | |
| autoPtr< LagrangianModel > | set (const label, const word &key, const autoPtr< LagrangianModel > &) |
| Set element to autoPtr value provided and return old element. More... | |
| autoPtr< LagrangianModel > | set (const label, const word &key, const tmp< LagrangianModel > &) |
| Set element to tmp value provided and return old element. More... | |
| autoPtr< LagrangianModel > | set (const label, LagrangianModel *) |
| Set element to pointer provided and return old element. More... | |
| autoPtr< LagrangianModel > | set (const label, const autoPtr< LagrangianModel > &) |
| Set element to autoPtr value provided and return old element. More... | |
| autoPtr< LagrangianModel > | set (const label, const tmp< LagrangianModel > &) |
| Set element to tmp value provided and return old element. More... | |
| autoPtr< LagrangianModel > | remove (const word &key) |
| Remove an entry from the list and return. More... | |
| UPtrListDictionary< T2 > | convert () |
| Convert to list of different type. More... | |
| Foam::UPtrListDictionary< T2 > | convert () |
| UPtrListDictionary< T2 > | lookupType () |
| Lookup and return the sub-list of the given type. More... | |
| UPtrListDictionary< const T2 > | lookupType () const |
| Lookup and return the sub-list of the given type. More... | |
| Foam::UPtrListDictionary< T2 > | lookupType () |
| Foam::UPtrListDictionary< const T2 > | lookupType () const |
| const LagrangianModel & | operator[] (const word &key) const |
| Find and return entry. More... | |
| LagrangianModel & | operator[] (const word &key) |
| Find and return entry. More... | |
| Public Member Functions inherited from DictionaryBase< IDLListType, T > | |
| DictionaryBase (const label size=128) | |
| Construct given initial table size. More... | |
| DictionaryBase (const DictionaryBase &) | |
| Copy constructor. More... | |
| DictionaryBase (DictionaryBase &&) | |
| Move constructor. More... | |
| template<class INew > | |
| 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 T * | lookupPtr (const word &) const |
| Find and return an entry if present, otherwise return nullptr. More... | |
| T * | lookupPtr (const word &) |
| Find and return an entry if present, otherwise return nullptr. More... | |
| const T * | lookup (const word &) const |
| Find and return entry. More... | |
| T * | 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 &, T *) |
| Add at head of dictionary. More... | |
| void | append (const word &, T *) |
| Add at tail of dictionary. More... | |
| T * | remove (const word &) |
| Remove and return entry specified by keyword. More... | |
| void | clear () |
| Clear the dictionary. More... | |
| void | transfer (DictionaryBase< IDLListType, T > &) |
| Transfer the contents of the argument into this DictionaryBase. More... | |
| void | operator= (const DictionaryBase &) |
| const T * | operator[] (const word &key) const |
| Find and return entry. More... | |
| T * | operator[] (const word &key) |
| Find and return entry. More... | |
Protected Member Functions | |
| LagrangianModels (const LagrangianMesh &mesh) | |
| Construct for a mesh. More... | |
| Protected Member Functions inherited from DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels > | |
| DemandDrivenMeshObject (const IOobject &io, const LagrangianMesh &mesh) | |
| Construct from mesh and IOobject. More... | |
| DemandDrivenMeshObject (const word &name, const LagrangianMesh &mesh) | |
| Construct from mesh and name. More... | |
| DemandDrivenMeshObject (const LagrangianMesh &mesh) | |
| Construct from mesh, the name is set to Type::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 | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
| Protected Member Functions inherited from DictionaryBase< IDLListType, T > | |
| void | addEntries () |
Friends | |
| class | DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels > |
| Let the mesh object use the protected constructors. 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 |
| Static Public Member Functions inherited from DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels > | |
| static LagrangianModels & | New (const word &name, const LagrangianMesh &mesh) |
| Construct and return the named DemandDrivenMeshObject. More... | |
| static LagrangianModels & | New (const LagrangianMesh &mesh) |
| Construct and return the DemandDrivenMeshObject named Type::typeName. More... | |
| static LagrangianModels & | New (const word &name, const LagrangianMesh &mesh, const Args &... args) |
| Construct and return the named DemandDrivenMeshObject. More... | |
| static LagrangianModels & | New (const LagrangianMesh &mesh, const Args &... args) |
| Construct and return the DemandDrivenMeshObject named Type::typeName. More... | |
| static bool | found (const word &name, const LagrangianMesh &mesh) |
| Return true if the DemandDrivenMeshObject with the given name. More... | |
| static bool | found (const LagrangianMesh &mesh) |
| Return true if the DemandDrivenMeshObject named Type::typeName. 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 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 | |
| template<class ... Entries> | |
| static std::tuple< const Entries &... > | entries (const Entries &...) |
| Construct an entries tuple from which to make a dictionary. More... | |
| 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 int | writeOptionalEntries |
| If true write optional keywords and values. More... | |
| Protected Attributes inherited from DictionaryBase< IDLListType, T > | |
| HashTable< T * > | hashedTs_ |
| HashTable of the entries held on the IDLListType for quick lookup. More... | |
List of Lagrangian models, constructed as a (Lagrangian) mesh object. Provides similar functions to the models themselves and forwards them to each model in turn. This is the high level model interface used by clouds when constructing their injections and transport equations.
Definition at line 54 of file LagrangianModels.H.
|
explicitprotected |
Construct for a mesh.
Definition at line 93 of file LagrangianModels.C.
References regIOobject::addWatch(), IOstream::ASCII, dict, forAll, forAllConstIter, dictionary::isDict(), DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels >::mesh(), dictionaryName::name(), LagrangianModel::New(), regIOobject::readHeaderOk(), PtrListDictionary< T >::set(), and PtrList< T >::setSize().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 163 of file LagrangianModels.C.
| TypeName | ( | "LagrangianModels" | ) |
Runtime type information.
|
inlinevirtual |
Declare LagrangianModels to be a global dictionary.
Reimplemented from dictionary.
Definition at line 147 of file LagrangianModels.H.
| bool addsSupToField | ( | const word & | fieldName | ) | const |
Return true if the LagrangianModels adds a source term to the.
given field's transport equation
Definition at line 169 of file LagrangianModels.C.
References LagrangianModel::addsSupToField(), and forAll.
Referenced by kinematicParcel::dUdt(), kinematicParticle::dUdt(), parcel::dUdt(), and particle::dUdt().
| bool addsSupToField | ( | const LagrangianSubField< Type, PrimitiveField > & | field | ) | const |
Return true if the LagrangianModels adds a source term to the.
given field's transport equation
Definition at line 117 of file LagrangianModelsTemplates.C.
References LagrangianModel::fieldName().
| void correct | ( | ) |
Correct the LagrangianModels.
Definition at line 187 of file LagrangianModels.C.
References forAll.
Referenced by cloud::solve().
| Foam::LagrangianSubMesh preModify | ( | LagrangianMesh & | mesh | ) | const |
Identify elements in the Lagrangian mesh which are to be.
instantaneously modified and put them in contiguous groups
Definition at line 198 of file LagrangianModels.C.
References forAll, mesh, and Foam::none.
Referenced by cloud::solve().
| Foam::LagrangianSubMesh modify | ( | LagrangianMesh & | mesh, |
| const LagrangianSubMesh & | modifiedMesh | ||
| ) | const |
Instantaneously modify and/or create and remove elements in the.
Lagrangian mesh
Definition at line 234 of file LagrangianModels.C.
References LagrangianSubMesh::end(), forAll, mesh, and HashTable< T, Key, Hash >::size().
Referenced by cloud::solve().
| void calculate | ( | const LagrangianSubScalarField & | deltaT, |
| const bool | final | ||
| ) |
Solve equations and/or update continually changing properties.
Definition at line 258 of file LagrangianModels.C.
References forAll.
Referenced by cloud::solve().
Return a table of field source types that are chosen to match given.
model types. So, e.g., a zero field source for every injection model. Useful for programmatically constructing fields. Template arguments should alternate between model and field types; i.e., model-type-1, field-source-type-1, model-type-2, field-source-type-2, model-type-3, ...
| Foam::tmp< Foam::LagrangianSubScalarField > source | ( | const LagrangianSubScalarField & | deltaT | ) | const |
Return the fractional source.
Definition at line 274 of file LagrangianModels.C.
References LagrangianModel::addsSupToField(), LagrangianModel::addSup(), Foam::dimRate, forAll, DictionaryBase< IDLListType, T >::insert(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), word::null, tmp< T >::ref(), and Foam::fvm::S().
| tmp<LagrangianEqn<Type> > source | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< Type, PrimitiveField > & | field | ||
| ) | const |
Return source for an equation.
| tmp<LagrangianEqn<Type> > sourceProxy | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< Type, PrimitiveField > & | field, | ||
| const LagrangianSubField< Type, PrimitiveEqnField > & | eqnField | ||
| ) | const |
Return source for an equation.
| tmp<LagrangianEqn<Type> > source | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< scalar, PrimitiveField > & | m, | ||
| const LagrangianSubField< Type, PrimitiveField > & | field | ||
| ) | const |
Return source for a mass-weighted equation.
| tmp<LagrangianEqn<Type> > sourceProxy | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< scalar, PrimitiveField > & | m, | ||
| const LagrangianSubField< Type, PrimitiveField > & | field, | ||
| const LagrangianSubField< Type, PrimitiveEqnField > & | eqnField | ||
| ) | const |
Return source for a mass-weighted equation.
|
virtual |
Update for mesh motion. Only for mesh object. Does nothing.
Lagrangian evolves continuously across the range of mesh motion, so no instantaneous update is needed.
Implements MoveableMeshObject< Mesh >.
Definition at line 305 of file LagrangianModels.C.
|
virtual |
Update topology using the given map.
Implements TopoChangeableMeshObject< Mesh >.
Definition at line 311 of file LagrangianModels.C.
References forAll.
|
virtual |
Update from another mesh using the given map.
Implements TopoChangeableMeshObject< Mesh >.
Definition at line 322 of file LagrangianModels.C.
References forAll.
|
virtual |
Redistribute or update using the given distribution map.
Implements DistributeableMeshObject< Mesh >.
Definition at line 333 of file LagrangianModels.C.
References forAll.
|
virtual |
Read the LagrangianModels dictionary if it has changed.
and update the models
Reimplemented from regIOobject.
Definition at line 344 of file LagrangianModels.C.
References forAll, mesh, Foam::name(), dictionary::optionalSubDict(), regIOobject::read(), fvMesh::time(), and TimeState::timeIndex().
|
virtual |
ReadData function which reads the LagrangianModels dictionary.
required for regIOobject read operation
Reimplemented from regIOobject.
Definition at line 375 of file LagrangianModels.C.
References IOstream::bad().
|
virtual |
writeData function required by regIOobject but not used
for this class, writeObject is used instead
Reimplemented from DemandDrivenMeshObject< LagrangianMesh, TopoChangeableMeshObject, LagrangianModels >.
Definition at line 382 of file LagrangianModels.C.
References IOstream::good(), and dictionary::write().
|
virtual |
Write the LagrangianModels.
Reimplemented from regIOobject.
Definition at line 389 of file LagrangianModels.C.
References forAll, and Foam::vtkWriteOps::write().
|
delete |
Disallow default bitwise assignment.
| Foam::tmp<Foam::LagrangianEqn<Type> > sourceTerm | ( | const LagrangianSubField< Type, PrimitiveField > & | eqnField, |
| const LagrangianSubScalarField & | deltaT, | ||
| const AlphaRhoFieldTypes &... | alphaRhoFields | ||
| ) | const |
Definition at line 36 of file LagrangianModelsTemplates.C.
References LagrangianModel::addsSupToField(), LagrangianModel::addSup(), LagrangianModel::fieldName(), LagrangianModel::fieldsName(), forAll, tmp< T >::ref(), and Foam::toSubField().
| Foam::HashTable<Foam::word> modelTypeFieldSourceTypes | ( | ) | const |
Definition at line 128 of file LagrangianModelsTemplates.C.
References forAll, and Foam::vtkWriteOps::insert().
| Foam::tmp<Foam::LagrangianEqn<Type> > source | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< Type, PrimitiveField > & | field | ||
| ) | const |
Definition at line 147 of file LagrangianModelsTemplates.C.
| Foam::tmp<Foam::LagrangianEqn<Type> > sourceProxy | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< Type, PrimitiveField > & | field, | ||
| const LagrangianSubField< Type, PrimitiveEqnField > & | eqnField | ||
| ) | const |
Definition at line 163 of file LagrangianModelsTemplates.C.
| Foam::tmp<Foam::LagrangianEqn<Type> > source | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< scalar, PrimitiveField > & | m, | ||
| const LagrangianSubField< Type, PrimitiveField > & | field | ||
| ) | const |
Definition at line 175 of file LagrangianModelsTemplates.C.
| Foam::tmp<Foam::LagrangianEqn<Type> > sourceProxy | ( | const LagrangianSubScalarField & | deltaT, |
| const LagrangianSubField< scalar, PrimitiveField > & | m, | ||
| const LagrangianSubField< Type, PrimitiveField > & | field, | ||
| const LagrangianSubField< Type, PrimitiveEqnField > & | eqnField | ||
| ) | const |
Definition at line 192 of file LagrangianModelsTemplates.C.
|
friend |
Let the mesh object use the protected constructors.
Definition at line 95 of file LagrangianModels.H.
1.9.1 
