regionModel Class Reference

Base class for region models. More...

Inheritance diagram for regionModel:
[legend]
Collaboration diagram for regionModel:
[legend]

Public Member Functions

 TypeName ("regionModel")
 Runtime type information. More...
 
 regionModel (const fvMesh &mesh, const word &regionType)
 Construct null. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
 Construct from mesh, region type and name. More...
 
 regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
 Construct from mesh and name and dict. More...
 
virtual ~regionModel ()=default
 Destructor. More...
 
const fvMeshprimaryMesh () const
 Return the reference to the primary mesh database. More...
 
const Timetime () const
 Return the reference to the time database. More...
 
Switch active () const
 Return the active flag. More...
 
Switch infoOutput () const
 Return the information flag. More...
 
const wordmodelName () const
 Return the model name. More...
 
const fvMeshregionMesh () const
 Return the region mesh database. More...
 
fvMeshregionMesh ()
 Return the region mesh database for manipulation. More...
 
const dictionarycoeffs () const
 Return the model coefficients dictionary. More...
 
const dictionarysolution () const
 Return the solution dictionary. More...
 
const IOdictionaryoutputProperties () const
 Return const access to the output properties dictionary. More...
 
IOdictionaryoutputProperties ()
 Return output properties dictionary. More...
 
bool isCoupledPatch (const label regionPatchi) const
 Return true if patchi on the local region is a coupled. More...
 
bool isRegionPatch (const label primaryPatchi) const
 Return true if patchi on the primary region is a coupled. More...
 
const labelListprimaryPatchIDs () const
 Return the list of patch IDs on the primary region coupled. More...
 
const labelListintCoupledPatchIDs () const
 Return the list of patch IDs internally coupled with the. More...
 
label regionPatchID (const label primaryPatchID) const
 Return region ID corresponding to primaryPatchID. More...
 
label nbrCoupledPatchID (const regionModel &nbrRegion, const label regionPatchi) const
 Return the coupled patch ID paired with coupled patch. More...
 
template<class Type >
tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 Map patch field from another region model to local patch. More...
 
template<class Type >
tmp< Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip=false) const
 Map patch internal field from another region model to local. More...
 
template<class Type >
void toPrimary (const label regionPatchi, List< Type > &regionField) const
 Convert a local region field to the primary region. More...
 
template<class Type >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
 Convert a primary region field to the local region. More...
 
template<class Type , class CombineOp >
void toPrimary (const label regionPatchi, List< Type > &regionField, const CombineOp &cop) const
 Convert a local region field to the primary region with op. More...
 
template<class Type , class CombineOp >
void toRegion (const label regionPatchi, List< Type > &primaryFieldField, const CombineOp &cop) const
 Convert a primary region field to the local region with op. More...
 
virtual void evolve ()
 Main driver routing to evolve the region - calls other evolves. More...
 
virtual void preEvolveRegion ()
 Pre-evolve region. More...
 
virtual void evolveRegion ()
 Evolve the region. More...
 
virtual void postEvolveRegion ()
 Post-evolve region. More...
 
virtual void info ()
 Provide some feedback. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const Field< Type > &nbrField, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > mapRegionPatchInternalField (const regionModel &nbrRegion, const word &fieldName, const label regionPatchi, const bool flip) const
 
- Public Member Functions inherited from IOdictionary
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
virtual bool global () const
 Is object global. More...
 
virtual fileName filePath () const
 Return complete path + object name if the file exists. More...
 
- Public Member Functions inherited from baseIOdictionary
 TypeName ("dictionary")
 Declare type-name, virtual type (with debug switch) More...
 
 baseIOdictionary (const baseIOdictionary &)=default
 Copy construct. More...
 
 baseIOdictionary (baseIOdictionary &&)=default
 Move construct. More...
 
virtual ~baseIOdictionary ()=default
 Destructor. More...
 
 baseIOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 baseIOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 baseIOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
const wordname () const
 
virtual bool readData (Istream &)
 The readData function required by regIOobject read operation. More...
 
virtual bool writeData (Ostream &) const
 The writeData function required by regIOobject write operation. More...
 
void operator= (const baseIOdictionary &)
 Copy assignment of dictionary entries (leave regIOobject untouched) More...
 
void operator= (const dictionary &rhs)
 Copy assignment of dictionary entries. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTime=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 regIOobject (const IOobject &io, const regIOobject &rio)
 Copy construct with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry, if not already registered. More...
 
bool checkOut ()
 Remove all file watches and remove object from registry. More...
 
virtual void addWatch ()
 Add file watch on object (if registered and READ_IF_MODIFIED) More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
bool store ()
 
void release (const bool unregister=false)
 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 as up-to-date. More...
 
virtual void rename (const word &newName)
 Rename. More...
 
bool headerOk ()
 Read and check header info. More...
 
IstreamreadStream (const word &, const bool valid=true)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual label addWatch (const fileName &)
 Add file watch for fileName on object if not yet watched. More...
 
const labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 Return file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=true) const
 Write using setting from DB. More...
 
void operator= (const IOobject &io)
 Copy assignment. More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const
 Write using given format, version and compression. More...
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Declare type-name, virtual type (with debug switch) More...
 
 IOobject (const IOobject &)=default
 Copy construct. More...
 
virtual ~IOobject ()=default
 Destructor. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 Copy construct, resetting registry. More...
 
 IOobject (const IOobject &io, const word &name)
 Copy construct, resetting name. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const Timetime () const
 Return time. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return non-constant access to the class name read from header. More...
 
const stringnote () const
 Return the optional note. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
bool registerObject () const
 Should object created with this IOobject be registered? More...
 
boolregisterObject ()
 Should object created with this IOobject be registered? More...
 
bool globalObject () const
 Is object same for all processors? More...
 
boolglobalObject ()
 Is object same for all processors? More...
 
unsigned labelByteSize () const
 The label byte-size, possibly read from the header. More...
 
unsigned scalarByteSize () const
 The scalar byte-size, possibly read from the header. More...
 
bool isHeaderClassName (const word &clsName) const
 Test if headerClassName() equals the given class name. More...
 
template<class Type >
bool isHeaderClassName () const
 Test if headerClassName() equals Type::typeName. More...
 
readOption readOpt () const
 The read option. More...
 
readOptionreadOpt ()
 Non-constant access to the read option. More...
 
writeOption writeOpt () const
 The write option. More...
 
writeOptionwriteOpt ()
 Non-constant access to the write option. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete path + object name. More...
 
fileName localFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
bool readHeader (Istream &is)
 Read header. More...
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. More...
 
template<class Type >
void warnNoRereading () const
 Helper: warn that type does not support re-reading. More...
 
bool writeHeader (Ostream &os) const
 Write header. More...
 
bool writeHeader (Ostream &os, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &io)
 
template<>
bool isHeaderClassName () const
 Specialization for void always returns true (no headerClassName check). More...
 
template<class StringType >
Foam::word groupName (StringType base, const word &group)
 
template<class StringType >
Foam::word scopedName (StringType scope, const word &name)
 
- 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 &is, bool keepHeader=false)
 
 dictionary (Istream &is)
 
 dictionary (Istream &is, bool keepHeader)
 
 dictionary (const dictionary &parentDict, const dictionary &dict)
 Copy construct given the parent dictionary. More...
 
 dictionary (const dictionary &dict)
 Copy construct top-level dictionary. More...
 
 dictionary (const dictionary *dict)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, dictionary &&dict)
 Move construct for given parent dictionary. More...
 
 dictionary (dictionary &&dict)
 Move construct top-level dictionary. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. More...
 
const fileNamename () const
 The dictionary name. More...
 
fileNamename ()
 The dictionary name for modification (use with caution). More...
 
word dictName () const
 The local dictionary name (final part of scoped name) More...
 
const dictionaryparent () const
 Return the parent dictionary. More...
 
const dictionarytopDict () const
 Return the top of the tree. More...
 
label startLineNumber () const
 Return line number of first token in dictionary. More...
 
label endLineNumber () const
 Return line number of last token in dictionary. More...
 
SHA1Digest digest () const
 Return the SHA1 digest of the dictionary contents. More...
 
tokenList tokens () const
 Return the dictionary as a list of tokens. More...
 
bool found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for an entry (const access) with the given keyword. More...
 
entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find for an entry (non-const access) with the given keyword. More...
 
const entryfindEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find an entry (const access) with the given keyword. More...
 
const entryfindScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Search for a scoped entry (const access) with the given keyword. More...
 
dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary pointer if present. More...
 
const dictionaryfindDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary pointer if present. More...
 
const entrylookupEntry (const word &keyword, enum keyType::option matchOpt) const
 Search for an entry (const access) with the given keyword. More...
 
ITstreamlookup (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T get (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T getOrAdd (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
bool readEntry (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresent (const word &keyword, T &val, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheck (const word &keyword, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrDefault (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T , class Predicate >
T getCheckOrAdd (const word &keyword, const T &deflt, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T , class Predicate >
bool readCheck (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX, bool mandatory=true) const
 
template<class T , class Predicate >
bool readCheckIfPresent (const word &keyword, T &val, const Predicate &pred, enum keyType::option matchOpt=keyType::REGEX) const
 
bool isDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Check if entry is found and is a sub-dictionary. More...
 
const dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionarysubDictOrAdd (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX, const bool mandatory=false) const
 
const dictionaryoptionalSubDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Find and return a sub-dictionary, otherwise return this dictionary. More...
 
wordList toc () const
 Return the table of contents. More...
 
wordList sortedToc () const
 Return the sorted table of contents. More...
 
template<class Compare >
wordList sortedToc (const Compare &comp) const
 Return table of contents sorted using the specified comparator. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given keyword (which is prefixed by '$') More...
 
bool substituteScopedKeyword (const word &keyword, bool mergeEntry=false)
 Substitute the given scoped keyword (which is prefixed by '$') More...
 
entryadd (entry *entryPtr, bool mergeEntry=false)
 Add a new entry. More...
 
entryadd (const entry &e, bool mergeEntry=false)
 Add an entry. More...
 
entryadd (const keyType &k, const word &v, bool overwrite=false)
 Add a word entry. More...
 
entryadd (const keyType &k, const string &v, bool overwrite=false)
 Add a string entry. More...
 
entryadd (const keyType &k, const label v, bool overwrite=false)
 Add a label entry. More...
 
entryadd (const keyType &k, const scalar v, bool overwrite=false)
 Add a scalar entry. More...
 
entryadd (const keyType &k, const dictionary &d, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
entryadd (const keyType &k, const T &v, bool overwrite=false)
 Add a T entry. More...
 
entryset (entry *entryPtr)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const entry &e)
 Assign a new entry, overwriting any existing entry. More...
 
entryset (const keyType &k, const dictionary &v)
 Assign a dictionary entry, overwriting any existing entry. More...
 
template<class T >
entryset (const keyType &k, const T &v)
 Assign a T entry, overwriting any existing entry. More...
 
bool remove (const word &keyword)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool overwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &dict)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &dict)
 Transfer the contents of the argument and annul the argument. More...
 
void checkITstream (const ITstream &is, const word &keyword) const
 
bool read (Istream &is)
 Read dictionary from Istream. More...
 
bool read (Istream &is, bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void writeEntry (Ostream &os) const
 Write sub-dictionary with its dictName as its header. More...
 
void writeEntry (const keyType &keyword, Ostream &os) const
 Write sub-dictionary with the keyword as its header. More...
 
void writeEntries (Ostream &os, const bool extraNewLine=false) const
 Write dictionary entries. More...
 
void write (Ostream &os, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
const_searcher csearch (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
const_searcher search (const word &keyword, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword. More...
 
searcher search (const word &keyword, enum keyType::option=keyType::REGEX)
 Search dictionary for given keyword. More...
 
const_searcher csearchScoped (const word &keyword, enum keyType::option) const
 Search using scoping. More...
 
const_searcher searchScoped (const word &keyword, enum keyType::option) const
 Search using dot or slash scoping. More...
 
searcher searchScoped (const word &keyword, enum keyType::option)
 Search using dot or slash scoping. More...
 
const dictionarycfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
const dictionaryfindScopedDict (const fileName &dictPath) const
 Locate a sub-dictionary using slash-scoping. More...
 
dictionaryfindScopedDict (const fileName &dictPath)
 Locate a sub-dictionary using slash-scoping. More...
 
dictionarymakeScopedDict (const fileName &dictPath)
 Locate existing or create sub-dictionary using slash-scoping. More...
 
const_searcher csearchCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
bool foundCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 Search dictionary for given keyword and any compatibility names. More...
 
const entryfindCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
const entrylookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const
 
ITstreamlookupCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option=keyType::REGEX) const
 
template<class T >
T getOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option=keyType::REGEX) const
 
template<class T >
bool readCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX, bool mandatory=true) const
 
template<class T >
bool readIfPresentCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, T &val, enum keyType::option=keyType::REGEX) const
 
void operator= (const dictionary &rhs)
 Copy assignment. More...
 
void operator+= (const dictionary &rhs)
 Include entries from the given dictionary. More...
 
void operator|= (const dictionary &rhs)
 Conditionally include entries from the given dictionary. More...
 
void operator<<= (const dictionary &rhs)
 Unconditionally include entries from the given dictionary. More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, enum keyType::option matchOpt=keyType::REGEX)
 
template<class T >
T lookupOrDefaultCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, const T &deflt, enum keyType::option matchOpt=keyType::REGEX) const
 
ITstreamoperator[] (const word &keyword) const
 Deprecated(2018-07) find and return an entry data stream. More...
 
template<class T >
T lookupType (const word &keyword, bool recursive=false, bool patternMatch=true) const
 Deprecated(2018-10) find and return a T. More...
 
bool found (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
 Deprecated(2018-10) More...
 
const entrylookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const entrylookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
const dictionarysubDictPtr (const word &keyword) const
 Deprecated(2018-10) More...
 
dictionarysubDictPtr (const word &keyword)
 
const entrylookupEntry (const word &keyword, bool recursive, bool patternMatch) const
 Deprecated(2018-10) More...
 
ITstreamlookup (const word &keyword, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
template<class T >
T lookupOrAddDefault (const word &keyword, const T &deflt, bool recursive, bool patternMatch=true)
 Deprecated(2018-10) More...
 
template<class T >
bool readIfPresent (const word &keyword, T &val, bool recursive, bool patternMatch=true) const
 Deprecated(2018-10) More...
 
bool getBool (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< bool >(const word&, keyType::option) More...
 
label getLabel (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< label >(const word&, keyType::option) More...
 
scalar getScalar (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< scalar >(const word&, keyType::option) More...
 
string getString (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< string >(const word&, keyType::option) More...
 
word getWord (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< word >(const word&, keyType::option) More...
 
fileName getFileName (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
 Same as get< fileName >(const word&, keyType::option) More...
 
template<class Compare >
Foam::wordList sortedToc (const Compare &comp) const
 
template<class T >
Foam::entryadd (const keyType &k, const T &v, bool overwrite)
 
template<class T >
Foam::entryset (const keyType &k, const T &v)
 
- Public Member Functions inherited from ILList< LListBase, T >
 ILList ()=default
 Null construct. More...
 
 ILList (T *item)
 Construct and insert the initial T item pointer. More...
 
 ILList (Istream &is)
 Construct from Istream. More...
 
 ILList (const ILList< LListBase, T > &lst)
 Copy construct using the 'clone()' method for each element. More...
 
 ILList (ILList< LListBase, T > &&lst)
 Move construct. More...
 
template<class CloneArg >
 ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone 'clone()'. More...
 
template<class INew >
 ILList (Istream &is, const INew &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 *item)
 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 > &lst)
 
void operator= (const ILList< LListBase, T > &lst)
 Copy assignment using the 'clone()' method for each element. More...
 
void operator= (ILList< LListBase, T > &&lst)
 Move assignment. More...
 

Protected Member Functions

virtual bool read ()
 Read control parameters from dictionary. More...
 
virtual bool read (const dictionary &dict)
 Read control parameters from dictionary. More...
 
virtual const AMIPatchToPatchInterpolationinterRegionAMI (const regionModel &nbrRegion, const label regionPatchi, const label nbrPatchi, const bool flip) const
 Create or return a new inter-region AMI object. More...
 
- Protected Member Functions inherited from regIOobject
bool readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName)
 Helper: check readOpt flags and read if necessary. More...
 
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
- Protected Member Functions inherited from IOobject
void setBad (const string &s)
 Set the object state to bad. More...
 

Protected Attributes

const fvMeshprimaryMesh_
 Reference to the primary mesh database. More...
 
const Timetime_
 Reference to the time database. More...
 
Switch active_
 Active flag. More...
 
Switch infoOutput_
 Active information output. More...
 
const word modelName_
 Model name. More...
 
dictionary coeffs_
 Model coefficients dictionary. More...
 
autoPtr< IOdictionaryoutputPropertiesPtr_
 Dictionary of output properties. More...
 
labelList primaryPatchIDs_
 List of patch IDs on the primary region coupled to this region. More...
 
labelList intCoupledPatchIDs_
 List of patch IDs internally coupled with the primary region. More...
 
word regionName_
 Region name. More...
 
regionModelFunctionObjectList functions_
 Region model function objects. More...
 
wordList interRegionAMINames_
 List of region names this region is coupled to. More...
 
PtrList< PtrList< AMIPatchToPatchInterpolation > > interRegionAMI_
 List of AMI objects per coupled region. More...
 

Additional Inherited Members

- Public Types inherited from IOobject
enum  objectState : char { GOOD, BAD }
 Enumeration defining the valid states of an IOobject. More...
 
enum  readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
 Enumeration defining the read options. More...
 
enum  writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
 Enumeration defining the write options. More...
 
enum  fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Enumeration defining the file checking options. More...
 
- Public Types inherited from dictionary
typedef Searcher< true > const_searcher
 Searcher with const access. More...
 
typedef Searcher< false > searcher
 Searcher with non-const access. More...
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *p)
 
template<class Type >
static Type & store (autoPtr< Type > &aptr)
 
template<class Type >
static Type & store (autoPtr< Type > &&aptr)
 
template<class Type >
static Type & store (tmp< Type > &tptr)
 
template<class Type >
static Type & store (tmp< Type > &&tptr)
 
- 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 StringType >
static word groupName (StringType base, const word &group)
 Create dot-delimited name.group string. More...
 
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 StringType >
static word scopedName (StringType scope, const word &name)
 Create scope:name or scope_name string. More...
 
static IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &is)
 Construct top-level dictionary on freestore from Istream. More...
 
- Public Attributes inherited from dictionary
friend const_searcher
 Declare friendship with the searcher classes. More...
 
friend searcher
 
- Static Public Attributes inherited from regIOobject
static float fileModificationSkew
 
static int maxFileModificationPolls
 
- Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypesfileCheckTypesNames
 Names for the fileCheckTypes. More...
 
static char scopeSeparator
 Character for scoping object names (':' or '_') More...
 
static fileCheckTypes fileModificationChecking
 Type of file modification checking. More...
 
- Static Public Attributes inherited from dictionary
static int writeOptionalEntries
 Report optional keywords and values if not present in dictionary. More...
 
static const dictionary null
 An empty dictionary, which is also the parent for all dictionaries. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Base class for region models.

Source files

Definition at line 60 of file regionModel.H.

Constructor & Destructor Documentation

◆ regionModel() [1/3]

regionModel ( const fvMesh mesh,
const word regionType 
)

Construct null.

Definition at line 342 of file regionModel.C.

◆ regionModel() [2/3]

regionModel ( const fvMesh mesh,
const word regionType,
const word modelName,
bool  readFields = true 
)

Construct from mesh, region type and name.

Definition at line 375 of file regionModel.C.

References Foam::read(), and Foam::readFields().

Here is the call graph for this function:

◆ regionModel() [3/3]

regionModel ( const fvMesh mesh,
const word regionType,
const word modelName,
const dictionary dict,
bool  readFields = true 
)

Construct from mesh and name and dict.

Definition at line 419 of file regionModel.C.

References dict, Foam::read(), and Foam::readFields().

Here is the call graph for this function:

◆ ~regionModel()

virtual ~regionModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ read() [1/2]

bool read ( )
protectedvirtual

Read control parameters from dictionary.

Reimplemented from regIOobject.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, thermalBaffle, regionModel1D, thermalBaffleModel, singleLayerRegion, pyrolysisModel, surfaceFilmRegionModel, thermo, noPyrolysis, and noThermo.

Definition at line 149 of file regionModel.C.

References regIOobject::read().

Referenced by singleLayerRegion::read(), and regionModel1D::read().

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

◆ read() [2/2]

bool read ( const dictionary dict)
protectedvirtual

Read control parameters from dictionary.

Reimplemented in reactingOneDim, thermalBaffle, regionModel1D, pyrolysisModel, thermo, noPyrolysis, and thermalBaffleModel.

Definition at line 170 of file regionModel.C.

References dict.

◆ interRegionAMI()

const Foam::AMIPatchToPatchInterpolation & interRegionAMI ( const regionModel nbrRegion,
const label  regionPatchi,
const label  nbrPatchi,
const bool  flip 
) const
protectedvirtual

Create or return a new inter-region AMI object.

Definition at line 189 of file regionModel.C.

References polyMesh::boundaryMesh(), UPstream::msgType(), baseIOdictionary::name(), AMIInterpolation::New(), p, regionModel::regionMesh(), and PtrList< T >::resize().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "regionModel"  )

Runtime type information.

◆ primaryMesh()

const Foam::fvMesh & primaryMesh ( ) const
inline

Return the reference to the primary mesh database.

Definition at line 33 of file regionModelI.H.

References regionModel::primaryMesh_.

Referenced by noThermo::Cp(), pyrolysisModelCollection::evolve(), liquidFilmThermo::initLiquid(), thermoSingleLayer::Sh(), kinematicSingleLayer::Sh(), thermoSingleLayer::Srho(), kinematicSingleLayer::Srho(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ time()

◆ active()

Foam::Switch active ( ) const
inline

Return the active flag.

Definition at line 45 of file regionModelI.H.

Referenced by pyrolysisModelCollection::evolve(), thermo::evolveRegion(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::inject(), and thermo::preEvolveRegion().

Here is the caller graph for this function:

◆ infoOutput()

Foam::Switch infoOutput ( ) const
inline

Return the information flag.

Definition at line 51 of file regionModelI.H.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

◆ modelName()

const Foam::word & modelName ( ) const
inline

Return the model name.

Definition at line 57 of file regionModelI.H.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

◆ regionMesh() [1/2]

const Foam::fvMesh & regionMesh ( ) const
inline

Return the region mesh database.

Definition at line 63 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and objectRegistry::getObjectPtr().

Referenced by noPyrolysis::constructThermoChemistry(), patchInjection::correct(), contactAngleForce::correct(), drippingInjection::correct(), curvatureSeparation::correct(), thixotropicViscosity::correct(), waxSolventEvaporation::correctModel(), kinematicSingleLayer::CourantNumber(), curvatureSeparation::curvatureSeparation(), thermo::evolveRegion(), reactingOneDim::evolveRegion(), kinematicSingleLayer::gNorm(), kinematicSingleLayer::gNormClipped(), kinematicSingleLayer::gTan(), constantHeatTransfer::h(), injectionModelList::info(), transferModelList::info(), thermalBaffle::info(), reactingOneDim::info(), regionModel::interRegionAMI(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), laminar::mut(), regionModel::nbrCoupledPatchID(), patchInjection::patchInjection(), kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), reactingOneDim::solidRegionDiffNo(), reactingOneDim::solveContinuity(), thermalBaffle::solveEnergy(), reactingOneDim::solveSpeciesMass(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), reactingOneDim::updatePhiGas(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), kinematicSingleLayer::updateSurfaceVelocities(), and laminar::Us().

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

◆ regionMesh() [2/2]

Foam::fvMesh & regionMesh ( )
inline

Return the region mesh database for manipulation.

Definition at line 77 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and objectRegistry::getObjectPtr().

Here is the call graph for this function:

◆ coeffs()

const Foam::dictionary & coeffs ( ) const
inline

Return the model coefficients dictionary.

Definition at line 91 of file regionModelI.H.

◆ solution()

const Foam::dictionary & solution ( ) const
inline

Return the solution dictionary.

Definition at line 98 of file regionModelI.H.

Referenced by thermalBaffle::read(), kinematicSingleLayer::read(), and thermo::readControls().

Here is the caller graph for this function:

◆ outputProperties() [1/2]

const Foam::IOdictionary & outputProperties ( ) const
inline

Return const access to the output properties dictionary.

Definition at line 105 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Referenced by kinematicSingleLayer::info(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

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

◆ outputProperties() [2/2]

Foam::IOdictionary & outputProperties ( )
inline

Return output properties dictionary.

Definition at line 119 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ isCoupledPatch()

bool isCoupledPatch ( const label  regionPatchi) const
inline

Return true if patchi on the local region is a coupled.

patch to the primary region

Definition at line 133 of file regionModelI.H.

References forAll.

Referenced by contactAngleForce::correct(), temperatureDependentContactAngleForce::theta(), distributionContactAngleForce::theta(), and perturbedTemperatureDependentContactAngleForce::theta().

Here is the caller graph for this function:

◆ isRegionPatch()

bool isRegionPatch ( const label  primaryPatchi) const
inline

Return true if patchi on the primary region is a coupled.

patch to the local region

Definition at line 150 of file regionModelI.H.

References forAll.

Referenced by ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the caller graph for this function:

◆ primaryPatchIDs()

const Foam::labelList & primaryPatchIDs ( ) const
inline

Return the list of patch IDs on the primary region coupled.

to this region

Definition at line 167 of file regionModelI.H.

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::inject(), thermoSingleLayer::Sh(), and thermoSingleLayer::Srho().

Here is the caller graph for this function:

◆ intCoupledPatchIDs()

const Foam::labelList & intCoupledPatchIDs ( ) const
inline

Return the list of patch IDs internally coupled with the.

primary region

Definition at line 174 of file regionModelI.H.

Referenced by transferModelList::correct(), injectionModelList::correct(), injectionModelList::info(), transferModelList::info(), thermalBaffle::info(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::inject(), regionModel::nbrCoupledPatchID(), and thermoSingleLayer::Srho().

Here is the caller graph for this function:

◆ regionPatchID()

Foam::label regionPatchID ( const label  primaryPatchID) const
inline

Return region ID corresponding to primaryPatchID.

Definition at line 181 of file regionModelI.H.

References forAll.

◆ nbrCoupledPatchID()

Foam::label nbrCoupledPatchID ( const regionModel nbrRegion,
const label  regionPatchi 
) const

Return the coupled patch ID paired with coupled patch.

regionPatchi

Definition at line 272 of file regionModel.C.

References Foam::abort(), polyPatch::boundaryMesh(), polyMesh::boundaryMesh(), Foam::FatalError, FatalErrorInFunction, forAll, regionModel::intCoupledPatchIDs(), baseIOdictionary::name(), p, regionModel::regionMesh(), and mappedPatchBase::samplePatch().

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

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

◆ mapRegionPatchField() [1/4]

tmp<Foam::Field<Type> > mapRegionPatchField ( const regionModel nbrRegion,
const label  regionPatchi,
const label  nbrPatchi,
const Field< Type > &  nbrField,
const bool  flip = false 
) const

Map patch field from another region model to local patch.

Referenced by filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ mapRegionPatchField() [2/4]

tmp<Field<Type> > mapRegionPatchField ( const regionModel nbrRegion,
const word fieldName,
const label  regionPatchi,
const bool  flip = false 
) const

Map patch field from another region model to local patch.

◆ mapRegionPatchInternalField() [1/2]

tmp<Field<Type> > mapRegionPatchInternalField ( const regionModel nbrRegion,
const word fieldName,
const label  regionPatchi,
const bool  flip = false 
) const

Map patch internal field from another region model to local.

patch

◆ toPrimary() [1/2]

void toPrimary ( const label  regionPatchi,
List< Type > &  regionField 
) const

Convert a local region field to the primary region.

Definition at line 147 of file regionModelTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and mappedPatchBase::reverseDistribute().

Referenced by SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::cacheFilmFields(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), thermoSingleLayer::Sh(), thermoSingleLayer::Srho(), and filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

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

◆ toRegion() [1/2]

void toRegion ( const label  regionPatchi,
List< Type > &  primaryFieldField 
) const

Convert a primary region field to the local region.

Definition at line 174 of file regionModelTemplates.C.

References Foam::abort(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorInFunction, and forAll.

Here is the call graph for this function:

◆ toPrimary() [2/2]

void toPrimary ( const label  regionPatchi,
List< Type > &  regionField,
const CombineOp &  cop 
) const

Convert a local region field to the primary region with op.

Definition at line 201 of file regionModelTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, and mappedPatchBase::reverseDistribute().

Here is the call graph for this function:

◆ toRegion() [2/2]

void toRegion ( const label  regionPatchi,
List< Type > &  primaryFieldField,
const CombineOp &  cop 
) const

Convert a primary region field to the local region with op.

Definition at line 229 of file regionModelTemplates.C.

References Foam::abort(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorInFunction, and forAll.

Here is the call graph for this function:

◆ evolve()

void evolve ( )
virtual

Main driver routing to evolve the region - calls other evolves.

Reimplemented in surfaceFilmRegionModel.

Definition at line 467 of file regionModel.C.

References IOstreamOption::ASCII, Foam::decrIndent(), Foam::endl(), Foam::incrIndent(), and Foam::Info.

Referenced by surfaceFilmRegionModel::evolve().

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

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Pre-evolve region.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, thermalBaffleModel, thermalBaffle, thermo, noPyrolysis, and noThermo.

Definition at line 500 of file regionModel.C.

Referenced by pyrolysisModelCollection::evolve(), thermo::preEvolveRegion(), reactingOneDim::preEvolveRegion(), and kinematicSingleLayer::preEvolveRegion().

Here is the caller graph for this function:

◆ evolveRegion()

void evolveRegion ( )
virtual

Evolve the region.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, thermalBaffle, thermo, noPyrolysis, and noThermo.

Definition at line 506 of file regionModel.C.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve region.

Reimplemented in kinematicSingleLayer.

Definition at line 510 of file regionModel.C.

◆ info()

void info ( )
virtual

Provide some feedback.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, and thermalBaffle.

Definition at line 516 of file regionModel.C.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

◆ mapRegionPatchField() [3/4]

Foam::tmp<Foam::Field<Type> > mapRegionPatchField ( const regionModel nbrRegion,
const label  regionPatchi,
const label  nbrPatchi,
const Field< Type > &  nbrField,
const bool  flip 
) const

Definition at line 31 of file regionModelTemplates.C.

References AMIInterpolation::interpolateToSource().

Here is the call graph for this function:

◆ mapRegionPatchField() [4/4]

Foam::tmp<Foam::Field<Type> > mapRegionPatchField ( const regionModel nbrRegion,
const word fieldName,
const label  regionPatchi,
const bool  flip 
) const

Definition at line 56 of file regionModelTemplates.C.

References objectRegistry::foundObject(), AMIInterpolation::interpolateToSource(), objectRegistry::lookupObject(), Foam::New(), p, regionModel::regionMesh(), and Foam::Zero.

Here is the call graph for this function:

◆ mapRegionPatchInternalField() [2/2]

Foam::tmp<Foam::Field<Type> > mapRegionPatchInternalField ( const regionModel nbrRegion,
const word fieldName,
const label  regionPatchi,
const bool  flip 
) const

Definition at line 100 of file regionModelTemplates.C.

References objectRegistry::foundObject(), AMIInterpolation::interpolateToSource(), objectRegistry::lookupObject(), Foam::New(), p, regionModel::regionMesh(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ primaryMesh_

const fvMesh& primaryMesh_
protected

Reference to the primary mesh database.

Definition at line 87 of file regionModel.H.

Referenced by regionModel::primaryMesh().

◆ time_

◆ active_

Switch active_
protected

Active flag.

Definition at line 93 of file regionModel.H.

◆ infoOutput_

Switch infoOutput_
protected

Active information output.

Definition at line 96 of file regionModel.H.

Referenced by reactingOneDim::calculateMassTransfer().

◆ modelName_

const word modelName_
protected

Model name.

Definition at line 99 of file regionModel.H.

◆ coeffs_

dictionary coeffs_
protected

Model coefficients dictionary.

Definition at line 102 of file regionModel.H.

◆ outputPropertiesPtr_

autoPtr<IOdictionary> outputPropertiesPtr_
protected

Dictionary of output properties.

Definition at line 105 of file regionModel.H.

◆ primaryPatchIDs_

labelList primaryPatchIDs_
protected

List of patch IDs on the primary region coupled to this region.

Definition at line 111 of file regionModel.H.

Referenced by reactingOneDim::addMassSources().

◆ intCoupledPatchIDs_

◆ regionName_

word regionName_
protected

Region name.

Definition at line 118 of file regionModel.H.

◆ functions_

regionModelFunctionObjectList functions_
protected

Region model function objects.

Definition at line 121 of file regionModel.H.

◆ interRegionAMINames_

wordList interRegionAMINames_
mutableprotected

List of region names this region is coupled to.

Definition at line 127 of file regionModel.H.

◆ interRegionAMI_

PtrList<PtrList<AMIPatchToPatchInterpolation> > interRegionAMI_
mutableprotected

List of AMI objects per coupled region.

Definition at line 131 of file regionModel.H.


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