Class which solves the volume fraction equations for two phases. More...

Inheritance diagram for multiphaseSystem:

Collaboration diagram for multiphaseSystem:

Classes
class	interfacePair

Public Types
typedef HashPtrTable< dragModel, interfacePair, interfacePair::symmHash >	dragModelTable

typedef HashPtrTable< volScalarField, interfacePair, interfacePair::symmHash >	dragCoeffFields

Public Types inherited from phaseSystem
typedef HashPtrTable< fvVectorMatrix >	momentumTransferTable

typedef HashPtrTable< fvScalarMatrix >	heatTransferTable

typedef HashPtrTable< fvScalarMatrix >	massTransferTable

typedef PtrListDictionary< phaseModel >	phaseModelList

typedef UPtrList< phaseModel >	phaseModelPartialList

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

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

typedef HashTable< autoPtr< phaseModel > >	phaseModelTable

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

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

	declareRunTimeSelectionTable (autoPtr, multiphaseSystem, dictionary,(const fvMesh &mesh),(mesh))

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

virtual	~multiphaseSystem ()
	Destructor. More...

tmp< surfaceScalarField >	surfaceTension (const phaseModel &phase) const
	Return the surface tension force. More...

tmp< volScalarField >	nearInterface () const
	Indicator of the proximity of the interface. More...

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

	TypeName ("multiphaseSystem")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, multiphaseSystem, dictionary,(const fvMesh &mesh),(mesh))

	multiphaseSystem (const fvMesh &)
	Construct from fvMesh. More...

virtual	~multiphaseSystem ()=default
	Destructor. More...

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

const UPtrList< phaseModel > &	phases () const
	Return phases. More...

UPtrList< phaseModel > &	phases ()
	Return phases. More...

const phaseModel &	phase (const label i) const
	Constant access phase model i. More...

phaseModel &	phase (const label i)
	Access phase model i. More...

dimensionedScalar	ddtAlphaMax () const
	Access to ddtAlphaMax. More...

scalar	maxDiffNo () const
	Maximum diffusion number. More...

const compressionFluxTable &	limitedPhiAlphas () const
	Access to compression fluxes for phaes. More...

SuSpTable &	Su ()
	Access Su. More...

SuSpTable &	Sp ()
	Access Sp. More...

virtual bool	read ()
	Read thermophysical properties dictionary. More...

	multiphaseSystem (const volVectorField &U, const surfaceScalarField &phi)
	Construct from components. More...

virtual	~multiphaseSystem ()=default
	Destructor. More...

const PtrDictionary< phaseModel > &	phases () const
	Return the phases. More...

PtrDictionary< phaseModel > &	phases ()
	Return the phases. More...

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

tmp< scalarField >	rho (const label patchi) const
	Return the mixture density for patch. More...

tmp< volScalarField >	nu () const
	Return the mixture laminar viscosity. More...

tmp< scalarField >	nu (const label patchi) const
	Return the laminar viscosity for patch. More...

tmp< volScalarField >	Cvm (const phaseModel &phase) const
	Return the virtual-mass coefficient for the given phase. More...

tmp< volVectorField >	Svm (const phaseModel &phase) const
	Return the virtual-mass source for the given phase. More...

const dragModelTable &	dragModels () const
	Return the table of drag models. More...

autoPtr< dragCoeffFields >	dragCoeffs () const
	Return the drag coefficients for all of the interfaces. More...

tmp< volScalarField >	dragCoeff (const phaseModel &phase, const dragCoeffFields &dragCoeffs) const
	Return the sum of the drag coefficients for the given phase. More...

tmp< surfaceScalarField >	surfaceTension (const phaseModel &phase) const

tmp< volScalarField >	nearInterface () const
	Indicator of the proximity of the interface. More...

void	solve ()
	Solve for the mixture phase-fractions. More...

void	correct ()
	Dummy correct. More...

bool	read ()
	Read base transportProperties dictionary. More...

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

virtual PtrList< volScalarField >	dmdts () const
	Return the mass transfer rates for each phase. More...

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

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

virtual	~phaseSystem ()
	Destructor. More...

const fvMesh &	mesh () const
	Return the mesh. More...

const phaseModelList &	phases () const
	Return the phase models. More...

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

const phaseModelPartialList &	movingPhases () const
	Return the models for phases that are moving. More...

phaseModelPartialList &	movingPhases ()
	Access the models for phases that are moving. More...

const phaseModelPartialList &	stationaryPhases () const
	Return the models for phases that are stationary. More...

phaseModelPartialList &	stationaryPhases ()
	Access the models for phases that are stationary. More...

const phaseModelPartialList &	anisothermalPhases () const
	Return the models for phases that have variable temperature. More...

phaseModelPartialList &	anisothermalPhases ()
	Access the models for phases that have variable temperature. More...

const phaseModelPartialList &	multiComponentPhases () const
	Return the models for phases that have multiple species. More...

phaseModelPartialList &	multiComponentPhases ()
	Access the models for phases that have multiple species. More...

const phasePairTable &	phasePairs () const
	Return the phase pairs. More...

const surfaceScalarField &	phi () const
	Return the mixture flux. More...

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

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

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

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

fv::options &	fvOptions () const
	Access the fvOptions. More...

template<class modelType >
bool	foundSubModel (const phasePair &key) const
	Check availability of a sub model for a given phase pair. More...

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

template<class modelType >
bool	foundSubModel (const phaseModel &dispersed, const phaseModel &continuous) const
	Check availability of a sub model between two phases. More...

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

template<class modelType >
bool	foundBlendedSubModel (const phasePair &key) const
	Check availability of a blended sub model for a given phase pair. More...

template<class modelType >
const BlendedInterfacialModel< modelType > &	lookupBlendedSubModel (const phasePair &key) const
	Return a blended sub model between a phase pair. More...

template<class Type , template< class > class PatchField, class GeoMesh >
void	fillFields (const word &name, const dimensionSet &dims, PtrList< GeometricField< Type, PatchField, GeoMesh >> &fieldList) const
	Fill up gaps in a phase-indexed list of fields with zeros. More...

template<class Type , template< class > class PatchField, class GeoMesh >
void	fillFields (const word &name, const dimensionSet &dims, HashPtrTable< GeometricField< Type, PatchField, GeoMesh >> &fieldTable) const
	Fill up gaps in a phase-indexed table of fields with zeros. More...

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

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

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

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

virtual tmp< volScalarField >	dmdt (const phasePairKey &key) const
	Return the mass transfer rate for a pair. More...

virtual PtrList< volScalarField >	dmdts () const
	Return the mass transfer rates for each phase. More...

virtual autoPtr< momentumTransferTable >	momentumTransfer ()=0
	Return the momentum transfer matrices for the cell-based. More...

virtual autoPtr< momentumTransferTable >	momentumTransferf ()=0
	Return the momentum transfer matrices for the face-based. More...

virtual PtrList< surfaceScalarField >	AFfs () const =0
	Return the implicit force coefficients for the face-based. More...

virtual PtrList< surfaceScalarField >	phiFs (const PtrList< volScalarField > &rAUs)=0
	Return the force fluxes for the cell-based algorithm. More...

virtual PtrList< surfaceScalarField >	phiFfs (const PtrList< surfaceScalarField > &rAUfs)=0
	Return the force fluxes for the face-based algorithm. More...

virtual PtrList< surfaceScalarField >	phiKdPhis (const PtrList< volScalarField > &rAUs) const =0
	Return the force fluxes for the cell-based algorithm. More...

virtual PtrList< surfaceScalarField >	phiKdPhifs (const PtrList< surfaceScalarField > &rAUfs) const =0
	Return the force fluxes for the face-based algorithm. More...

virtual PtrList< volVectorField >	KdUByAs (const PtrList< volScalarField > &rAUs) const =0
	Return the explicit part of the drag force. More...

virtual void	partialElimination (const PtrList< volScalarField > &rAUs)=0
	Solve the drag system for the new velocities and fluxes. More...

virtual void	partialEliminationf (const PtrList< surfaceScalarField > &rAUfs)=0
	Solve the drag system for the new fluxes. More...

virtual PtrList< surfaceScalarField >	ddtCorrByAs (const PtrList< volScalarField > &rAUs, const bool includeVirtualMass=false) const =0
	Return the flux corrections for the cell-based algorithm. More...

virtual const HashPtrTable< surfaceScalarField > &	DByAfs () const =0
	Return the phase diffusivities divided by the momentum. More...

virtual autoPtr< heatTransferTable >	heatTransfer () const =0
	Return the heat transfer matrices. More...

virtual autoPtr< massTransferTable >	massTransfer () const =0
	Return the mass transfer matrices. 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...

	TypeName ("phaseSystem")
	Runtime type information. More...

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

virtual	~phaseSystem ()
	Destructor. More...

virtual volScalarField &	he ()
	Return access to the inernal energy field [J/Kg]. More...

virtual const volScalarField &	he () const
	Return access to the inernal energy field [J/Kg]. More...

virtual tmp< volScalarField >	he (const volScalarField &p, const volScalarField &T) const
	Enthalpy/Internal energy. More...

virtual tmp< scalarField >	he (const scalarField &p, const scalarField &T, const labelList &cells) const
	Enthalpy/Internal energy for cell-set [J/kg]. More...

virtual tmp< scalarField >	he (const scalarField &p, const scalarField &T, const label patchi) const
	Enthalpy/Internal energy for patch [J/kg]. More...

virtual tmp< volScalarField >	hc () const
	Chemical enthalpy of the mixture [J/kg]. More...

virtual tmp< scalarField >	THE (const scalarField &h, const scalarField &p, const scalarField &T0, const labelList &cells) const
	Temperature from enthalpy/internal energy for cell-set. More...

virtual tmp< scalarField >	THE (const scalarField &h, const scalarField &p, const scalarField &T0, const label patchi) const
	Temperature from enthalpy/internal energy for patch. More...

virtual tmp< volScalarField >	Cp () const
	Return Cp of the mixture. More...

virtual tmp< scalarField >	Cp (const scalarField &p, const scalarField &T, const label patchi) const
	Heat capacity at constant pressure for patch [J/kg/K]. More...

virtual tmp< volScalarField >	Cv () const
	Return Cv of the mixture. More...

virtual tmp< scalarField >	Cv (const scalarField &p, const scalarField &T, const label patchI) const
	Heat capacity at constant volume for patch [J/kg/K]. More...

virtual tmp< volScalarField >	gamma () const
	Gamma = Cp/Cv []. More...

virtual tmp< scalarField >	gamma (const scalarField &p, const scalarField &T, const label patchi) const
	Gamma = Cp/Cv for patch []. More...

virtual tmp< volScalarField >	Cpv () const
	Heat capacity at constant pressure/volume [J/kg/K]. More...

virtual tmp< scalarField >	Cpv (const scalarField &p, const scalarField &T, const label patchi) const
	Heat capacity at constant pressure/volume for patch [J/kg/K]. More...

virtual tmp< volScalarField >	CpByCpv () const
	Heat capacity ratio []. More...

virtual tmp< scalarField >	CpByCpv (const scalarField &p, const scalarField &T, const label patchi) const
	Heat capacity ratio for patch []. More...

virtual tmp< volScalarField >	W () const
	Molecular weight [kg/kmol] of the mixture. More...

virtual tmp< volScalarField >	kappa () const
	Thermal diffusivity for temperature of mixture [J/m/s/K]. More...

virtual tmp< scalarField >	kappa (const label patchi) const
	Thermal diffusivity for temperature. More...

virtual tmp< volScalarField >	alphahe () const
	Thermal diffusivity for energy of mixture [kg/m/s]. More...

virtual tmp< scalarField >	alphahe (const label patchi) const
	Thermal diffusivity for energy of mixture for patch [kg/m/s]. More...

virtual tmp< volScalarField >	kappaEff (const volScalarField &kappat) const
	Effective thermal diffusivity for temperature. More...

virtual tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const
	Effective thermal diffusivity for temperature. More...

virtual tmp< volScalarField >	alphaEff (const volScalarField &alphat) const
	Effective thermal diffusivity of mixture [kg/m/s]. More...

virtual tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const
	Effective thermal diffusivity of mixture for patch [kg/m/s]. More...

const dimensionedScalar &	Prt () const
	Return Prandt number. More...

virtual tmp< volScalarField >	mu () const
	Dynamic viscosity of mixture [kg/m/s]. More...

virtual tmp< scalarField >	mu (const label patchi) const
	Dynamic viscosity of mixture for patch [kg/m/s]. More...

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

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

const surfaceScalarField &	rhoPhi () const
	Constant access to the mixture mass flux. More...

surfaceScalarField &	rhoPhi ()
	Access to the total mixture mass flux. More...

tmp< volVectorField >	U () const
	Mixture U. More...

tmp< surfaceScalarField >	surfaceTensionForce () const
	Calculate surface tension of the mixture. More...

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

virtual tmp< volScalarField >	coeffs (const word &key) const
	Return coefficients (1/rho) More...

void	addInterfacePorosity (fvVectorMatrix &UEqn)
	Add interface porosity on phasePair. More...

virtual tmp< volScalarField >	dmdt (const phasePairKey &key) const =0
	Return interfacial source mass rate per phase pair. More...

virtual tmp< fvScalarMatrix >	heatTransfer (const volScalarField &T)=0
	Return the heat transfer matrices. More...

virtual void	massSpeciesTransfer (const phaseModel &phase, volScalarField::Internal &Su, volScalarField::Internal &Sp, const word speciesName)=0
	Calculate mass transfer. More...

virtual word	thermoName () const
	Return the name of the thermo physics. More...

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

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

phasePairTable &	totalPhasePairs ()
	Non-constant access the total phase pairs. More...

const phaseModelTable &	phases () const
	Constant access the phases. More...

phaseModelTable &	phases ()
	Access the phases. 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 &from, const phaseModel &to) const
	Access a sub model between two phases. More...

virtual bool	incompressible () const
	Return true if the equation of state is incompressible for all. More...

virtual bool	incompressible (const word) const
	Return true if a phase is incompressible. More...

virtual bool	isochoric () const
	Return true if the equation of state is isochoric for all phasses. More...

const fvMesh &	mesh () const
	Return mesh. More...

tmp< surfaceVectorField >	nHatfv (const volScalarField &alpha1, const volScalarField &alpha2) const
	Interface normal surface vector. More...

tmp< surfaceScalarField >	nHatf (const volScalarField &alpha1, const volScalarField &alpha2) const
	Interface normal volume vector. More...

tmp< volScalarField >	K (const volScalarField &alpha1, const volScalarField &alpha2) const
	Interface curvature. More...

tmp< volScalarField >	nearInterface (const volScalarField &alpha1, const volScalarField &alpha2) const
	Near Interface of alpha1 and alpha2. More...

tmp< volScalarField >	nearInterface () const
	Near Interface of alpha'n. More...

template<class modelType >
const Foam::BlendedInterfacialModel< modelType > &	lookupBlendedSubModel (const phasePair &key) const

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

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

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

virtual	~IOdictionary ()
	Destructor. More...

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

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

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

	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 &io, const bool isTime=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

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

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

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

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

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

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

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

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

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

void	setUpToDate ()
	Set as up-to-date. More...

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

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

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 as copy resetting registry. More...

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

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

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

virtual	~IOobject ()=default
	Destructor. More...

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

const Time &	time () const
	Return time. 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 non-constant access to the class name read from header. More...

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

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

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

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

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

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

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const
	The read option. More...

readOption &	readOpt ()
	Non-constant access to the read option. More...

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

writeOption &	writeOpt ()
	Non-constant access to the write option. More...

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

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

const fileName &	rootPath () const

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

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

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

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

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

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

bool	good () const

bool	bad () const

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

void	operator= (const IOobject &io)

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType 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 &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
	The dictionary name. More...

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

word	dictName () const
	The local dictionary name (final part of scoped name) 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 &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. More...

bool	read (Istream &is, bool keepHeader)
	Read dictionary from Istream, optionally keeping the 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 &	FOAM_DEPRECATED_FOR (2018-07, "lookup() method") operator[](const word &keyword) const
	Deprecated(2018-07) find and return an entry data stream. More...

template<class T >
T	FOAM_DEPRECATED_FOR (2018-10, "get() method") lookupType(const word &keyword
	Deprecated(2018-10) find and return a T. 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
	Null construct. More...

	ILList (T *item)
	Construct and insert the initial T item pointer. More...

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

	ILList (const ILList< LListBase, T > &lst)
	Copy construct using the 'clone()' method for each element. More...

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

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

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

	~ILList ()
	Destructor. More...

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

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

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

void	transfer (ILList< LListBase, T > &lst)

void	operator= (const ILList< LListBase, T > &lst)
	Copy assignment using the 'clone()' method for each element. More...

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

Static Public Member Functions
static autoPtr< multiphaseSystem >	New (const fvMesh &mesh)

static autoPtr< multiphaseSystem >	New (const fvMesh &mesh)

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

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

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)
	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 StringType >
static word	groupName (StringType name, const word &group)
	Create dot-delimited name.group. 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 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, bool noHint=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 autoPtr< dictionary >	New (Istream &is)
	Construct top-level dictionary on freestore from Istream. More...

Protected Types
typedef HashTable< volScalarField::Internal >	SuSpTable

typedef HashTable< scalar, phasePairKey, phasePairKey::hash >	scalarTable

typedef HashTable< surfaceScalarField >	compressionFluxTable

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

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

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

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

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

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

typedef HashTable< autoPtr< porousModel >, phasePairKey, phasePairKey::hash >	interfacePorousModelTable

Protected Member Functions
void	calculateSuSp ()
	Calculate Sp and Su. More...

Protected Member Functions inherited from phaseSystem
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, const bool correctFixedFluxBCs=true)
	Generate pairs and blended sub-model tables. More...

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

template<class GeoField >
void	addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, PtrList< GeoField > &fieldList) const
	Add the field to a phase-indexed list, with the given name,. More...

template<class GeoField >
void	addField (const phaseModel &phase, const word &fieldName, const GeoField &field, PtrList< GeoField > &fieldList) const
	Add the field to a phase-indexed list, with the given name,. More...

template<class GeoField >
void	addField (const phaseModel &phase, const word &fieldName, tmp< GeoField > field, HashPtrTable< GeoField > &fieldTable) const
	Add the field to a phase-indexed table, with the given name,. More...

template<class GeoField >
void	addField (const phaseModel &phase, const word &fieldName, const GeoField &field, HashPtrTable< GeoField > &fieldTable) const
	Add the field to a phase-indexed table, with the given name,. More...

HashTable< autoPtr< phaseModel > >	generatePhaseModels (const wordList &names) const
	Generate the phases. More...

tmp< surfaceScalarField >	generatePhi (const HashTable< autoPtr< phaseModel >> &phaseModels) const
	Generate the mixture flux. More...

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

void	generatePairsTable ()
	Generate pair table. More...

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

template<class modelType >
void	createSubModels (const dictTable &modelDicts, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and sub-model tables using mesh. 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, const fvMesh &mesh, HashTable< autoPtr< modelType >, phasePairKey, phasePairKey::hash > &models)
	Generate pairs and per-phase sub-model tables with mesh ref. 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...

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

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

Protected Attributes
UPtrList< phaseModel >	phases_
	Unallocated phase list. More...

scalarTable	cAlphas_
	Table for compression factors between phases. More...

dimensionedScalar	ddtAlphaMax_
	Maximum volumen rate change. More...

compressionFluxTable	limitedPhiAlphas_
	Compression fluxed for phases. More...

SuSpTable	Su_
	Su phase source terms. More...

SuSpTable	Sp_
	Sp phase source terms. More...

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

phaseModelList	phaseModels_
	Phase models. More...

phaseModelPartialList	movingPhaseModels_
	Moving phase models. More...

phaseModelPartialList	stationaryPhaseModels_
	Stationary phase models. More...

phaseModelPartialList	anisothermalPhaseModels_
	Anisothermal phase models. More...

phaseModelPartialList	multiComponentPhaseModels_
	Multi-component 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...

wordList	phaseNames_
	Phase names. More...

surfaceScalarField	rhoPhi_
	Mixture total mass flux. More...

phaseModelTable	phaseModels_
	Phase models. More...

phasePairTable	totalPhasePairs_
	Total ordered phase pairs in the system. More...

dimensionedScalar	Prt_
	Turbulent Prandt number. More...

interfacePorousModelTable	interfacePorousModelTable_
	Interface porous models. More...

Static Protected Attributes
static const bool	fillFields_ = false
	Flag to indicate that returned lists of fields are "complete"; i.e.,. More...

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

Additional Inherited Members
Public Attributes inherited from dictionary
friend	const_searcher
	Declare friendship with the searcher classes. More...

friend	searcher

T bool	recursive = false

T bool bool	patternMatch

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

static const word	phasePropertiesName
	Default name of the phase properties dictionary. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

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

Static Public Attributes inherited from dictionary
static int	writeOptionalEntries
	Report optional keywords and values if not present in dictionary. More...

static const dictionary	null
	An empty dictionary, which is also the parent for all dictionaries. More...

Detailed Description

Class which solves the volume fraction equations for two phases.

Incompressible multi-phase mixture with built in solution for the phase fractions with interface compression for interface-capturing.

Class which solves the volume fraction equations for multiple phases.

Source files

Derived from transportModel so that it can be unsed in conjunction with the incompressible turbulence models.

Surface tension and contact-angle is handled for the interface between each phase-pair.

Source files

Definition at line 53 of file multiphaseSystem.H.

Member Typedef Documentation

◆ SuSpTable

typedef HashTable<volScalarField::Internal> SuSpTable

protected

Definition at line 58 of file multiphaseSystem.H.

◆ scalarTable

typedef HashTable<scalar, phasePairKey, phasePairKey::hash> scalarTable

protected

Definition at line 61 of file multiphaseSystem.H.

◆ compressionFluxTable

typedef HashTable<surfaceScalarField> compressionFluxTable

protected

Definition at line 63 of file multiphaseSystem.H.

◆ dragModelTable

typedef HashPtrTable<dragModel, interfacePair, interfacePair::symmHash> dragModelTable

Definition at line 153 of file multiphaseSystem.H.

◆ dragCoeffFields

typedef HashPtrTable<volScalarField, interfacePair, interfacePair::symmHash> dragCoeffFields

Definition at line 156 of file multiphaseSystem.H.

Constructor & Destructor Documentation

◆ multiphaseSystem() [1/3]

multiphaseSystem ( const fvMesh & mesh )

Construct from fvMesh.

Definition at line 507 of file multiphaseSystem.C.

References forAll, phasei, and phases.

◆ ~multiphaseSystem() [1/3]

~multiphaseSystem ( )

virtual

Destructor.

Definition at line 545 of file multiphaseSystem.C.

◆ multiphaseSystem() [2/3]

multiphaseSystem ( const fvMesh & )

Construct from fvMesh.

◆ ~multiphaseSystem() [2/3]

virtual ~multiphaseSystem ( )

virtualdefault

Destructor.

◆ multiphaseSystem() [3/3]

multiphaseSystem	(	const volVectorField &	U,
		const surfaceScalarField &	phi
	)

Construct from components.

◆ ~multiphaseSystem() [3/3]

virtual ~multiphaseSystem ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "multiphaseSystem" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		multiphaseSystem	,
		dictionary	,
		(const fvMesh &mesh)	,
		(mesh)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::multiphaseSystem > New ( const fvMesh & mesh )

static

Definition at line 34 of file newMultiphaseSystem.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::Info, and mesh.

Here is the call graph for this function:

◆ surfaceTension() [1/2]

Foam::tmp< Foam::surfaceScalarField > surfaceTension ( const phaseModel & phase ) const

Return the surface tension force.

Definition at line 552 of file multiphaseSystem.C.

References forAll, Foam::fvc::interpolate(), phaseModel::name(), GeometricField< scalar, fvsPatchField, surfaceMesh >::New(), phase1, phase2, phases, tmp< T >::ref(), sigma(), and Foam::fvc::snGrad().

Here is the call graph for this function:

◆ nearInterface() [1/2]

Foam::tmp< Foam::volScalarField > nearInterface ( ) const

Indicator of the proximity of the interface.

Field values are 1 near and 0 away for the interface.

Definition at line 597 of file multiphaseSystem.C.

References Foam::dimless, forAll, Foam::max(), GeometricField< scalar, fvPatchField, volMesh >::New(), phasei, phases, Foam::pos0(), and tmp< T >::ref().

Here is the call graph for this function:

◆ solve() [1/3]

void solve ( )

virtual

Solve for the phase fractions.

Reimplemented from phaseSystem.

Definition at line 622 of file multiphaseSystem.C.

References Foam::constant::atomic::alpha, alphaControls, GeometricField< Type, PatchField, GeoMesh >::clip(), localEulerDdt::enabled(), stdFoam::end(), forAll, dictionary::get(), Foam::fvc::interpolate(), localEulerDdt::localRSubDeltaT(), LTS, nAlphaSubCycles(), dimensioned< Type >::name(), phasei, phases, phase::rho(), runTime, PtrList< T >::set(), objectRegistry::time(), and Time::timeName().

Here is the call graph for this function:

◆ calculateSuSp()

void calculateSuSp ( )

protected

Calculate Sp and Su.

◆ TypeName() [2/2]

TypeName ( "multiphaseSystem" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		multiphaseSystem	,
		dictionary	,
		(const fvMesh &mesh)	,
		(mesh)
	)

◆ New() [2/2]

static autoPtr<multiphaseSystem> New ( const fvMesh & mesh )

static

◆ solve() [2/3]

virtual void solve ( )

virtual

Solve for the phase fractions.

Reimplemented from phaseSystem.

◆ phases() [1/4]

const UPtrList<phaseModel>& phases ( ) const

Return phases.

◆ phases() [2/4]

UPtrList<phaseModel>& phases ( )

Return phases.

◆ phase() [1/2]

const phaseModel& phase ( const label i ) const

Constant access phase model i.

◆ phase() [2/2]

phaseModel& phase ( const label i )

Access phase model i.

◆ ddtAlphaMax()

dimensionedScalar ddtAlphaMax ( ) const

Access to ddtAlphaMax.

◆ maxDiffNo()

scalar maxDiffNo ( ) const

Maximum diffusion number.

◆ limitedPhiAlphas()

const compressionFluxTable& limitedPhiAlphas ( ) const

Access to compression fluxes for phaes.

◆ Su()

SuSpTable& Su ( )

Access Su.

◆ Sp()

SuSpTable& Sp ( )

Access Sp.

◆ read() [1/2]

virtual bool read ( )

virtual

Read thermophysical properties dictionary.

Reimplemented from phaseSystem.

◆ phases() [3/4]

const PtrDictionary<phaseModel>& phases ( ) const

inline

Return the phases.

Definition at line 247 of file multiphaseSystem.H.

References multiphaseSystem::phases_.

◆ phases() [4/4]

PtrDictionary<phaseModel>& phases ( )

inline

Return the phases.

Definition at line 253 of file multiphaseSystem.H.

References multiphaseSystem::phases_.

◆ rho() [1/2]

tmp<volScalarField> rho ( ) const

virtual

Return the mixture density.

Reimplemented from phaseSystem.

◆ rho() [2/2]

tmp<scalarField> rho ( const label patchi ) const

virtual

Return the mixture density for patch.

Reimplemented from phaseSystem.

◆ nu() [1/2]

tmp<volScalarField> nu ( ) const

virtual

Return the mixture laminar viscosity.

Reimplemented from phaseSystem.

◆ nu() [2/2]

tmp<scalarField> nu ( const label patchi ) const

virtual

Return the laminar viscosity for patch.

Reimplemented from phaseSystem.

◆ Cvm()

tmp<volScalarField> Cvm ( const phaseModel & phase ) const

Return the virtual-mass coefficient for the given phase.

◆ Svm()

tmp<volVectorField> Svm ( const phaseModel & phase ) const

Return the virtual-mass source for the given phase.

◆ dragModels()

const dragModelTable& dragModels ( ) const

inline

Return the table of drag models.

Definition at line 277 of file multiphaseSystem.H.

◆ dragCoeffs()

autoPtr<dragCoeffFields> dragCoeffs ( ) const

Return the drag coefficients for all of the interfaces.

◆ dragCoeff()

tmp<volScalarField> dragCoeff	(	const phaseModel &	phase,
		const dragCoeffFields &	dragCoeffs
	)		const

Return the sum of the drag coefficients for the given phase.

◆ surfaceTension() [2/2]

tmp<surfaceScalarField> surfaceTension ( const phaseModel & phase ) const

◆ nearInterface() [2/2]

tmp<volScalarField> nearInterface ( ) const

Indicator of the proximity of the interface.

Field values are 1 near and 0 away for the interface.

◆ solve() [3/3]

void solve ( )

virtual

Solve for the mixture phase-fractions.

Reimplemented from phaseSystem.

◆ correct()

void correct ( )

inlinevirtual

Dummy correct.

Reimplemented from phaseSystem.

Definition at line 302 of file multiphaseSystem.H.

◆ read() [2/2]

bool read ( )

virtual

Read base transportProperties dictionary.

Reimplemented from phaseSystem.

◆ sigma()

Foam::tmp< Foam::volScalarField > sigma

Return the surface tension coefficient for a pair.

Definition at line 319 of file phaseSystem.C.

◆ dmdts()

Foam::PtrList< Foam::volScalarField > dmdts

Return the mass transfer rates for each phase.

Definition at line 351 of file phaseSystem.C.

Member Data Documentation

◆ fillFields_

const bool fillFields_ = false

staticprotected

Flag to indicate that returned lists of fields are "complete"; i.e.,.

that an absence of force is returned as a constructed list of zeros, rather than a null pointer

Definition at line 126 of file multiphaseSystem.H.

◆ phases_

UPtrList<phaseModel> phases_

protected

Unallocated phase list.

Definition at line 69 of file multiphaseSystem.H.

Referenced by multiphaseSystem::phases().

◆ cAlphas_

scalarTable cAlphas_

protected

Table for compression factors between phases.

Definition at line 72 of file multiphaseSystem.H.

◆ ddtAlphaMax_

dimensionedScalar ddtAlphaMax_

protected

Maximum volumen rate change.

Definition at line 75 of file multiphaseSystem.H.

◆ limitedPhiAlphas_

compressionFluxTable limitedPhiAlphas_

protected

Compression fluxed for phases.

Definition at line 78 of file multiphaseSystem.H.

◆ Su_

SuSpTable Su_

protected

Su phase source terms.

Definition at line 81 of file multiphaseSystem.H.

◆ Sp_

SuSpTable Sp_

protected

Sp phase source terms.

Definition at line 84 of file multiphaseSystem.H.

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

src/phaseSystemModels/reactingEulerFoam/reactingMultiphaseEulerFoam/multiphaseSystem/multiphaseSystem.H
src/phaseSystemModels/reactingEulerFoam/reactingMultiphaseEulerFoam/multiphaseSystem/multiphaseSystem.C
src/phaseSystemModels/reactingEulerFoam/reactingMultiphaseEulerFoam/multiphaseSystem/newMultiphaseSystem.C

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SuSpTable

◆ scalarTable

◆ compressionFluxTable

◆ dragModelTable

◆ dragCoeffFields

Constructor & Destructor Documentation

◆ multiphaseSystem() [1/3]

◆ ~multiphaseSystem() [1/3]

◆ multiphaseSystem() [2/3]

◆ ~multiphaseSystem() [2/3]

◆ multiphaseSystem() [3/3]

◆ ~multiphaseSystem() [3/3]

Member Function Documentation

◆ TypeName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ surfaceTension() [1/2]

◆ nearInterface() [1/2]

◆ solve() [1/3]

◆ calculateSuSp()

◆ TypeName() [2/2]

◆ declareRunTimeSelectionTable() [2/2]

◆ New() [2/2]

◆ solve() [2/3]

◆ phases() [1/4]

◆ phases() [2/4]

◆ phase() [1/2]

◆ phase() [2/2]

◆ ddtAlphaMax()

◆ maxDiffNo()

◆ limitedPhiAlphas()

◆ Su()

◆ Sp()

◆ read() [1/2]

◆ phases() [3/4]

◆ phases() [4/4]

◆ rho() [1/2]

◆ rho() [2/2]

◆ nu() [1/2]

◆ nu() [2/2]

◆ Cvm()

◆ Svm()

◆ dragModels()

◆ dragCoeffs()

◆ dragCoeff()

◆ surfaceTension() [2/2]

◆ nearInterface() [2/2]

◆ solve() [3/3]

◆ correct()

◆ read() [2/2]

◆ sigma()

◆ dmdts()

Member Data Documentation

◆ fillFields_

◆ phases_

◆ cAlphas_

◆ ddtAlphaMax_

◆ limitedPhiAlphas_

◆ Su_

◆ Sp_