Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
regionModel Class Reference
Inheritance diagram for regionModel:
Inheritance graph
[legend]
Collaboration diagram for regionModel:
Collaboration graph
[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 ()
 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...
 
const Switchactive () const
 Return the active flag. More...
 
const SwitchinfoOutput () 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
 TypeName ("dictionary")
 
 IOdictionary (const IOobject &)
 Construct given an IOobject. More...
 
 IOdictionary (const IOobject &, const dictionary &)
 Construct given an IOobject and dictionary. More...
 
 IOdictionary (const IOobject &, Istream &)
 Construct given an IOobject and Istream. More...
 
virtual ~IOdictionary ()
 Destructor. More...
 
const wordname () const
 Name function is needed to disambiguate those inherited. More...
 
bool readData (Istream &)
 ReadData function required for regIOobject read operation. More...
 
bool writeData (Ostream &) const
 WriteData function required for regIOobject write operation. More...
 
void operator= (const IOdictionary &)
 Assignment of other IOdictionary's entries to this IOdictionary. More...
 
- Public Member Functions inherited from regIOobject
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &, const bool isTime=false)
 Construct from IOobject. Optional flag for if IOobject is the. More...
 
 regIOobject (const regIOobject &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from registry. More...
 
bool ownedByRegistry () const
 Is this object owned by the registry? More...
 
void store ()
 Transfer ownership of this object to its registry. More...
 
void release ()
 Release ownership of this object from its registry. More...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 Event number at last update. More...
 
bool upToDate (const regIOobject &) const
 Return true if up-to-date with respect to given object. More...
 
bool upToDate (const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
bool upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
 Return true if up-to-date with respect to given objects. More...
 
void setUpToDate ()
 Set up to date (obviously) More...
 
virtual void rename (const word &newName)
 Rename. More...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. More...
 
virtual bool modified () const
 Return true if the object's file (or files for objectRegistry) More...
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. More...
 
void operator= (const IOobject &)
 
- Public Member Functions inherited from IOobject
 TypeName ("IOobject")
 Runtime type information. More...
 
 IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () const
 Return the optional note. More...
 
bool & registerObject ()
 Register object created from this IOobject with registry if true. More...
 
bool registerObject () const
 Register object created from this IOobject with registry if true. More...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () const
 
fileName path () const
 Return complete path. More...
 
fileName path (const word &instance, const fileName &local="") const
 Return complete path with alternative instance and local. More...
 
fileName objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. More...
 
bool writeHeader (Ostream &) const
 Write header. More...
 
bool writeHeader (Ostream &, const word &objectType) const
 Write header. Allow override of type. More...
 
bool good () const
 
bool bad () const
 
InfoProxy< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from dictionary
 ClassName ("dictionary")
 
 dictionary ()
 Construct top-level dictionary null. More...
 
 dictionary (const fileName &name)
 Construct top-level empty dictionary with given name. More...
 
 dictionary (const fileName &name, const dictionary &parentDict, Istream &)
 Construct given the entry name, parent dictionary and Istream,. More...
 
 dictionary (Istream &)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (Istream &, const bool keepHeader)
 Construct top-level dictionary from Istream,. More...
 
 dictionary (const dictionary &parentDict, const dictionary &)
 Construct as copy given the parent dictionary. More...
 
 dictionary (const dictionary &)
 Construct top-level dictionary as copy. More...
 
 dictionary (const dictionary *)
 Construct top-level dictionary as copy from pointer to dictionary. More...
 
 dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
 Construct by transferring parameter contents given parent dictionary. More...
 
 dictionary (const Xfer< dictionary > &)
 Construct top-level dictionary by transferring parameter contents. More...
 
autoPtr< dictionaryclone () const
 Construct and return clone. More...
 
virtual ~dictionary ()
 Destructor. 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 &, bool recursive=false, bool patternMatch=true) const
 Search dictionary for given keyword. More...
 
const entrylookupEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
entrylookupEntryPtr (const word &, bool recursive, bool patternMatch)
 Find and return an entry data stream pointer for manipulation. More...
 
const entrylookupEntry (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream if present otherwise error. More...
 
ITstreamlookup (const word &, bool recursive=false, bool patternMatch=true) const
 Find and return an entry data stream. More...
 
template<class T >
T lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
 Find and return a T,. More...
 
template<class T >
T lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
 Find and return a T, if not found return the given. More...
 
template<class T >
bool readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
 Find an entry if present, and assign to T. More...
 
const entrylookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
 Find and return an entry data stream pointer if present. More...
 
bool isDict (const word &) const
 Check if entry is a sub-dictionary. More...
 
const dictionarysubDictPtr (const word &) const
 Find and return a sub-dictionary pointer if present. More...
 
const dictionarysubDict (const word &) const
 Find and return a sub-dictionary. More...
 
dictionarysubDict (const word &)
 Find and return a sub-dictionary for manipulation. More...
 
dictionary subOrEmptyDict (const word &, const bool mustRead=false) const
 Find and return a sub-dictionary as a copy, or. More...
 
wordList toc () const
 Return the table of contents. More...
 
List< keyTypekeys (bool patterns=false) const
 Return the list of available keys or patterns. More...
 
bool substituteKeyword (const word &keyword)
 Substitute the given keyword prepended by '$' with the. More...
 
bool substituteScopedKeyword (const word &keyword)
 Substitute the given scoped keyword prepended by '$' with the. More...
 
bool add (entry *, bool mergeEntry=false)
 Add a new entry. More...
 
void add (const entry &, bool mergeEntry=false)
 Add an entry. More...
 
void add (const keyType &, const word &, bool overwrite=false)
 Add a word entry. More...
 
void add (const keyType &, const string &, bool overwrite=false)
 Add a string entry. More...
 
void add (const keyType &, const label, bool overwrite=false)
 Add a label entry. More...
 
void add (const keyType &, const scalar, bool overwrite=false)
 Add a scalar entry. More...
 
void add (const keyType &, const dictionary &, bool mergeEntry=false)
 Add a dictionary entry. More...
 
template<class T >
void add (const keyType &, const T &, bool overwrite=false)
 Add a T entry. More...
 
void set (entry *)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const entry &)
 Assign a new entry, overwrite any existing entry. More...
 
void set (const keyType &, const dictionary &)
 Assign a dictionary entry, overwrite any existing entry. More...
 
template<class T >
void set (const keyType &, const T &)
 Assign a T entry, overwrite any existing entry. More...
 
bool remove (const word &)
 Remove an entry specified by keyword. More...
 
bool changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
 Change the keyword for an entry,. More...
 
bool merge (const dictionary &)
 Merge entries from the given dictionary. More...
 
void clear ()
 Clear the dictionary. More...
 
void transfer (dictionary &)
 Transfer the contents of the argument and annul the argument. More...
 
Xfer< dictionaryxfer ()
 Transfer contents to the Xfer container. More...
 
bool read (Istream &)
 Read dictionary from Istream. More...
 
bool read (Istream &, const bool keepHeader)
 Read dictionary from Istream, optionally keeping the header. More...
 
void write (Ostream &, const bool subDict=true) const
 Write dictionary, normally with sub-dictionary formatting. More...
 
ITstreamoperator[] (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...
 
- Public Member Functions inherited from dictionaryName
 dictionaryName ()
 Construct dictionaryName null. More...
 
 dictionaryName (const fileName &name)
 Construct dictionaryName as copy of the given fileName. More...
 
const fileNamename () const
 Return the dictionary name. More...
 
fileNamename ()
 Return the dictionary name. More...
 
const word dictName () const
 Return the local dictionary name (final part of scoped name) More...
 
- Public Member Functions inherited from IDLList< entry >
 IDLList ()
 Null construct. More...
 
 IDLList (const entry &a)
 Construct given initial T. More...
 
 IDLList (Istream &is, const INew &inewt)
 Construct from Istream using given Istream constructor class. More...
 
 IDLList (Istream &is)
 Construct from Istream. More...
 
 IDLList (const IDLList< entry > &idll, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
- Public Member Functions inherited from ILList< DLListBase, entry >
 ILList ()
 Null construct. More...
 
 ILList (entry *a)
 Construct given initial T. More...
 
 ILList (Istream &)
 Construct from Istream. More...
 
 ILList (const ILList< DLListBase, entry > &)
 Construct as copy. More...
 
 ILList (const ILList< DLListBase, entry > &lst, const CloneArg &cloneArg)
 Copy constructor with additional argument for clone. More...
 
 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 (entry *p)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< DLListBase, entry > &)
 Transfer the contents of the argument into this List. More...
 
void operator= (const ILList< DLListBase, entry > &)
 
- Public Member Functions inherited from UILList< DLListBase, entry >
 UILList ()
 Null construct. More...
 
 UILList (entry *a)
 Construct given initial T. More...
 
 UILList (const UILList< DLListBase, entry > &)
 Construct as copy. More...
 
entryfirst ()
 Return the first entry. More...
 
const entryfirst () const
 Return the first entry. More...
 
entrylast ()
 Return the last entry. More...
 
const entrylast () const
 Return the last entry. More...
 
entryremoveHead ()
 Remove and return head. More...
 
entryremove (entry *p)
 Remove and return element. More...
 
entryremove (iterator &it)
 Remove and return specified by iterator. More...
 
void operator= (const UILList< DLListBase, entry > &)
 
iterator begin ()
 
const_iterator begin () const
 
const iteratorend ()
 
const const_iteratorend () const
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 
bool operator== (const UILList< DLListBase, entry > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UILList< DLListBase, entry > &) const
 The opposite of the equality operation. Takes linear time. More...
 
- Public Member Functions inherited from DLListBase
 DLListBase ()
 Null construct. More...
 
 DLListBase (link *)
 Construct given initial entry. More...
 
 ~DLListBase ()
 Destructor. More...
 
label size () const
 Return number of elements in list. More...
 
bool empty () const
 Return true if the list is empty. More...
 
linkfirst ()
 Return first entry. More...
 
const linkfirst () const
 Return const access to first entry. More...
 
linklast ()
 Return last entry. More...
 
const linklast () const
 Return const access to last entry. More...
 
void insert (link *)
 Add at head of list. More...
 
void append (link *)
 Add at tail of list. More...
 
bool swapUp (link *)
 Swap this element with the one above unless it is at the top. More...
 
bool swapDown (link *)
 Swap this element with the one below unless it is at the bottom. More...
 
linkremoveHead ()
 Remove and return head. More...
 
linkremove (link *)
 Remove and return element. More...
 
linkremove (iterator &)
 
linkreplace (link *oldLink, link *newLink)
 Replace oldLink with newLink and return element. More...
 
linkreplace (iterator &oldIter, link *newLink)
 Replace oldIter with newLink and return element. More...
 
void clear ()
 Clear the list. More...
 
void transfer (DLListBase &)
 Transfer the contents of the argument into this List. More...
 
iterator begin ()
 
const iteratorend ()
 
const_iterator cbegin () const
 
const const_iteratorcend () const
 
const_iterator begin () const
 
const const_iteratorend () const
 
const_reverse_iterator crbegin () const
 
const const_reverse_iteratorcrend () const
 
const_reverse_iterator rbegin () const
 
const const_reverse_iteratorrend () const
 

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 IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 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...
 
autoPtr< fvMeshregionMeshPtr_
 Pointer to the region mesh database. 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 regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- 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...
 
- Public Types inherited from UILList< DLListBase, entry >
typedef entry value_type
 Type of values the DLList contains. More...
 
typedef entryreference
 Type that can be used for storing into DLList::value_type. More...
 
typedef const entryconst_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 DLListBase::iterator LListBase_iterator
 
typedef DLListBase::const_iterator LListBase_const_iterator
 
- Static Public Member Functions inherited from regIOobject
template<class Type >
static Type & store (Type *)
 Transfer ownership of the given object pointer to its registry. More...
 
template<class Type >
static Type & store (autoPtr< Type > &)
 Transfer ownership of the given object pointer to its registry. More...
 
- Static Public Member Functions inherited from IOobject
static bool fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
 Split path into instance, local, name components. More...
 
template<class Name >
static word groupName (Name name, const word &group)
 
template<class Stream >
static Stream & writeBanner (Stream &os, bool noHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
template<class Stream >
static Stream & writeDivider (Stream &os)
 Write the standard file section divider. More...
 
template<class Stream >
static Stream & writeEndDivider (Stream &os)
 Write the standard end file divider. More...
 
- Static Public Member Functions inherited from dictionary
static autoPtr< dictionaryNew (Istream &)
 Construct top-level dictionary on freestore from Istream. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from dictionary
static const dictionary null
 Null dictionary. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Definition at line 57 of file regionModel.H.

Constructor & Destructor Documentation

regionModel ( const fvMesh mesh,
const word regionType 
)

Construct null.

Definition at line 394 of file regionModel.C.

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

Construct from mesh, region type and name.

Definition at line 428 of file regionModel.C.

References Foam::read().

Here is the call graph for this function:

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 473 of file regionModel.C.

References Foam::read().

Here is the call graph for this function:

~regionModel ( )
virtual

Destructor.

Definition at line 522 of file regionModel.C.

Member Function Documentation

bool read ( )
protectedvirtual

Read control parameters from dictionary.

Reimplemented from regIOobject.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, thermalBaffle, regionModel1D, thermalBaffleModel, singleLayerRegion, surfaceFilmModel, pyrolysisModel, noPyrolysis, noThermo, and noFilm.

Definition at line 171 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:

bool read ( const dictionary dict)
protectedvirtual

Read control parameters from dictionary.

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

Definition at line 194 of file regionModel.C.

References regionModel::interRegionAMI(), and dictionary::subDictPtr().

Here is the call graph for this function:

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 216 of file regionModel.C.

References polyPatch::boundaryMesh(), Foam::findIndex(), AMIInterpolation< SourcePatch, TargetPatch >::imFaceAreaWeight, UPstream::msgType(), IOdictionary::name(), regionModel::nbrCoupledPatchID(), p, regionModel::regionMesh(), PtrList< T >::size(), and faceAreaIntersect::tmMesh.

Referenced by regionModel::read().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "regionModel"  )

Runtime type information.

const Foam::fvMesh & primaryMesh ( ) const
inline
const Foam::Time & time ( ) const
inline
const Foam::Switch & active ( ) const
inline

Return the active flag.

Definition at line 43 of file regionModelI.H.

References regionModel::active_.

Referenced by pyrolysisModelCollection::evolve(), SurfaceFilmModel< CloudType >::inject(), and noPyrolysis::noPyrolysis().

Here is the caller graph for this function:

const Foam::Switch & infoOutput ( ) const
inline

Return the information flag.

Definition at line 49 of file regionModelI.H.

References regionModel::infoOutput_.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

const Foam::word & modelName ( ) const
inline

Return the model name.

Definition at line 55 of file regionModelI.H.

References regionModel::modelName_.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

const Foam::fvMesh & regionMesh ( ) const
inline

Return the region mesh database.

Definition at line 61 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, objectRegistry::foundObject(), objectRegistry::lookupObject(), regionModel::regionMeshPtr_, regionModel::regionName_, and regionModel::time_.

Referenced by noPyrolysis::constructThermoChemistry(), patchInjection::correct(), contactAngleForce::correct(), drippingInjection::correct(), curvatureSeparation::correct(), thixotropicViscosity::correct(), solidification::correctModel(), kinematicSingleLayer::CourantNumber(), curvatureSeparation::curvatureSeparation(), reactingOneDim::evolveRegion(), kinematicSingleLayer::gNorm(), kinematicSingleLayer::gNormClipped(), kinematicSingleLayer::gTan(), constantHeatTransfer::h(), thermoSingleLayer::hs(), injectionModelList::info(), thermalBaffle::info(), reactingOneDim::info(), regionModel::interRegionAMI(), kinematicSingleLayer::kinematicSingleLayer(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), singleLayerRegion::mappedPushedFieldPatchTypes(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), laminar::mut(), regionModel::nbrCoupledPatchID(), patchInjection::patchInjection(), kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), thermalBaffleModel::read(), reactingOneDim::solidRegionDiffNo(), regionModel::solution(), reactingOneDim::solveContinuity(), thermalBaffle::solveEnergy(), reactingOneDim::solveEnergy(), kinematicSingleLayer::solveMomentum(), reactingOneDim::solveSpeciesMass(), kinematicSingleLayer::solveThickness(), thermoSingleLayer::T(), thermoSingleLayer::thermoSingleLayer(), reactingOneDim::updateMesh(), 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:

Foam::fvMesh & regionMesh ( )
inline

Return the region mesh database for manipulation.

Definition at line 80 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, objectRegistry::foundObject(), objectRegistry::lookupObject(), regionModel::regionMeshPtr_, regionModel::regionName_, and regionModel::time_.

Here is the call graph for this function:

const Foam::dictionary & coeffs ( ) const
inline

Return the model coefficients dictionary.

Definition at line 102 of file regionModelI.H.

References regionModel::coeffs_.

Referenced by thermoSingleLayer::thermoSingleLayer().

Here is the caller graph for this function:

const Foam::dictionary & solution ( ) const
inline

Return the solution dictionary.

Definition at line 109 of file regionModelI.H.

References regionModel::regionMesh(), and solution::solutionDict().

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

Here is the call graph for this function:

Here is the caller graph for this function:

const Foam::IOdictionary & outputProperties ( ) const
inline

Return const access to the output properties dictionary.

Definition at line 116 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, and regionModel::outputPropertiesPtr_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::IOdictionary & outputProperties ( )
inline

Return output properties dictionary.

Definition at line 134 of file regionModelI.H.

References Foam::abort(), Foam::FatalError, FatalErrorIn, regionModel::isCoupledPatch(), and regionModel::outputPropertiesPtr_.

Here is the call graph for this function:

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 152 of file regionModelI.H.

References forAll, regionModel::intCoupledPatchIDs_, and regionModel::isRegionPatch().

Referenced by contactAngleForce::correct(), and regionModel::outputProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

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 169 of file regionModelI.H.

References forAll, and regionModel::primaryPatchIDs_.

Referenced by regionModel::isCoupledPatch(), and ThermoSurfaceFilm< CloudType >::transferParcel().

Here is the caller graph for this function:

const Foam::labelList & primaryPatchIDs ( ) const
inline

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

to this region

Definition at line 186 of file regionModelI.H.

References regionModel::primaryPatchIDs_.

Referenced by SurfaceFilmModel< CloudType >::inject(), and thermoSingleLayer::Srho().

Here is the caller graph for this function:

const Foam::labelList & intCoupledPatchIDs ( ) const
inline

Return the list of patch IDs internally coupled with the.

primary region

Definition at line 193 of file regionModelI.H.

References regionModel::intCoupledPatchIDs_, and regionModel::regionPatchID().

Referenced by injectionModelList::correct(), injectionModelList::info(), thermalBaffle::info(), SurfaceFilmModel< CloudType >::inject(), regionModel::nbrCoupledPatchID(), and thermoSingleLayer::Srho().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Return region ID corresponding to primaryPatchID.

Definition at line 200 of file regionModelI.H.

References forAll, regionModel::intCoupledPatchIDs_, and regionModel::primaryPatchIDs_.

Referenced by regionModel::intCoupledPatchIDs().

Here is the caller graph for this function:

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

Return the coupled patch ID paired with coupled patch.

regionPatchI

Definition at line 303 of file regionModel.C.

References Foam::abort(), polyPatch::boundaryMesh(), polyMesh::boundaryMesh(), Foam::FatalError, FatalErrorIn, forAll, regionModel::intCoupledPatchIDs(), IOdictionary::name(), patchIdentifier::name(), p, regionModel::regionMesh(), mappedPatchBase::samplePatch(), and PtrList< T >::size().

Referenced by regionModel::interRegionAMI(), and filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

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 regionModel::mapRegionPatchField(), and filmPyrolysisRadiativeCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

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.

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

Referenced by regionModel::mapRegionPatchField().

Here is the caller graph for this function:

void toPrimary ( const label  regionPatchI,
List< Type > &  regionField 
) const
void toRegion ( const label  regionPatchI,
List< Type > &  primaryFieldField 
) const

Convert a primary region field to the local region.

Definition at line 188 of file regionModelTemplates.C.

References Foam::abort(), mappedPatchBase::distribute(), Foam::FatalError, FatalErrorIn, forAll, and regionModel::toPrimary().

Referenced by regionModel::toPrimary().

Here is the call graph for this function:

Here is the caller graph for this function:

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 215 of file regionModelTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorIn, forAll, mappedPatchBase::reverseDistribute(), and regionModel::toRegion().

Here is the call graph for this function:

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 250 of file regionModelTemplates.C.

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

Here is the call graph for this function:

void evolve ( )
virtual

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

Definition at line 528 of file regionModel.C.

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

Here is the call graph for this function:

void preEvolveRegion ( )
virtual

Pre-evolve region.

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

Definition at line 564 of file regionModel.C.

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

Here is the caller graph for this function:

void evolveRegion ( )
virtual

Evolve the region.

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

Definition at line 570 of file regionModel.C.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

void postEvolveRegion ( )
virtual

Post-evolve region.

Definition at line 576 of file regionModel.C.

void info ( )
virtual

Provide some feedback.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, reactingOneDim, and thermalBaffle.

Definition at line 582 of file regionModel.C.

Referenced by pyrolysisModelCollection::evolve().

Here is the caller graph for this function:

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 29 of file regionModelTemplates.C.

References AMIInterpolation< SourcePatch, TargetPatch >::interpolateToSource(), and regionModel::mapRegionPatchField().

Here is the call graph for this function:

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

Member Data Documentation

const fvMesh& primaryMesh_
protected

Reference to the primary mesh database.

Definition at line 87 of file regionModel.H.

Referenced by regionModel::primaryMesh().

const Time& time_
protected
Switch active_
protected
Switch infoOutput_
protected

Active information output.

Definition at line 96 of file regionModel.H.

Referenced by reactingOneDim::calculateMassTransfer(), and regionModel::infoOutput().

const word modelName_
protected

Model name.

Definition at line 99 of file regionModel.H.

Referenced by regionModel::modelName().

autoPtr<fvMesh> regionMeshPtr_
protected

Pointer to the region mesh database.

Definition at line 102 of file regionModel.H.

Referenced by regionModel::regionMesh().

dictionary coeffs_
protected

Model coefficients dictionary.

Definition at line 105 of file regionModel.H.

Referenced by regionModel::coeffs(), and thermoSingleLayer::thermoSingleLayer().

autoPtr<IOdictionary> outputPropertiesPtr_
protected

Dictionary of output properties.

Definition at line 108 of file regionModel.H.

Referenced by regionModel::outputProperties().

labelList primaryPatchIDs_
protected

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

Definition at line 114 of file regionModel.H.

Referenced by reactingOneDim::addMassSources(), regionModel::isRegionPatch(), regionModel::primaryPatchIDs(), and regionModel::regionPatchID().

labelList intCoupledPatchIDs_
protected
word regionName_
protected

Region name.

Definition at line 121 of file regionModel.H.

Referenced by regionModel::regionMesh().

regionModelFunctionObjectList functions_
protected

Region model function objects.

Definition at line 124 of file regionModel.H.

wordList interRegionAMINames_
mutableprotected

List of region names this region is coupled to.

Definition at line 130 of file regionModel.H.

PtrList<PtrList<AMIPatchToPatchInterpolation> > interRegionAMI_
mutableprotected

List of AMI objects per coupled region.

Definition at line 134 of file regionModel.H.


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