Class to represent a system of phases and model interfacial transfers between them. More...

Inheritance diagram for phaseSystem:

Collaboration diagram for phaseSystem:

[legend]

Public Types
typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash >	KdTable

typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash >	VmTable

typedef HashPtrTable< fvVectorMatrix, word, string::hash >	momentumTransferTable

typedef HashPtrTable< fvScalarMatrix, word, string::hash >	heatTransferTable

typedef HashPtrTable< fvScalarMatrix, word, string::hash >	massTransferTable

typedef PtrListDictionary< phaseModel >	phaseModelList

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

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

	phaseSystem (const fvMesh &mesh)
	Construct from fvMesh. More...

virtual	~phaseSystem ()
	Destructor. More...

const fvMesh &	mesh () const
	Constant access the mesh. More...

const phaseModelList &	phases () const
	Constant access the phase models. More...

phaseModelList &	phases ()
	Access the phase models. More...

const phasePairTable &	phasePairs () const
	Constant access the phase pairs. More...

tmp< volScalarField >	rho () const
	Return the mixture density. More...

tmp< volVectorField >	U () const
	Return the mixture velocity. More...

const surfaceScalarField &	phi () const
	Constant access the mixture flux. More...

surfaceScalarField &	phi ()
	Access the mixture flux. More...

const volScalarField &	dpdt () const
	Constant access the rate of change of the pressure. More...

volScalarField &	dpdt ()
	Access the rate of change of the pressure. More...

tmp< volScalarField >	E (const phasePairKey &key) const
	Return the aspect-ratio. More...

tmp< volScalarField >	sigma (const phasePairKey &key) const
	Return the surface tension coefficient. More...

const IOMRFZoneList &	MRF () const
	Return MRF zones. More...

fv::options &	fvOptions () const
	Optional FV-options. More...

template<class modelType >
const modelType &	lookupSubModel (const phasePair &key) const
	Access a sub model between a phase pair. More...

template<class modelType >
const modelType &	lookupSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
	Access a sub model between two phases. More...

virtual void	solve ()
	Solve for the phase fractions. More...

virtual void	correct ()
	Correct the fluid properties other than the thermo and turbulence. More...

virtual void	correctKinematics ()
	Correct the kinematics. More...

virtual void	correctThermo ()
	Correct the thermodynamics. More...

virtual void	correctTurbulence ()
	Correct the turbulence. More...

virtual void	correctEnergyTransport ()
	Correct the energy transport e.g. alphat. More...

virtual bool	read ()
	Read base phaseProperties dictionary. More...

Public Member Functions inherited from IOdictionary
	IOdictionary (const IOobject &)
	Construct given an IOobject. More...

	IOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

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

virtual	~IOdictionary ()
	Destructor. More...

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

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

Public Member Functions inherited from baseIOdictionary
	TypeName ("dictionary")

	baseIOdictionary (const IOobject &)
	Construct given an IOobject. More...

	baseIOdictionary (const IOobject &, const dictionary &)
	Construct given an IOobject and dictionary. More...

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

virtual	~baseIOdictionary ()
	Destructor. More...

const word &	name () const
	Name function is needed to disambiguate those inherited. 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 baseIOdictionary &)
	Assignment of other baseIOdictionary's entries to this. More...

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

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Construct as copy. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Construct as copy, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Construct as copy with new name, transfering registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Construct as copy with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

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

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

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

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 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. Return. 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 valid) const
	Write using given format, version and compression. More...

virtual bool	write (const bool valid=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, 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)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. 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...

bool &	globalObject ()
	Is object same for all processors. More...

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

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

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

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

const fileName &	rootPath () const

const fileName &	caseName () const

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	objectPath () const
	Return complete path + 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)

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

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

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

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

	dictionary (Istream &)
	Construct top-level dictionary from Istream,. More...

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

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

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

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

	dictionary (const dictionary &parentDict, const Xfer< dictionary > &)
	Construct by transferring parameter contents given parent dictionary. More...

	dictionary (const Xfer< dictionary > &)
	Construct top-level dictionary by transferring parameter contents. More...

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

virtual	~dictionary ()
	Destructor. More...

const dictionary &	parent () const
	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 &, 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 &	lookupEntry (const word &, bool recursive, bool patternMatch) const
	Find and return an entry data stream if present otherwise error. More...

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

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

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

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

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

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

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

Xfer< dictionary >	xfer ()
	Transfer contents to the Xfer container. More...

bool	read (Istream &)
	Read dictionary from Istream. More...

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

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

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

void	operator= (const dictionary &)

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

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

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

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

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

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

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 > &)
	Construct as copy. 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...

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 > &)
	Construct as copy. 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 > &)

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

Static Public Attributes
static const word	propertiesName
	Default name of the phase properties dictionary. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
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...

Protected Types
typedef HashTable< dictionary, phasePairKey, phasePairKey::hash >	dictTable

typedef HashTable< autoPtr< phasePair >, phasePairKey, phasePairKey::hash >	phasePairTable

typedef HashTable< autoPtr< blendingMethod >, word, word::hash >	blendingMethodTable

typedef HashTable< autoPtr< surfaceTensionModel >, phasePairKey, phasePairKey::hash >	surfaceTensionModelTable

typedef HashTable< autoPtr< aspectRatioModel >, phasePairKey, phasePairKey::hash >	aspectRatioModelTable

Protected Member Functions
tmp< surfaceScalarField >	calcPhi (const phaseModelList &phaseModels) const
	Calculate and return the mixture flux. More...

void	generatePairs (const dictTable &modelDicts)
	Generate pairs. More...

template<class modelType >
void	createSubModels (const dictTable &modelDicts, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and sub-model tables. More...

template<class modelType >
void	generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and sub-model tables. More...

template<class modelType >
void	generatePairsAndSubModels (const word &modelName, HashTable< autoPtr< BlendedInterfacialModel< modelType >>, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and blended sub-model tables. More...

template<class modelType >
void	generatePairsAndSubModels (const word &modelName, HashTable< HashTable< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and per-phase sub-model tables. More...

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

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

Protected Attributes
const fvMesh &	mesh_
	Reference to the mesh. More...

phaseModelList	phaseModels_
	Phase models. More...

phasePairTable	phasePairs_
	Phase pairs. More...

surfaceScalarField	phi_
	Total volumetric flux. More...

volScalarField	dpdt_
	Rate of change of pressure. More...

IOMRFZoneList	MRF_
	Optional MRF zones. More...

blendingMethodTable	blendingMethods_
	Blending methods. More...

surfaceTensionModelTable	surfaceTensionModels_
	Surface tension models. More...

aspectRatioModelTable	aspectRatioModels_
	Aspect ratio models. More...

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

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

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

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

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

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

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

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

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Class to represent a system of phases and model interfacial transfers between them.

Source files

Definition at line 67 of file phaseSystem.H.

Member Typedef Documentation

◆ KdTable

typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash > KdTable

Definition at line 82 of file phaseSystem.H.

◆ VmTable

typedef HashPtrTable< volScalarField, phasePairKey, phasePairKey::hash > VmTable

Definition at line 91 of file phaseSystem.H.

◆ momentumTransferTable

typedef HashPtrTable< fvVectorMatrix, word, string::hash > momentumTransferTable

Definition at line 100 of file phaseSystem.H.

◆ heatTransferTable

typedef HashPtrTable< fvScalarMatrix, word, string::hash > heatTransferTable

Definition at line 109 of file phaseSystem.H.

◆ massTransferTable

typedef HashPtrTable< fvScalarMatrix, word, string::hash > massTransferTable

Definition at line 118 of file phaseSystem.H.

◆ phaseModelList

typedef PtrListDictionary<phaseModel> phaseModelList

Definition at line 120 of file phaseSystem.H.

◆ dictTable

typedef HashTable<dictionary, phasePairKey, phasePairKey::hash> dictTable

protected

Definition at line 129 of file phaseSystem.H.

◆ phasePairTable

typedef HashTable<autoPtr<phasePair>, phasePairKey, phasePairKey::hash> phasePairTable

protected

Definition at line 133 of file phaseSystem.H.

◆ blendingMethodTable

typedef HashTable<autoPtr<blendingMethod>, word, word::hash> blendingMethodTable

protected

Definition at line 137 of file phaseSystem.H.

◆ surfaceTensionModelTable

typedef HashTable< autoPtr<surfaceTensionModel>, phasePairKey, phasePairKey::hash > surfaceTensionModelTable

protected

Definition at line 146 of file phaseSystem.H.

◆ aspectRatioModelTable

typedef HashTable< autoPtr<aspectRatioModel>, phasePairKey, phasePairKey::hash > aspectRatioModelTable

protected

Definition at line 155 of file phaseSystem.H.

Constructor & Destructor Documentation

◆ phaseSystem()

phaseSystem ( const fvMesh & mesh )

Construct from fvMesh.

◆ ~phaseSystem()

virtual ~phaseSystem ( )

virtual

Destructor.

Member Function Documentation

◆ calcPhi()

tmp<surfaceScalarField> calcPhi ( const phaseModelList & phaseModels ) const

protected

Calculate and return the mixture flux.

◆ generatePairs()

void generatePairs ( const dictTable & modelDicts )

protected

Generate pairs.

◆ createSubModels()

void createSubModels	(	const dictTable &	modelDicts,
		HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &	models
	)

protected

Generate pairs and sub-model tables.

◆ generatePairsAndSubModels() [1/3]

void generatePairsAndSubModels	(	const word &	modelName,
		HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &	models
	)

protected

Generate pairs and sub-model tables.

◆ generatePairsAndSubModels() [2/3]

void generatePairsAndSubModels	(	const word &	modelName,
		HashTable< autoPtr< BlendedInterfacialModel< modelType >>, phasePairKey, phasePairKey::hash > &	models
	)

protected

Generate pairs and blended sub-model tables.

◆ generatePairsAndSubModels() [3/3]

void generatePairsAndSubModels	(	const word &	modelName,
		HashTable< HashTable< autoPtr< modelType >>, phasePairKey, phasePairKey::hash > &	models
	)

protected

Generate pairs and per-phase sub-model tables.

◆ TypeName()

TypeName ( "phaseSystem" )

Runtime type information.

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Constant access the mesh.

Definition at line 28 of file phaseSystemI.H.

References phaseSystem::mesh_.

◆ phases() [1/2]

const Foam::phaseSystem::phaseModelList & phases ( ) const

inline

Constant access the phase models.

Definition at line 35 of file phaseSystemI.H.

References phaseSystem::phaseModels_.

◆ phases() [2/2]

Foam::phaseSystem::phaseModelList & phases ( )

inline

Access the phase models.

Definition at line 42 of file phaseSystemI.H.

References phaseSystem::phaseModels_.

◆ phasePairs()

const Foam::phaseSystem::phasePairTable & phasePairs ( ) const

inline

Constant access the phase pairs.

Definition at line 49 of file phaseSystemI.H.

References phaseSystem::phasePairs_.

◆ rho()

tmp<volScalarField> rho ( ) const

Return the mixture density.

◆ U()

tmp<volVectorField> U ( ) const

Return the mixture velocity.

◆ phi() [1/2]

const Foam::surfaceScalarField & phi ( ) const

inline

Constant access the mixture flux.

Definition at line 55 of file phaseSystemI.H.

References phaseSystem::phi_.

◆ phi() [2/2]

Foam::surfaceScalarField & phi ( )

inline

Access the mixture flux.

Definition at line 61 of file phaseSystemI.H.

References phaseSystem::phi_.

◆ dpdt() [1/2]

const Foam::volScalarField & dpdt ( ) const

inline

Constant access the rate of change of the pressure.

Definition at line 67 of file phaseSystemI.H.

References phaseSystem::dpdt_.

◆ dpdt() [2/2]

Foam::volScalarField & dpdt ( )

inline

Access the rate of change of the pressure.

Definition at line 73 of file phaseSystemI.H.

References phaseSystem::dpdt_.

◆ E()

tmp<volScalarField> E ( const phasePairKey & key ) const

Return the aspect-ratio.

◆ sigma()

tmp<volScalarField> sigma ( const phasePairKey & key ) const

Return the surface tension coefficient.

◆ MRF()

const Foam::IOMRFZoneList & MRF ( ) const

inline

Return MRF zones.

Definition at line 79 of file phaseSystemI.H.

References phaseSystem::MRF_.

◆ fvOptions()

Foam::fv::options & fvOptions ( ) const

inline

Optional FV-options.

Definition at line 85 of file phaseSystemI.H.

References phaseSystem::mesh_, and options::New().

Here is the call graph for this function:

◆ lookupSubModel() [1/2]

const modelType& lookupSubModel ( const phasePair & key ) const

Access a sub model between a phase pair.

◆ lookupSubModel() [2/2]

const modelType& lookupSubModel	(	const phaseModel &	dispersed,
		const phaseModel &	continuous
	)		const

Access a sub model between two phases.

◆ solve()

virtual void solve ( )

virtual

Solve for the phase fractions.

Reimplemented in multiphaseSystem, twoPhaseSystem, multiphaseSystem, and twoPhaseSystem.

◆ correct()

virtual void correct ( )

virtual

Correct the fluid properties other than the thermo and turbulence.

Reimplemented in multiphaseSystem, and twoPhaseSystem.

◆ correctKinematics()

virtual void correctKinematics ( )

virtual

Correct the kinematics.

◆ correctThermo()

virtual void correctThermo ( )

virtual

Correct the thermodynamics.

◆ correctTurbulence()

virtual void correctTurbulence ( )

virtual

Correct the turbulence.

Reimplemented in twoPhaseSystem.

◆ correctEnergyTransport()

virtual void correctEnergyTransport ( )

virtual

Correct the energy transport e.g. alphat.

◆ read()

virtual bool read ( )

virtual

Read base phaseProperties dictionary.

Reimplemented from regIOobject.

Reimplemented in multiphaseSystem, and twoPhaseSystem.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_

protected

Reference to the mesh.

Definition at line 161 of file phaseSystem.H.

Referenced by phaseSystem::fvOptions(), and phaseSystem::mesh().

◆ phaseModels_

phaseModelList phaseModels_

protected

Phase models.

Definition at line 164 of file phaseSystem.H.

Referenced by phaseSystem::phases().

◆ phasePairs_

phasePairTable phasePairs_

protected

Phase pairs.

Definition at line 167 of file phaseSystem.H.

Referenced by phaseSystem::phasePairs().

◆ phi_

surfaceScalarField phi_

protected

Total volumetric flux.

Definition at line 170 of file phaseSystem.H.

Referenced by phaseSystem::phi().

◆ dpdt_

volScalarField dpdt_

protected

Rate of change of pressure.

Definition at line 173 of file phaseSystem.H.

Referenced by phaseSystem::dpdt().

◆ MRF_

IOMRFZoneList MRF_

protected

Optional MRF zones.

Definition at line 176 of file phaseSystem.H.

Referenced by phaseSystem::MRF().

◆ blendingMethods_

blendingMethodTable blendingMethods_

protected

Blending methods.

Definition at line 179 of file phaseSystem.H.

◆ surfaceTensionModels_

surfaceTensionModelTable surfaceTensionModels_

protected

Surface tension models.

Definition at line 185 of file phaseSystem.H.

◆ aspectRatioModels_

aspectRatioModelTable aspectRatioModels_

protected

Aspect ratio models.

Definition at line 188 of file phaseSystem.H.

◆ propertiesName

const word propertiesName

static

Default name of the phase properties dictionary.

Definition at line 264 of file phaseSystem.H.

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

applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseSystem/phaseSystem.H
applications/solvers/multiphase/reactingEulerFoam/phaseSystems/phaseSystem/phaseSystemI.H

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ KdTable

◆ VmTable

◆ momentumTransferTable

◆ heatTransferTable

◆ massTransferTable

◆ phaseModelList

◆ dictTable

◆ phasePairTable

◆ blendingMethodTable

◆ surfaceTensionModelTable

◆ aspectRatioModelTable

Constructor & Destructor Documentation

◆ phaseSystem()

◆ ~phaseSystem()

Member Function Documentation

◆ calcPhi()

◆ generatePairs()

◆ createSubModels()

◆ generatePairsAndSubModels() [1/3]

◆ generatePairsAndSubModels() [2/3]

◆ generatePairsAndSubModels() [3/3]

◆ TypeName()

◆ mesh()

◆ phases() [1/2]

◆ phases() [2/2]

◆ phasePairs()

◆ rho()

◆ U()

◆ phi() [1/2]

◆ phi() [2/2]

◆ dpdt() [1/2]

◆ dpdt() [2/2]

◆ E()

◆ sigma()

◆ MRF()

◆ fvOptions()

◆ lookupSubModel() [1/2]

◆ lookupSubModel() [2/2]

◆ solve()

◆ correct()

◆ correctKinematics()

◆ correctThermo()

◆ correctTurbulence()

◆ correctEnergyTransport()

◆ read()

Member Data Documentation

◆ mesh_

◆ phaseModels_

◆ phasePairs_

◆ phi_

◆ dpdt_

◆ MRF_

◆ blendingMethods_

◆ surfaceTensionModels_

◆ aspectRatioModels_

◆ propertiesName