Base class for region models. More...

Inheritance diagram for regionModel:

Collaboration diagram for regionModel:

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 fvMesh &	primaryMesh () const
	Return the reference to the primary mesh database. More...

const Time &	time () 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 word &	modelName () const
	Return the model name. More...

const fvMesh &	regionMesh () const
	Return the region mesh database. More...

fvMesh &	regionMesh ()
	Return the region mesh database for manipulation. More...

const dictionary &	coeffs () const
	Return the model coefficients dictionary. More...

const dictionary &	solution () const
	Return the solution dictionary. More...

const IOdictionary &	outputProperties () const
	Return const access to the output properties dictionary. More...

IOdictionary &	outputProperties ()
	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 labelList &	primaryPatchIDs () const
	Return the list of patch IDs on the primary region coupled. More...

const labelList &	intCoupledPatchIDs () 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 &io, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, const dictionary &dict)

	IOdictionary (const IOobject &io, const word &wantedType, const dictionary *fallback=nullptr)

	IOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream. More...

virtual	~IOdictionary ()=default
	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 &io, const dictionary *fallback=nullptr)

	baseIOdictionary (const IOobject &io, const dictionary &dict)

	baseIOdictionary (const IOobject &io, Istream &is)
	Construct given an IOobject and Istream (ununsed) More...

const word &	name () 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 &rhs)
	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 isTimeObject=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...

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	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 (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::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, bool globalObject=false)
	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...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return name. More...

const word &	headerClassName () const noexcept
	Return name of the class name read from header. More...

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

const string &	note () const noexcept
	Return the optional note. More...

string &	note () noexcept
	Return non-constant access to the optional note. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, 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 noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

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	objectRelPath () const
	The object path relative to the root. 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...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

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 with current type() More...

bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type. More...

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

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)

Public Member Functions inherited from dictionary
	ClassName ("dictionary")

	dictionary ()
	Default construct, a top-level empty dictionary. 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< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

const fileName &	name () const noexcept
	The dictionary name. More...

fileName &	name () noexcept
	The dictionary name for modification (use with caution). More...

word	dictName () const
	The local dictionary name (final part of scoped name) More...

fileName	relativeName (const bool caseTag=false) const
	The dictionary name relative to the case. More...

bool	isNullDict () const noexcept
	The dictionary is actually dictionary::null (root dictionary) More...

const dictionary &	parent () const noexcept
	Return the parent dictionary. More...

const dictionary &	topDict () const
	Return the top of the tree. More...

label	startLineNumber () const
	Return line number of first token in dictionary. More...

label	endLineNumber () const
	Return line number of last token in dictionary. More...

SHA1Digest	digest () const
	Return the SHA1 digest of the dictionary contents. More...

tokenList	tokens () const
	Return the dictionary as a list of tokens. More...

bool	found (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for an entry (const access) with the given keyword. More...

entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find for an entry (non-const access) with the given keyword. More...

const entry *	findEntry (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find an entry (const access) with the given keyword. More...

const entry *	findScoped (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Search for a scoped entry (const access) with the given keyword. More...

dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary pointer if present. More...

const dictionary *	findDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary pointer if present. More...

const entry &	lookupEntry (const word &keyword, enum keyType::option matchOpt) const
	Search for an entry (const access) with the given keyword. More...

ITstream &	lookup (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 dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &keyword, enum keyType::option matchOpt=keyType::REGEX)
	Find and return a sub-dictionary for manipulation. More...

dictionary &	subDictOrAdd (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 dictionary &	optionalSubDict (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< keyType >	keys (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...

entry *	add (entry *entryPtr, bool mergeEntry=false)
	Add a new entry. More...

entry *	add (const entry &e, bool mergeEntry=false)
	Add an entry. More...

entry *	add (const keyType &k, const word &v, bool overwrite=false)
	Add a word entry. More...

entry *	add (const keyType &k, const string &v, bool overwrite=false)
	Add a string entry. More...

entry *	add (const keyType &k, const label v, bool overwrite=false)
	Add a label entry. More...

entry *	add (const keyType &k, const scalar v, bool overwrite=false)
	Add a scalar entry. More...

entry *	add (const keyType &k, const dictionary &d, bool mergeEntry=false)
	Add a dictionary entry. More...

template<class T >
entry *	add (const keyType &k, const T &v, bool overwrite=false)
	Add a T entry. More...

entry *	set (entry *entryPtr)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const entry &e)
	Assign a new entry, overwriting any existing entry. More...

entry *	set (const keyType &k, const dictionary &v)
	Assign a dictionary entry, overwriting any existing entry. More...

template<class T >
entry *	set (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. Discards the header. 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 dictionary *	cfindScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

const dictionary *	findScopedDict (const fileName &dictPath) const
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	findScopedDict (const fileName &dictPath)
	Locate a sub-dictionary using slash-scoping. More...

dictionary *	makeScopedDict (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 entry *	findCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

const entry &	lookupEntryCompat (const word &keyword, std::initializer_list< std::pair< const char *, int >> compat, enum keyType::option) const

ITstream &	lookupCompat (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

ITstream &	operator[] (const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

bool	found (const word &keyword, bool recursive, bool patternMatch=true) const
	Deprecated(2018-10) More...

entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch)
	Deprecated(2018-10) More...

const entry *	lookupEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const entry *	lookupScopedEntryPtr (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

const dictionary *	subDictPtr (const word &keyword) const
	Deprecated(2018-10) More...

dictionary *	subDictPtr (const word &keyword)

const entry &	lookupEntry (const word &keyword, bool recursive, bool patternMatch) const
	Deprecated(2018-10) More...

ITstream &	lookup (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...

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	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::entry *	add (const keyType &k, const T &v, bool overwrite)

template<class T >
Foam::entry *	set (const keyType &k, const T &v)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()=default
	Default 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 AMIPatchToPatchInterpolation &	interRegionAMI (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 IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad. More...

Protected Attributes
const fvMesh &	primaryMesh_
	Reference to the primary mesh database. More...

const Time &	time_
	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< IOdictionary >	outputPropertiesPtr_
	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)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable an output file banner. More...

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...

static word	scopedName (const std::string &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 Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static int	reportOptional () noexcept
	Return the state of reporting optional (default) entries. More...

static int	reportOptional (const int level) noexcept
	Change the state of reporting optional (default) entries. More...

static autoPtr< dictionary >	New (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 IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	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 float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. 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 refPtr< OSstream >	reportingOutput
	Output location when reporting default values. More...

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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(), PtrList< T >::resize(), and Foam::BitOps::set().

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 34 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()

const Foam::Time & time ( ) const

inline

Return the reference to the time database.

Definition at line 40 of file regionModelI.H.

Here is the caller graph for this function:

◆ active()

Foam::Switch active ( ) const

inline

Return the active flag.

Definition at line 46 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 52 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 58 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 64 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(), transferModelList::info(), injectionModelList::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 78 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 92 of file regionModelI.H.

◆ solution()

const Foam::dictionary & solution ( ) const

inline

Return the solution dictionary.

Definition at line 99 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 106 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 120 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 134 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 151 of file regionModelI.H.

References forAll.

◆ primaryPatchIDs()

const Foam::labelList & primaryPatchIDs ( ) const

inline

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

to this region

Definition at line 168 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 175 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 182 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 ThermoSurfaceFilm< CloudType >::cacheFilmFields(), SurfaceFilmModel< Foam::KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::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_

const Time& time_

protected

Reference to the time database.

Definition at line 90 of file regionModel.H.

Referenced by reactingOneDim::calculateMassTransfer(), kinematicSingleLayer::CourantNumber(), kinematicSingleLayer::pp(), kinematicSingleLayer::pu(), thermoSingleLayer::Sh(), reactingOneDim::solveContinuity(), thermoSingleLayer::Srho(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().

◆ 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_

labelList intCoupledPatchIDs_

protected

List of patch IDs internally coupled with the primary region.

Definition at line 114 of file regionModel.H.

Referenced by reactingOneDim::addMassSources(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), thermoSingleLayer::Sh(), thermalBaffle::solveEnergy(), reactingOneDim::updatePhiGas(), reactingOneDim::updateqr(), thermoSingleLayer::updateSurfaceTemperatures(), and kinematicSingleLayer::updateSurfaceVelocities().

◆ 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:

src/regionModels/regionModel/regionModel/regionModel.H
src/regionModels/regionModel/regionModel/regionModel.C
src/regionModels/regionModel/regionModel/regionModelI.H
src/regionModels/regionModel/regionModel/regionModelTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ regionModel() [1/3]

◆ regionModel() [2/3]

◆ regionModel() [3/3]

◆ ~regionModel()

Member Function Documentation

◆ read() [1/2]

◆ read() [2/2]

◆ interRegionAMI()

◆ TypeName()

◆ primaryMesh()

◆ time()

◆ active()

◆ infoOutput()

◆ modelName()

◆ regionMesh() [1/2]

◆ regionMesh() [2/2]

◆ coeffs()

◆ solution()

◆ outputProperties() [1/2]

◆ outputProperties() [2/2]

◆ isCoupledPatch()

◆ isRegionPatch()

◆ primaryPatchIDs()

◆ intCoupledPatchIDs()

◆ regionPatchID()

◆ nbrCoupledPatchID()

◆ mapRegionPatchField() [1/4]

◆ mapRegionPatchField() [2/4]

◆ mapRegionPatchInternalField() [1/2]

◆ toPrimary() [1/2]

◆ toRegion() [1/2]

◆ toPrimary() [2/2]

◆ toRegion() [2/2]

◆ evolve()

◆ preEvolveRegion()

◆ evolveRegion()

◆ postEvolveRegion()

◆ info()

◆ mapRegionPatchField() [3/4]

◆ mapRegionPatchField() [4/4]

◆ mapRegionPatchInternalField() [2/2]

Member Data Documentation

◆ primaryMesh_

◆ time_

◆ active_

◆ infoOutput_

◆ modelName_

◆ coeffs_

◆ outputPropertiesPtr_

◆ primaryPatchIDs_

◆ intCoupledPatchIDs_

◆ regionName_

◆ functions_

◆ interRegionAMINames_

◆ interRegionAMI_