Base class for region models. More...

Inheritance diagram for regionModel:

Collaboration diagram for regionModel:

[legend]

Public Member Functions
	TypeName ("regionModel")
	Runtime type information. More...

	regionModel (const fvMesh &mesh, const word &regionType)
	Construct null. More...

	regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, bool readFields=true)
	Construct from mesh, region type and name. More...

	regionModel (const fvMesh &mesh, const word &regionType, const word &modelName, const dictionary &dict, bool readFields=true)
	Construct from mesh and name and dict. More...

virtual	~regionModel ()
	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...

const 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 , 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 >
void	toRegion (const label regionPatchi, List< Type > &primaryFieldField) const
	Convert a primary region field to the local region. More...

template<class Type >
void	toRegion (Field< Type > &regionField, const label regionPatchi, const fvPatchField< Type > &primaryPatchField) const
	Return a primary patch field mapped the region internal field. More...

template<class Type >
void	toRegion (Field< Type > &rf, const typename GeometricField< Type, fvPatchField, volMesh >::Boundary &pBf) const
	Return a primary patch field mapped the local region. 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...

	IOdictionary (const IOdictionary &)
	Copy constructor. More...

	IOdictionary (IOdictionary &&)
	Move constructor. More...

virtual	~IOdictionary ()
	Destructor. More...

virtual bool	global () const
	Is object global. More...

virtual fileName	filePath () const
	Return complete path + object name if the file exists. More...

virtual bool	readData (Istream &)
	ReadData function required for regIOobject read operation. More...

virtual bool	writeData (Ostream &) const
	WriteData function required for regIOobject write operation. More...

void	operator= (const IOdictionary &)
	Assignment of dictionary entries only. More...

void	operator= (IOdictionary &&)
	Move assignment of dictionary entries only. 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 &)
	Copy constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

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

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

void	close ()
	Close Istream. More...

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

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

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &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...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

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

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

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

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

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

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

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

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

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

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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

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

word	modelName (const char *name) const
	Return the name of the object within this model. More...

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () 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	localPath () const
	Return the path relative to the case. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	localObjectPath () const
	Return complete localPath + object name. More...

fileName	localFilePath (const word &typeName) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName) const
	Helper for filePath that searches up if in parallel. More...

bool	readHeader (Istream &)
	Read header. More...

template<class Type >
bool	typeHeaderOk (const bool checkType=true)
	Read header (uses typeFilePath to find file) and check header. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

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

bool	good () const

bool	bad () const

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

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

template<class Name >
Foam::word	modelName (Name name, const word &model)

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

	dictionary ()
	Construct top-level dictionary null. More...

	dictionary (const fileName &name)
	Construct top-level empty dictionary with given name. More...

	dictionary (const fileName &name, const dictionary &parentDict, Istream &)
	Construct given the entry name, parent dictionary and Istream,. More...

	dictionary (Istream &, const bool keepHeader=false)
	Construct top-level dictionary from Istream,. More...

	dictionary (const dictionary &parentDict, const dictionary &)
	Construct as copy given the parent dictionary. More...

	dictionary (const dictionary &)
	Construct top-level dictionary as copy. More...

	dictionary (const dictionary *)
	Construct top-level dictionary as copy from pointer to dictionary. More...

	dictionary (const dictionary &parentDict, dictionary &&)
	Move constructor transferring parameter contents. More...

	dictionary (dictionary &&)
	Move constructor. More...

autoPtr< dictionary >	clone () const
	Construct and return clone. More...

virtual	~dictionary ()
	Destructor. More...

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

bool	isNull () const
	Return whether this dictionary is null. More...

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

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

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

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

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

bool	found (const word &, bool recursive=false, bool patternMatch=true) const
	Search dictionary for given keyword. More...

const entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

entry *	lookupEntryPtr (const word &, bool recursive, bool patternMatch)
	Find and return an entry data stream pointer for manipulation. More...

const entry *	lookupEntryPtrBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

const entry &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

const entry &	lookupEntryBackwardsCompatible (const wordList &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present, trying a list. More...

ITstream &	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream. More...

ITstream &	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return an entry data stream, trying a list of keywords. More...

template<class T >
T	lookup (const word &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupBackwardsCompatible (const wordList &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. More...

template<class T >
T	lookupOrDefault (const word &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T,. More...

template<class T >
T	lookupOrDefaultBackwardsCompatible (const wordList &, const T &, bool recursive=false, bool patternMatch=true) const
	Find and return a T, trying a list of keywords in sequence. More...

template<class T >
T	lookupOrAddDefault (const word &, const T &, bool recursive=false, bool patternMatch=true)
	Find and return a T, if not found return the given. More...

template<class T >
bool	readIfPresent (const word &, T &, bool recursive=false, bool patternMatch=true) const
	Find an entry if present, and assign to T. More...

const entry *	lookupScopedEntryPtr (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream pointer if present. More...

bool	isDict (const word &) const
	Check if entry is a sub-dictionary. More...

const dictionary *	subDictPtr (const word &) const
	Find and return a sub-dictionary pointer if present. More...

dictionary *	subDictPtr (const word &)
	Find and return a sub-dictionary pointer if present. More...

const dictionary &	subDict (const word &) const
	Find and return a sub-dictionary. More...

dictionary &	subDict (const word &)
	Find and return a sub-dictionary for manipulation. More...

dictionary	subOrEmptyDict (const word &, const bool mustRead=false) const
	Find and return a sub-dictionary as a copy, or. More...

const dictionary &	optionalSubDict (const word &) const
	Find and return a sub-dictionary if found. More...

const dictionary &	scopedDict (const word &) const
	Find and return a sub-dictionary by scoped lookup. More...

dictionary &	scopedDict (const word &)
	Find and return a sub-dictionary by scoped lookup. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the sorted table of contents. More...

List< keyType >	keys (bool patterns=false) const
	Return the list of available keys or patterns. More...

bool	substituteKeyword (const word &keyword)
	Substitute the given keyword prepended by '$' with the. More...

bool	substituteScopedKeyword (const word &keyword)
	Substitute the given scoped keyword prepended by '$' with the. More...

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

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

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

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

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

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

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

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

void	set (entry *)
	Assign a new entry, overwrite any existing entry. More...

void	set (const entry &)
	Assign a new entry, overwrite any existing entry. More...

void	set (const keyType &, const dictionary &)
	Assign a dictionary entry, overwrite any existing entry. More...

template<class T >
void	set (const keyType &, const T &)
	Assign a T entry, overwrite any existing entry. More...

bool	remove (const word &)
	Remove an entry specified by keyword. More...

bool	changeKeyword (const keyType &oldKeyword, const keyType &newKeyword, bool forceOverwrite=false)
	Change the keyword for an entry,. More...

bool	merge (const dictionary &)
	Merge entries from the given dictionary. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (dictionary &)
	Transfer the contents of the argument and annul the argument. More...

bool	read (Istream &, const bool keepHeader=false)
	Read dictionary from Istream, optionally keeping the header. More...

void	write (Ostream &, const bool subDict=true) const
	Write dictionary, normally with sub-dictionary formatting. More...

ITstream &	operator[] (const word &) const
	Find and return entry. More...

void	operator= (const dictionary &)

void	operator= (dictionary &&)

void	operator+= (const dictionary &)
	Include entries from the given dictionary. More...

void	operator\|= (const dictionary &)
	Conditionally include entries from the given dictionary. More...

void	operator<<= (const dictionary &)
	Unconditionally include entries from the given dictionary. More...

Public Member Functions inherited from dictionaryName
	dictionaryName ()
	Construct dictionaryName null. More...

	dictionaryName (const fileName &name)
	Construct dictionaryName as copy of the given fileName. More...

	dictionaryName (dictionaryName &&name)
	Move constructor. More...

const fileName &	name () const
	Return the dictionary name. More...

fileName &	name ()
	Return the dictionary name. More...

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

void	operator= (const dictionaryName &name)

void	operator= (dictionaryName &&name)

Public Member Functions inherited from ILList< LListBase, T >
	ILList ()
	Null construct. More...

	ILList (T *a)
	Construct given initial T. More...

	ILList (Istream &)
	Construct from Istream. More...

	ILList (const ILList< LListBase, T > &)
	Copy constructor. More...

	ILList (ILList< LListBase, T > &&)
	Move constructor. More...

template<class CloneArg >
	ILList (const ILList< LListBase, T > &lst, const CloneArg &cloneArg)
	Copy constructor with additional argument for clone. More...

template<class INew >
	ILList (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	~ILList ()
	Destructor. More...

bool	eraseHead ()
	Remove the head element specified from the list and delete it. More...

bool	erase (T *p)
	Remove the specified element from the list and delete it. More...

void	clear ()
	Clear the contents of the list. More...

void	transfer (ILList< LListBase, T > &)
	Transfer the contents of the argument into this List. More...

void	operator= (const ILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (ILList< LListBase, T > &&)
	Move assignment operator. More...

Public Member Functions inherited from UILList< LListBase, T >
	UILList ()
	Null construct. More...

	UILList (T *a)
	Construct given initial T. More...

	UILList (const UILList< LListBase, T > &)
	Copy constructor. More...

	UILList (UILList< LListBase, T > &&)
	Move constructor. More...

T *	first ()
	Return the first entry. More...

const T *	first () const
	Return the first entry. More...

T *	last ()
	Return the last entry. More...

const T *	last () const
	Return the last entry. More...

T *	removeHead ()
	Remove and return head. More...

T *	remove (T *p)
	Remove and return element. More...

T *	remove (iterator &it)
	Remove and return specified by iterator. More...

void	operator= (const UILList< LListBase, T > &)
	Assignment operator. More...

void	operator= (UILList< LListBase, T > &&)
	Move assignment operator. More...

iterator	begin ()

const iterator &	end ()

const_iterator	cbegin () const

const const_iterator &	cend () const

const_iterator	begin () const

const const_iterator &	end () const

const_reverse_iterator	crbegin () const

const const_reverse_iterator &	crend () const

const_reverse_iterator	rbegin () const

const const_reverse_iterator &	rend () const

bool	operator== (const UILList< LListBase, T > &) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UILList< LListBase, T > &) const
	The opposite of the equality operation. Takes linear time. More...

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 AMIInterpolation &	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 IOdictionary
	IOdictionary (const IOobject &io, const word &wantedType)
	Construct given an IOobject, supply wanted typeName. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	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	infoOutput_
	Information output. More...

const word	modelName_
	Model name. More...

autoPtr< fvMesh >	regionMeshPtr_
	Pointer to the region mesh database. 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< AMIInterpolation > >	interRegionAMI_
	List of AMI objects per coupled region. More...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. More...

Public Types inherited from UILList< LListBase, T >
typedef T	value_type
	Type of values the DLList contains. More...

typedef T &	reference
	Type that can be used for storing into DLList::value_type. More...

typedef const T &	const_reference
	Type that can be used for storing into constant. More...

typedef label	size_type
	The type that can represent the size of a DLList. More...

typedef LListBase::iterator	LListBase_iterator

typedef LListBase::const_iterator	LListBase_const_iterator

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

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

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

template<class Name >
static word	modelName (Name name, const word &model)
	Return the name of the object within the given model. More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Member Functions inherited from dictionary
static autoPtr< dictionary >	New (Istream &)
	Construct top-level dictionary on freestore from Istream. More...

Static Public Attributes inherited from IOdictionary
static bool	writeDictionaries

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Static Public Attributes inherited from dictionary
static const dictionary	null
	Null dictionary. More...

static bool	writeOptionalEntries
	If true write optional keywords and values. More...

Detailed Description

Base class for region models.

Source files

Definition at line 55 of file regionModel.H.

Constructor & Destructor Documentation

◆ regionModel() [1/3]

regionModel	(	const fvMesh &	mesh,
		const word &	regionType
	)

Construct null.

Definition at line 333 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 366 of file regionModel.C.

References Foam::read().

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

References Foam::read().

Here is the call graph for this function:

◆ ~regionModel()

~regionModel ( )

virtual

Destructor.

Definition at line 452 of file regionModel.C.

Member Function Documentation

◆ read() [1/2]

bool read ( )

protectedvirtual

Read control parameters from dictionary.

Reimplemented from regIOobject.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, thermalBaffle, regionModel1D, thermalBaffleModel, surfaceFilmRegionModel, and noThermo.

Definition at line 141 of file regionModel.C.

References regIOobject::read().

Referenced by surfaceFilmRegionModel::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 thermalBaffle, regionModel1D, and thermalBaffleModel.

Definition at line 161 of file regionModel.C.

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

Here is the call graph for this function:

◆ interRegionAMI()

const Foam::AMIInterpolation & 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 176 of file regionModel.C.

References polyPatch::boundaryMesh(), Foam::findIndex(), AMIInterpolation::imFaceAreaWeight, UPstream::msgType(), IOobject::name(), regionModel::nbrCoupledPatchID(), p, regionModel::regionMesh(), UPtrList< 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()

TypeName ( "regionModel" )

Runtime type information.

◆ primaryMesh()

const Foam::fvMesh & primaryMesh ( ) const

inline

Return the reference to the primary mesh database.

Definition at line 31 of file regionModelI.H.

References regionModel::primaryMesh_.

Referenced by noThermo::Cp(), thermoSingleLayer::Sh(), kinematicSingleLayer::Sh(), kinematicSingleLayer::Srho(), kinematicSingleLayer::SU(), thermoSingleLayer::SYi(), kinematicSingleLayer::SYi(), thermoSingleLayer::transferPrimaryRegionSourceFields(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

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

References regionModel::time_.

Referenced by nutkFilmWallFunctionFvPatchScalarField::calcUTau(), kinematicSingleLayer::deltaMass(), phaseChangeModel::info(), kinematicSingleLayer::kinematicSingleLayer(), mappedVariableThicknessWallFvPatch::makeDeltaCoeffs(), constantRadiation::Shs(), kinematicSingleLayer::solveMomentum(), laminar::Su(), thermoSingleLayer::SYi(), thermoSingleLayer::thermoSingleLayer(), distributionContactAngleForce::theta(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), inclinedFilmNusseltHeightFvPatchScalarField::updateCoeffs(), inclinedFilmNusseltInletVelocityFvPatchVectorField::updateCoeffs(), thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), and filmSubModelBase::writeTime().

Here is the caller graph for this function:

◆ infoOutput()

const Foam::Switch & infoOutput ( ) const

inline

Return the information flag.

Definition at line 43 of file regionModelI.H.

References regionModel::infoOutput_.

◆ modelName()

const Foam::word & modelName ( ) const

inline

Return the model name.

Definition at line 49 of file regionModelI.H.

References regionModel::modelName_.

◆ regionMesh() [1/2]

const Foam::fvMesh & regionMesh ( ) const

inline

Return the region mesh database.

Definition at line 55 of file regionModelI.H.

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

Referenced by patchEjection::correct(), contactAngleForce::correct(), drippingEjection::correct(), curvatureSeparation::correct(), waxSolventEvaporation::correctModel(), solidification::correctModel(), kinematicSingleLayer::CourantNumber(), curvatureSeparation::curvatureSeparation(), constantHeatTransfer::h(), ejectionModelList::info(), transferModelList::info(), thermalBaffle::info(), regionModel::interRegionAMI(), kinematicSingleLayer::kinematicSingleLayer(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), regionModel::mapRegionPatchField(), regionModel::mapRegionPatchInternalField(), regionModel::nbrCoupledPatchID(), patchEjection::patchEjection(), kinematicSingleLayer::pe(), thermalBaffleModel::read(), kinematicSingleLayer::sigma(), regionModel::solution(), kinematicSingleLayer::solveAlpha(), thermalBaffle::solveEnergy(), kinematicSingleLayer::solveMomentum(), thermoSingleLayer::thermoSingleLayer(), temperatureDependentContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), thermoSingleLayer::Tw(), thermoSingleLayer::updateSubmodels(), kinematicSingleLayer::updateSubmodels(), and kinematicSingleLayer::Uw().

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

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

Here is the call graph for this function:

◆ coeffs()

const Foam::dictionary & coeffs ( ) const

inline

Return the model coefficients dictionary.

Definition at line 90 of file regionModelI.H.

References regionModel::coeffs_.

Referenced by thermoSingleLayer::thermoSingleLayer().

Here is the caller graph for this function:

◆ solution()

const Foam::dictionary & solution ( ) const

inline

Return the solution dictionary.

Definition at line 97 of file regionModelI.H.

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

Referenced by thermalBaffle::read().

Here is the call graph for this function:

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

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, 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:

◆ outputProperties() [2/2]

Foam::IOdictionary & outputProperties ( )

inline

Return output properties dictionary.

Definition at line 118 of file regionModelI.H.

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

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

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

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

Here is the call graph for this function:

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

◆ primaryPatchIDs()

const Foam::labelList & primaryPatchIDs ( ) const

inline

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

to this region

Definition at line 166 of file regionModelI.H.

References regionModel::primaryPatchIDs_.

Referenced by SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::inject(), thermoSingleLayer::Sh(), kinematicSingleLayer::Srho(), kinematicSingleLayer::SU(), and thermoSingleLayer::SYi().

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

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

Referenced by transferModelList::correct(), ejectionModelList::correct(), ejectionModelList::info(), transferModelList::info(), thermalBaffle::info(), SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::inject(), regionModel::nbrCoupledPatchID(), and kinematicSingleLayer::Srho().

Here is the call graph for this function:

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

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

Referenced by regionModel::intCoupledPatchIDs().

Here is the caller graph for this function:

◆ nbrCoupledPatchID()

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

Return the coupled patch ID paired with coupled patch.

regionPatchi

Definition at line 263 of file regionModel.C.

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

Referenced by regionModel::interRegionAMI().

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 regionModel::mapRegionPatchField().

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

Referenced by regionModel::mapRegionPatchField().

Here is the caller graph for this function:

◆ toPrimary() [1/2]

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

Convert a local region field to the primary region.

Definition at line 165 of file regionModelTemplates.C.

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

Referenced by SurfaceFilmModel< Foam::MomentumCloud< CloudType > >::cacheFilmFields(), ThermoSurfaceFilm< CloudType >::cacheFilmFields(), regionModel::mapRegionPatchInternalField(), thermoSingleLayer::Sh(), kinematicSingleLayer::Srho(), kinematicSingleLayer::SU(), and thermoSingleLayer::SYi().

Here is the call graph for this function:

Here is the caller 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 192 of file regionModelTemplates.C.

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

Here is the call graph for this function:

◆ toRegion() [1/3]

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

Convert a primary region field to the local region.

Definition at line 220 of file regionModelTemplates.C.

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

Referenced by primaryRadiation::correct(), mappedConvectiveHeatTransfer::correct(), standardRadiation::correct(), regionModel::toPrimary(), regionModel::toRegion(), thermoSingleLayer::transferPrimaryRegionSourceFields(), and kinematicSingleLayer::transferPrimaryRegionSourceFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toRegion() [2/3]

void toRegion	(	Field< Type > &	regionField,
		const label	regionPatchi,
		const fvPatchField< Type > &	primaryPatchField
	)		const

Return a primary patch field mapped the region internal field.

Definition at line 247 of file regionModelTemplates.C.

References polyPatch::boundaryMesh(), polyPatch::faceCells(), and regionModel::toRegion().

Here is the call graph for this function:

◆ toRegion() [3/3]

void toRegion	(	Field< Type > &	rf,
		const typename GeometricField< Type, fvPatchField, volMesh >::Boundary &	pBf
	)		const

Return a primary patch field mapped the local region.

Definition at line 265 of file regionModelTemplates.C.

References forAll.

◆ evolve()

void evolve ( )

virtual

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

Reimplemented in surfaceFilmRegionModel.

Definition at line 458 of file regionModel.C.

References IOstream::ASCII, IOstream::currentVersion, 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, thermalBaffleModel, thermalBaffle, and noThermo.

Definition at line 490 of file regionModel.C.

Referenced by kinematicSingleLayer::preEvolveRegion().

Here is the caller graph for this function:

◆ evolveRegion()

void evolveRegion ( )

virtual

Evolve the region.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, thermalBaffle, and noThermo.

Definition at line 496 of file regionModel.C.

◆ postEvolveRegion()

void postEvolveRegion ( )

virtual

Post-evolve region.

Definition at line 500 of file regionModel.C.

◆ info()

void info ( )

virtual

Provide some feedback.

Reimplemented in kinematicSingleLayer, thermoSingleLayer, and thermalBaffle.

Definition at line 506 of file regionModel.C.

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

References AMIInterpolation::interpolateToSource(), and regionModel::mapRegionPatchField().

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

References objectRegistry::foundObject(), AMIInterpolation::interpolateToSource(), objectRegistry::lookupObject(), regionModel::mapRegionPatchInternalField(), 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 110 of file regionModelTemplates.C.

References objectRegistry::foundObject(), AMIInterpolation::interpolateToSource(), objectRegistry::lookupObject(), p, regionModel::regionMesh(), regionModel::toPrimary(), 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 79 of file regionModel.H.

Referenced by regionModel::primaryMesh().

◆ time_

const Time& time_

protected

Reference to the time database.

Definition at line 82 of file regionModel.H.

Referenced by kinematicSingleLayer::continuityCheck(), kinematicSingleLayer::CourantNumber(), regionModel::regionMesh(), thermoSingleLayer::Sh(), kinematicSingleLayer::Srho(), kinematicSingleLayer::SU(), regionModel::time(), thermoSingleLayer::transferPrimaryRegionSourceFields(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), and thermoSingleLayer::updateSubmodels().

◆ infoOutput_

Switch infoOutput_

protected

Information output.

Definition at line 85 of file regionModel.H.

Referenced by regionModel::infoOutput().

◆ modelName_

const word modelName_

protected

Model name.

Definition at line 88 of file regionModel.H.

Referenced by regionModel::modelName().

◆ regionMeshPtr_

autoPtr<fvMesh> regionMeshPtr_

protected

Pointer to the region mesh database.

Definition at line 91 of file regionModel.H.

Referenced by regionModel::regionMesh().

◆ coeffs_

dictionary coeffs_

protected

Model coefficients dictionary.

Definition at line 94 of file regionModel.H.

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

◆ outputPropertiesPtr_

autoPtr<IOdictionary> outputPropertiesPtr_

protected

Dictionary of output properties.

Definition at line 97 of file regionModel.H.

Referenced by regionModel::outputProperties().

◆ primaryPatchIDs_

labelList primaryPatchIDs_

protected

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

Definition at line 103 of file regionModel.H.

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

◆ intCoupledPatchIDs_

labelList intCoupledPatchIDs_

protected

List of patch IDs internally coupled with the primary region.

Definition at line 106 of file regionModel.H.

Referenced by regionModel::intCoupledPatchIDs(), regionModel::isCoupledPatch(), singleLayerRegion::mappedFieldAndInternalPatchTypes(), thermalBaffleModel::read(), regionModel::regionPatchID(), thermoSingleLayer::Sh(), thermalBaffle::solveEnergy(), kinematicSingleLayer::SU(), thermoSingleLayer::SYi(), thermoSingleLayer::Tw(), kinematicSingleLayer::Uw(), and thermalBaffle::~thermalBaffle().

◆ regionName_

word regionName_

protected

Region name.

Definition at line 110 of file regionModel.H.

Referenced by regionModel::regionMesh().

◆ functions_

regionModelFunctionObjectList functions_

protected

Region model function objects.

Definition at line 113 of file regionModel.H.

◆ interRegionAMINames_

wordList interRegionAMINames_

mutableprotected

List of region names this region is coupled to.

Definition at line 119 of file regionModel.H.

◆ interRegionAMI_

PtrList<PtrList<AMIInterpolation> > interRegionAMI_

mutableprotected

List of AMI objects per coupled region.

Definition at line 122 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()

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

◆ toPrimary() [2/2]

◆ toRegion() [1/3]

◆ toRegion() [2/3]

◆ toRegion() [3/3]

◆ evolve()

◆ preEvolveRegion()

◆ evolveRegion()

◆ postEvolveRegion()

◆ info()

◆ mapRegionPatchField() [3/4]

◆ mapRegionPatchField() [4/4]

◆ mapRegionPatchInternalField() [2/2]

Member Data Documentation

◆ primaryMesh_

◆ time_

◆ infoOutput_

◆ modelName_

◆ regionMeshPtr_

◆ coeffs_

◆ outputPropertiesPtr_

◆ primaryPatchIDs_

◆ intCoupledPatchIDs_

◆ regionName_

◆ functions_

◆ interRegionAMINames_

◆ interRegionAMI_