Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations. More...

Inheritance diagram for phaseModel:

[legend]

Collaboration diagram for phaseModel:

[legend]

Classes
class	iNew
	Return a pointer to a new phase created on freestore. More...

Public Member Functions
	phaseModel (const word &phaseName, const dictionary &phaseDict, const fvMesh &mesh)

autoPtr< phaseModel >	clone () const
	Return clone. More...

virtual	~phaseModel ()
	Destructor. More...

const word &	name () const

const word &	keyword () const

tmp< volScalarField >	d () const

const dimensionedScalar &	nu () const

const dimensionedScalar &	kappa () const

const dimensionedScalar &	Cp () const

const dimensionedScalar &	rho () const

const volVectorField &	U () const

volVectorField &	U ()

const volVectorField &	DDtU () const

volVectorField &	DDtU ()

const surfaceScalarField &	phi () const

surfaceScalarField &	phi ()

const surfaceScalarField &	alphaPhi () const

surfaceScalarField &	alphaPhi ()

void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...

void	correct ()
	Correct the phase properties. More...

bool	read (const dictionary &phaseDict)
	Read base transportProperties dictionary. More...

	ClassName ("phaseModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName),(fluid, phaseName))

	phaseModel (const phaseSystem &fluid, const word &phaseName)
	Construct from phaseSystem and phaseName. More...

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

const word &	name () const
	The name of this phase. More...

const phaseSystem &	fluid () const
	Return the system to which this phase belongs. More...

virtual void	correct ()
	Correct phase thermo. More...

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

virtual void	solveYi (PtrList< volScalarField::Internal > &Su, PtrList< volScalarField::Internal > &Sp)=0
	Solve species fraction equation. More...

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

virtual const rhoThermo &	thermo () const =0
	Access const to phase thermo. More...

virtual rhoThermo &	thermo ()=0
	Access to phase thermo. More...

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

tmp< scalarField >	rho (const label patchi) const
	Return phase density on a patch. More...

tmp< volScalarField >	hc () const
	Chemical enthalpy for phase [J/kg]. More...

tmp< volScalarField >	Cp () const
	Return phase Cp. More...

tmp< scalarField >	Cp (const scalarField &p, const scalarField &T, const label patchi) const
	Heat capacity of the phase at constant pressure for patch. More...

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

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

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

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

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

tmp< scalarField >	Cpv (const scalarField &p, const scalarField &T, const label patchi) const
	Heat capacity at constant pressure/volume for phase at patch. More...

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

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

bool	dpdt () const
	Query thermo for dpdt. More...

const volScalarField &	alpha () const
	Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...

const scalarField &	alpha (const label patchi) const
	Thermal diffusivity for enthalpy of mixture for patch [kg/m/s]. More...

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

tmp< scalarField >	kappa (const label patchi) const
	Thermal diffusivity for temperature of phase for patch [J/m/s/K]. More...

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

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

tmp< volScalarField >	kappaEff (const volScalarField &) const
	Effective thermal diffusivity for temperature of phase [J/m/s/K]. More...

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

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

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

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

virtual tmp< scalarField >	nu (const label patchi) const
	Return the mixture kinematic viscosity on patchi. More...

virtual tmp< volScalarField >	mu () const
	Return the mixture dymanic viscosity. More...

virtual tmp< scalarField >	mu (const label patchi) const
	Return the mixture dymanic viscosity on patchi. More...

virtual tmp< surfaceScalarField >	diffNo () const =0
	Diffusion number. More...

virtual const PtrList< volScalarField > &	Y () const =0
	Constant access the species mass fractions. More...

virtual PtrList< volScalarField > &	Y ()=0
	Access the species mass fractions. More...

virtual tmp< surfaceScalarField >	phi () const =0
	Constant access the volumetric flux. More...

virtual const surfaceScalarField &	phi ()=0
	Access the volumetric flux. More...

virtual tmp< surfaceScalarField >	alphaPhi () const =0
	Constant access the volumetric flux of the phase. More...

virtual surfaceScalarField &	alphaPhi ()=0
	Access the volumetric flux of the phase. More...

virtual tmp< volVectorField >	U () const =0
	Access const reference to U. More...

	ClassName ("phaseModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName, const label index),(fluid, phaseName, index))

	phaseModel (const phaseSystem &fluid, const word &phaseName, const label index)

autoPtr< phaseModel >	clone () const
	Return clone. More...

virtual	~phaseModel ()
	Destructor. More...

const word &	name () const
	Return the name of this phase. More...

const word &	keyword () const
	Return the name of the phase for use as the keyword in PtrDictionary. More...

label	index () const
	Return the index of the phase. More...

const phaseSystem &	fluid () const
	Return the system to which this phase belongs. More...

const dimensionedScalar &	residualAlpha () const
	Return the residual phase-fraction for given phase. More...

scalar	alphaMax () const
	Return the maximum phase-fraction (e.g. packing limit) More...

tmp< volScalarField >	d () const
	Return the Sauter-mean diameter. More...

const autoPtr< diameterModel > &	dPtr () const
	Return const-reference to diameterModel of the phase. More...

virtual void	correct ()
	Correct the phase properties. 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. More...

void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...

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

virtual bool	compressible () const =0
	Return true if the phase is compressible otherwise false. More...

virtual tmp< volScalarField >	divU () const =0
	Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...

virtual void	divU (tmp< volScalarField > divU)=0
	Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...

virtual bool	isothermal () const =0
	Return whether the phase is isothermal. More...

virtual tmp< fvScalarMatrix >	heEqn ()=0
	Return the enthalpy equation. More...

virtual const rhoThermo &	thermo () const =0
	Return the thermophysical model. More...

virtual rhoThermo &	thermoRef ()=0
	Access the thermophysical model. More...

virtual tmp< volScalarField >	rho () const =0
	Return the density field. More...

virtual bool	pure () const =0
	Return whether the phase is pure (i.e., not multi-component) More...

virtual tmp< fvScalarMatrix >	YiEqn (volScalarField &Yi)=0
	Return the species fraction equation. More...

virtual const PtrList< volScalarField > &	Y () const =0
	Return the species mass fractions. More...

virtual const volScalarField &	Y (const word &name) const =0
	Return a species mass fraction by name. More...

virtual PtrList< volScalarField > &	YRef ()=0
	Access the species mass fractions. More...

virtual const UPtrList< volScalarField > &	YActive () const =0
	Return the active species mass fractions. More...

virtual UPtrList< volScalarField > &	YActiveRef ()=0
	Access the active species mass fractions. More...

virtual bool	stationary () const =0
	Return whether the phase is stationary. More...

virtual tmp< fvVectorMatrix >	UEqn ()=0
	Return the momentum equation. More...

virtual tmp< fvVectorMatrix >	UfEqn ()=0
	Return the momentum equation for the face-based algorithm. More...

virtual tmp< volVectorField >	U () const =0
	Return the velocity. More...

virtual volVectorField &	URef ()=0
	Access the velocity. More...

virtual tmp< surfaceScalarField >	phi () const =0
	Return the volumetric flux. More...

virtual surfaceScalarField &	phiRef ()=0
	Access the volumetric flux. More...

virtual tmp< surfaceScalarField >	alphaPhi () const =0
	Return the volumetric flux of the phase. More...

virtual surfaceScalarField &	alphaPhiRef ()=0
	Access the volumetric flux of the phase. More...

virtual tmp< surfaceScalarField >	alphaRhoPhi () const =0
	Return the mass flux of the phase. More...

virtual surfaceScalarField &	alphaRhoPhiRef ()=0
	Access the mass flux of the phase. More...

virtual tmp< volVectorField >	DUDt () const =0
	Return the substantive acceleration. More...

virtual tmp< surfaceScalarField >	DUDtf () const =0
	Return the substantive acceleration on the faces. More...

virtual tmp< volScalarField >	continuityError () const =0
	Return the continuity error. More...

virtual tmp< volScalarField >	continuityErrorFlow () const =0
	Return the continuity error due to the flow field. More...

virtual tmp< volScalarField >	continuityErrorSources () const =0
	Return the continuity error due to any sources. More...

virtual tmp< volScalarField >	K () const =0
	Return the phase kinetic energy. More...

virtual tmp< volScalarField >	mu () const =0
	Return the laminar dynamic viscosity. More...

virtual tmp< scalarField >	mu (const label patchi) const =0
	Return the laminar dynamic viscosity on a patch. More...

virtual tmp< volScalarField >	nu () const =0
	Return the laminar kinematic viscosity. More...

virtual tmp< scalarField >	nu (const label patchi) const =0
	Return the laminar kinematic viscosity on a patch. More...

virtual tmp< volScalarField >	alpha () const =0
	Thermal diffusivity for enthalpy of mixture [kg/m/s]. More...

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

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

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

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

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

virtual tmp< volScalarField >	kappaEff (const volScalarField &alphat) const =0
	Effective thermal turbulent diffusivity for temperature. More...

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

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

virtual tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const =0
	Effective thermal turbulent diffusivity of mixture. More...

virtual tmp< volScalarField >	mut () const =0
	Return the turbulent dynamic viscosity. More...

virtual tmp< volScalarField >	muEff () const =0
	Return the effective dynamic viscosity. More...

virtual tmp< volScalarField >	nut () const =0
	Return the turbulent kinematic viscosity. More...

virtual tmp< volScalarField >	nuEff () const =0
	Return the effective kinematic viscosity. More...

virtual tmp< volScalarField >	kappaEff () const =0
	Effective thermal turbulent diffusivity for temperature. More...

virtual tmp< scalarField >	kappaEff (const label patchi) const =0
	Effective thermal turbulent diffusivity for temperature. More...

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

virtual tmp< scalarField >	alphaEff (const label patchi) const =0
	Effective thermal turbulent diffusivity of mixture. More...

virtual tmp< volScalarField >	k () const =0
	Return the turbulent kinetic energy. More...

virtual tmp< volScalarField >	pPrime () const =0
	Return the phase-pressure'. More...

	phaseModel (const twoPhaseSystem &fluid, const dictionary &phaseProperties, const word &phaseName)

virtual	~phaseModel ()
	Destructor. More...

const word &	name () const
	Return the name of this phase. More...

const twoPhaseSystem &	fluid () const
	Return the twoPhaseSystem to which this phase belongs. More...

const phaseModel &	otherPhase () const
	Return the other phase in this two-phase system. More...

const dimensionedScalar &	residualAlpha () const
	Return the residual phase-fraction for given phase. More...

scalar	alphaMax () const
	Optional maximum phase-fraction (e.g. packing limit) More...

tmp< volScalarField >	d () const
	Return the Sauter-mean diameter. More...

const PhaseCompressibleTurbulenceModel< phaseModel > &	turbulence () const
	Return the turbulence model. More...

PhaseCompressibleTurbulenceModel< phaseModel > &	turbulence ()
	Return non-const access to the turbulence model. More...

const rhoThermo &	thermo () const
	Return the thermophysical model. More...

rhoThermo &	thermo ()
	Return non-const access to the thermophysical model. More...

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

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

tmp< volScalarField >	mu () const
	Return the laminar dynamic viscosity. More...

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

tmp< scalarField >	kappa (const label patchi) const
	Return the thermal conductivity on a patch. More...

tmp< volScalarField >	kappa () const
	Return the thermal conductivity. More...

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

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

tmp< volScalarField >	kappaEff (const volScalarField &alphat) const
	Return the laminar thermal conductivity. More...

tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const
	Return the laminar thermal conductivity on a patch. More...

tmp< volScalarField >	alpha () const
	Return the laminar thermal diffusivity for enthalpy. More...

tmp< scalarField >	alpha (const label patchi) const
	Return the laminar thermal diffusivity for enthalpy on a patch. More...

tmp< volScalarField >	alphaEff (const volScalarField &alphat) const
	Return the effective thermal diffusivity for enthalpy. More...

tmp< scalarField >	alphaEff (const scalarField &alphat, const label patchi) const
	Return the effective thermal diffusivity for enthalpy on a patch. More...

tmp< volScalarField >	Cp () const
	Return the specific heat capacity. More...

const volScalarField &	rho () const
	Return the density. More...

const volVectorField &	U () const
	Return the velocity. More...

volVectorField &	U ()
	Return non-const access to the velocity. More...

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

surfaceScalarField &	phi ()
	Return non-const access to the volumetric flux. More...

const surfaceScalarField &	alphaPhi () const
	Return the volumetric flux of the phase. More...

surfaceScalarField &	alphaPhi ()
	Return non-const access to the volumetric flux of the phase. More...

const surfaceScalarField &	alphaRhoPhi () const
	Return the mass flux of the phase. More...

surfaceScalarField &	alphaRhoPhi ()
	Return non-const access to the mass flux of the phase. More...

void	correctInflowOutflow (surfaceScalarField &alphaPhi) const
	Ensure that the flux at inflow/outflow BCs is preserved. More...

void	correct ()
	Correct the phase properties. More...

virtual bool	read (const dictionary &phaseProperties)
	Read phaseProperties dictionary. More...

virtual bool	read ()
	Dummy Read for transportModel. More...

	phaseModel (const word &phaseName, const volScalarField &p, const volScalarField &T)
	Construct from components. More...

autoPtr< phaseModel >	clone () const
	Return clone. More...

const word &	name () const

const word &	keyword () const

const rhoThermo &	thermo () const
	Return const-access to phase rhoThermo. More...

rhoThermo &	thermo ()
	Return access to phase rhoThermo. More...

const volScalarField &	dgdt () const
	Return const-access to phase divergence. More...

volScalarField &	dgdt ()
	Return access to phase divergence. More...

void	correct ()

Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensions and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions and patch types. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Construct given IOobject, mesh, dimensioned<Type> and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensioned<Type> and patch types. More...

	GeometricField (const IOobject &io, const Internal &diField, const PtrList< fvPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Copy construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Move construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const PtrList< fvPatchField< scalar >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

	GeometricField (const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Copy construct. More...

	GeometricField (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct from tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< scalar, fvPatchField, volMesh > &gf)
	Copy construct with a new name. More...

	GeometricField (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Construct with a new name from tmp<GeometricField> More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const labelList &patchIDs, const word &patchFieldType)

	GeometricField (const IOobject &io, const GeometricField< scalar, fvPatchField, volMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

tmp< GeometricField< scalar, fvPatchField, volMesh > >	clone () const
	Clone. More...

virtual	~GeometricField ()
	Destructor. More...

Internal &	ref (const bool updateAccessTime=true)
	Return a reference to the dimensioned internal field. More...

const Internal &	internalField () const
	Return a const-reference to the dimensioned internal field. More...

const Internal &	v () const

Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
	Return a reference to the internal field. More...

const Internal::FieldType &	primitiveField () const
	Return a const-reference to the internal field. More...

Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
	Return a reference to the boundary field. More...

const Boundary &	boundaryField () const
	Return const-reference to the boundary field. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return the time index of the field. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	storeOldTime () const
	Store the old-time field. More...

label	nOldTimes () const
	Return the number of old time fields stored. More...

const GeometricField< scalar, fvPatchField, volMesh > &	oldTime () const
	Return old time field. More...

GeometricField< scalar, fvPatchField, volMesh > &	oldTime ()
	Return non-const old time field. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

const GeometricField< scalar, fvPatchField, volMesh > &	prevIter () const
	Return previous iteration field. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

bool	needReference () const
	Does the field need a reference level for solution. More...

tmp< GeometricField< cmptType, fvPatchField, volMesh > >	component (const direction) const
	Return a component of the field. More...

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< scalar, fvPatchField, volMesh > >	T () const
	Return transpose (only if it is a tensor field) More...

void	relax (const scalar alpha)
	Relax field (for steady-state solution). More...

void	relax ()
	Relax field (for steady-state solution). More...

word	select (bool final) const
	Select the final iteration parameters if `final' is true. More...

void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...

void	negate ()
	Negate the field inplace. More...

void	replace (const direction d, const GeometricField< cmptType, fvPatchField, volMesh > &gcf)
	Replace specified field component with content from another field. More...

void	replace (const direction d, const dimensioned< cmptType > &ds)
	Replace specified field component with specified value. More...

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)

void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)

void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)

void	min (const dimensioned< scalar > &dt)
	Use the minimum of the field and specified value. More...

void	max (const dimensioned< scalar > &dt)
	Use the maximum of the field and specified value. More...

void	clip (const dimensioned< MinMax< scalar >> &range)
	Clip the field to be bounded within the specified range. More...

void	clip (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Clip the field to be bounded within the specified range. More...

void	maxMin (const dimensioned< scalar > &minVal, const dimensioned< scalar > &maxVal)
	Deprecated(2019-01) identical to clip() More...

const Internal &	operator() () const
	Return a const-reference to the dimensioned internal field. More...

void	operator= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator= (const dimensioned< scalar > &)

void	operator== (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator== (const dimensioned< scalar > &)

void	operator+= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator+= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator+= (const dimensioned< scalar > &)

void	operator-= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator-= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator-= (const dimensioned< scalar > &)

void	operator*= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator*= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator*= (const dimensioned< scalar > &)

void	operator/= (const GeometricField< scalar, fvPatchField, volMesh > &)

void	operator/= (const tmp< GeometricField< scalar, fvPatchField, volMesh >> &)

void	operator/= (const dimensioned< scalar > &)

Static Public Member Functions
static autoPtr< phaseModel >	New (const phaseSystem &fluid, const word &phaseName)

static autoPtr< phaseModel >	New (const phaseSystem &fluid, const word &phaseName, const label index)

Static Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
static const GeometricField< scalar, fvPatchField, volMesh > &	null ()
	Return a null geometric field. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
	Return tmp field from name, mesh, dimensions and patch type. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< scalar > &iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< scalar > &&iField, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const word &patchFieldType=fvPatchField< scalar >::calculatedType())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< scalar > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf)
	Return renamed tmp field. More...

static tmp< GeometricField< scalar, fvPatchField, volMesh > >	New (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Rename tmp field and reset patch field types and return. More...

Additional Inherited Members
Public Types inherited from GeometricField< scalar, fvPatchField, volMesh >
typedef volMesh ::Mesh	Mesh
	Type of mesh on which this GeometricField is instantiated. More...

typedef volMesh ::BoundaryMesh	BoundaryMesh

typedef DimensionedField< scalar, volMesh >	Internal
	Type of the internal field from which this GeometricField is derived. More...

typedef fvPatchField< scalar >	Patch

typedef Field< scalar >::cmptType	cmptType

Detailed Description

Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations.

Source files

Definition at line 54 of file phaseModel.H.

Constructor & Destructor Documentation

◆ phaseModel() [1/5]

phaseModel	(	const word &	phaseName,
		const dictionary &	phaseDict,
		const fvMesh &	mesh
	)

Definition at line 39 of file phaseModel.C.

References Foam::endl(), Foam::fvc::flux(), forAll, Foam::Info, mesh, and Foam::New().

Referenced by phaseModel::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~phaseModel() [1/4]

~phaseModel ( )

virtual

Destructor.

Definition at line 201 of file phaseModel.C.

◆ phaseModel() [2/5]

phaseModel	(	const phaseSystem &	fluid,
		const word &	phaseName
	)

Construct from phaseSystem and phaseName.

Definition at line 42 of file phaseModel.C.

◆ ~phaseModel() [2/4]

virtual ~phaseModel ( )

virtualdefault

Destructor.

◆ phaseModel() [3/5]

phaseModel	(	const phaseSystem &	fluid,
		const word &	phaseName,
		const label	index
	)

Definition at line 45 of file phaseModel.C.

References fluid, and Foam::New().

Here is the call graph for this function:

◆ ~phaseModel() [3/4]

virtual ~phaseModel ( )

virtual

Destructor.

◆ phaseModel() [4/5]

phaseModel	(	const twoPhaseSystem &	fluid,
		const dictionary &	phaseProperties,
		const word &	phaseName
	)

Definition at line 47 of file phaseModel.C.

References Foam::endl(), Foam::fvc::flux(), forAll, Foam::Info, Foam::New(), and phi.

Here is the call graph for this function:

◆ ~phaseModel() [4/4]

virtual ~phaseModel ( )

virtual

Destructor.

◆ phaseModel() [5/5]

phaseModel	(	const word &	phaseName,
		const volScalarField &	p,
		const volScalarField &	T
	)

Construct from components.

Member Function Documentation

◆ clone() [1/3]

Foam::autoPtr< Foam::phaseModel > clone ( ) const

Return clone.

Definition at line 207 of file phaseModel.C.

References NotImplemented.

◆ name() [1/5]

const Foam::word & name ( ) const

inline

Definition at line 140 of file phaseModel.H.

Here is the caller graph for this function:

◆ keyword() [1/3]

const Foam::word & keyword ( ) const

inline

Definition at line 145 of file phaseModel.H.

References phaseModel::name().

Here is the call graph for this function:

◆ d() [1/3]

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

Definition at line 257 of file phaseModel.C.

Referenced by deposition::dmdt(), sine::limiter(), linear::limiter(), and cosine::limiter().

Here is the caller graph for this function:

◆ nu() [1/7]

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

inline

Definition at line 152 of file phaseModel.H.

Referenced by LuoSvendsen::correct().

Here is the caller graph for this function:

◆ kappa() [1/7]

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

inline

Definition at line 157 of file phaseModel.H.

Referenced by Bromley::htcFilmBoil().

Here is the caller graph for this function:

◆ Cp() [1/4]

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

inline

Definition at line 162 of file phaseModel.H.

◆ rho() [1/5]

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

inline

Definition at line 167 of file phaseModel.H.

Referenced by LehrMilliesMewes::addToBinaryBreakupRate(), LuoSvendsen::addToBinaryBreakupRate(), CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), Luo::addToCoalescenceRate(), PrinceBlanch::addToCoalescenceRate(), densityChangeDrift::addToDriftRate(), phaseChange::addToDriftRate(), multiphaseSystem::Cvm(), deposition::dmdt(), liftModel::Fi(), kineticGasEvaporation< Thermo, OtherThermo >::Kexp(), interfaceOxideRate< Thermo, OtherThermo >::Kexp(), virtualMassModel::Ki(), phasePair::rho(), LaakkonenAlopaeusAittamaa::setBreakupRate(), and multiphaseSystem::Svm().

Here is the caller graph for this function:

◆ U() [1/6]

const volVectorField& U ( ) const

inline

Definition at line 172 of file phaseModel.H.

Referenced by LehrMilliesMewesCoalescence::addToCoalescenceRate(), constant::d(), isothermal::d(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), deposition::dmdt(), multiphaseSystem::dragCoeffs(), phaseForces::execute(), liftModel::Fi(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), and dummy::R().

Here is the caller graph for this function:

◆ U() [2/6]

volVectorField& U ( )

inline

Definition at line 177 of file phaseModel.H.

◆ DDtU() [1/2]

const volVectorField& DDtU ( ) const

inline

Definition at line 182 of file phaseModel.H.

Referenced by multiphaseSystem::Svm().

Here is the caller graph for this function:

◆ DDtU() [2/2]

volVectorField& DDtU ( )

inline

Definition at line 187 of file phaseModel.H.

◆ phi() [1/7]

const surfaceScalarField& phi ( ) const

inline

Definition at line 192 of file phaseModel.H.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), and multiphaseSystem::dragCoeffs().

Here is the caller graph for this function:

◆ phi() [2/7]

surfaceScalarField& phi ( )

inline

Definition at line 197 of file phaseModel.H.

◆ alphaPhi() [1/7]

const surfaceScalarField& alphaPhi ( ) const

inline

Definition at line 202 of file phaseModel.H.

◆ alphaPhi() [2/7]

surfaceScalarField& alphaPhi ( )

inline

Definition at line 207 of file phaseModel.H.

◆ correctInflowOutflow() [1/3]

void correctInflowOutflow ( surfaceScalarField & alphaPhi ) const

Ensure that the flux at inflow/outflow BCs is preserved.

Definition at line 239 of file phaseModel.C.

References alphaPhi(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvsPatchField< Type >::coupled(), forAll, and phi.

Here is the call graph for this function:

◆ correct() [1/5]

void correct ( )

Correct the phase properties.

Definition at line 215 of file phaseModel.C.

◆ read() [1/5]

bool read ( const dictionary & phaseDict )

Read base transportProperties dictionary.

Definition at line 221 of file phaseModel.C.

References dictionary::readEntry().

Here is the call graph for this function:

◆ ClassName() [1/2]

ClassName ( "phaseModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [1/2]

declareRunTimeSelectionTable	(	autoPtr	,
		phaseModel	,
		phaseSystem	,
		(const phaseSystem &fluid, const word &phaseName)	,
		(fluid, phaseName)
	)

◆ New() [1/2]

Foam::autoPtr< Foam::phaseModel > New	(	const phaseSystem &	fluid,
		const word &	phaseName
	)

static

Definition at line 69 of file phaseModel.C.

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

Referenced by phaseSystem::generatePhaseModels(), and phaseModel::iNew::operator()().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ name() [2/5]

const word& name ( ) const

inline

The name of this phase.

Definition at line 112 of file phaseModel.H.

◆ fluid() [1/3]

const Foam::phaseSystem & fluid ( ) const

Return the system to which this phase belongs.

Definition at line 100 of file phaseModel.C.

Referenced by deposition::dmdt(), orderedPhasePair::E(), IATEsource::fluid(), and phasePair::sigma().

Here is the caller graph for this function:

◆ correct() [2/5]

virtual void correct ( )

virtual

Correct phase thermo.

◆ correctTurbulence() [1/2]

void correctTurbulence ( )

virtual

Correct the turbulence.

Definition at line 112 of file phaseModel.C.

◆ solveYi()

virtual void solveYi	(	PtrList< volScalarField::Internal > &	Su,
		PtrList< volScalarField::Internal > &	Sp
	)

pure virtual

Solve species fraction equation.

◆ read() [2/5]

bool read ( )

virtual

Read phase properties dictionary.

Definition at line 321 of file phaseModel.C.

◆ thermo() [1/7]

virtual const rhoThermo& thermo ( ) const

pure virtual

Access const to phase thermo.

Referenced by Zuber::CHF(), Tatsumoto::CHFSubCool(), HuaXu::CHFSubCool(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), KocamustafaogullariIshii::dDeparture(), phaseModel::dpdt(), Cole::fDeparture(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), BreenWestwater::htcFilmBoil(), Bromley::htcFilmBoil(), Jeschar::MHF(), interfaceCompositionModel::New(), and Kutadeladze::qNucleate().

Here is the caller graph for this function:

◆ thermo() [2/7]

virtual rhoThermo& thermo ( )

pure virtual

Access to phase thermo.

◆ rho() [2/5]

tmp<volScalarField> rho ( ) const

Return the phase density.

◆ rho() [3/5]

Foam::tmp< Foam::scalarField > rho ( const label patchi ) const

Return phase density on a patch.

Definition at line 124 of file phaseModel.C.

References psiThermo::rho(), and thermo.

Here is the call graph for this function:

◆ hc()

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

Chemical enthalpy for phase [J/kg].

Definition at line 130 of file phaseModel.C.

References basicThermo::hc(), and thermo.

Here is the call graph for this function:

◆ Cp() [2/4]

tmp<volScalarField> Cp ( ) const

Return phase Cp.

◆ Cp() [3/4]

Foam::tmp< Foam::scalarField > Cp	(	const scalarField &	p,
		const scalarField &	T,
		const label	patchi
	)		const

Heat capacity of the phase at constant pressure for patch.

[J/kg/K]

Definition at line 143 of file phaseModel.C.

References Cp, p, Foam::T(), and thermo.

Here is the call graph for this function:

◆ Cv() [1/2]

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

Return Cv of the phase.

Definition at line 153 of file phaseModel.C.

References basicThermo::Cv(), and thermo.

Here is the call graph for this function:

◆ Cv() [2/2]

Foam::tmp< Foam::scalarField > Cv	(	const scalarField &	p,
		const scalarField &	T,
		const label	patchI
	)		const

Heat capacity at constant volume for phase for a patch [J/kg/K].

Definition at line 160 of file phaseModel.C.

References basicThermo::Cv(), p, Foam::T(), and thermo.

Here is the call graph for this function:

◆ gamma() [1/2]

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

Gamma = Cp/Cv of phase[].

Definition at line 170 of file phaseModel.C.

References basicThermo::gamma(), and thermo.

Here is the call graph for this function:

◆ gamma() [2/2]

Foam::tmp< Foam::scalarField > gamma	(	const scalarField &	p,
		const scalarField &	T,
		const label	patchi
	)		const

Gamma = Cp/Cv for phase on patch [].

Definition at line 177 of file phaseModel.C.

References basicThermo::gamma(), p, Foam::T(), and thermo.

Here is the call graph for this function:

◆ Cpv() [1/2]

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

Heat capacity at constant pressure/volume for phase [J/kg/K].

Definition at line 187 of file phaseModel.C.

References basicThermo::Cpv(), and thermo.

Here is the call graph for this function:

◆ Cpv() [2/2]

Foam::tmp< Foam::scalarField > Cpv	(	const scalarField &	p,
		const scalarField &	T,
		const label	patchi
	)		const

Heat capacity at constant pressure/volume for phase at patch.

[J/kg/K]

Definition at line 194 of file phaseModel.C.

References basicThermo::Cpv(), p, Foam::T(), and thermo.

Here is the call graph for this function:

◆ CpByCpv() [1/2]

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

Heat capacity ratio for phase [].

Definition at line 204 of file phaseModel.C.

References basicThermo::CpByCpv(), and thermo.

Here is the call graph for this function:

◆ CpByCpv() [2/2]

Foam::tmp< Foam::scalarField > CpByCpv	(	const scalarField &	p,
		const scalarField &	T,
		const label	patchi
	)		const

Heat capacity ratio for phase at patch [].

Definition at line 211 of file phaseModel.C.

References basicThermo::CpByCpv(), p, Foam::T(), and thermo.

Here is the call graph for this function:

◆ dpdt()

bool dpdt ( ) const

inline

Query thermo for dpdt.

Definition at line 212 of file phaseModel.H.

References basicThermo::dpdt(), and phaseModel::thermo().

Here is the call graph for this function:

◆ alpha() [1/6]

const Foam::volScalarField & alpha ( ) const

Thermal diffusivity for enthalpy of mixture [kg/m/s].

Definition at line 221 of file phaseModel.C.

References basicThermo::alpha(), and thermo.

Here is the call graph for this function:

◆ alpha() [2/6]

const Foam::scalarField & alpha ( const label patchi ) const

Thermal diffusivity for enthalpy of mixture for patch [kg/m/s].

Definition at line 227 of file phaseModel.C.

References basicThermo::alpha(), and thermo.

Here is the call graph for this function:

◆ kappa() [2/7]

tmp<volScalarField> kappa ( ) const

Thermal diffusivity for temperature of phase [J/m/s/K].

◆ kappa() [3/7]

Foam::tmp< Foam::scalarField > kappa ( const label patchi ) const

Thermal diffusivity for temperature of phase for patch [J/m/s/K].

Definition at line 239 of file phaseModel.C.

References basicThermo::kappa(), and thermo.

Here is the call graph for this function:

◆ alphahe() [1/6]

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

Thermal diffusivity for energy of mixture [kg/m/s].

Definition at line 245 of file phaseModel.C.

References basicThermo::alphahe(), and thermo.

Here is the call graph for this function:

◆ alphahe() [2/6]

Foam::tmp< Foam::scalarField > alphahe ( const label patchi ) const

Thermal diffusivity for energy of mixture for patch [kg/m/s].

Definition at line 251 of file phaseModel.C.

References basicThermo::alphahe(), and thermo.

Here is the call graph for this function:

◆ kappaEff() [1/8]

Foam::tmp< Foam::volScalarField > kappaEff ( const volScalarField & kappat ) const

Effective thermal diffusivity for temperature of phase [J/m/s/K].

Definition at line 258 of file phaseModel.C.

References Foam::constant::electromagnetic::kappa, and kappaEff.

◆ kappaEff() [2/8]

Foam::tmp< Foam::scalarField > kappaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

Effective thermal diffusivity for temperature.

of phase for patch [J/m/s/K]

Definition at line 269 of file phaseModel.C.

References Foam::constant::electromagnetic::kappa.

◆ alphaEff() [1/8]

Foam::tmp< Foam::volScalarField > alphaEff ( const volScalarField & alphat ) const

Effective thermal diffusivity of phase [kg/m/s].

Definition at line 279 of file phaseModel.C.

References Foam::constant::atomic::alpha, and thermo.

◆ alphaEff() [2/8]

Foam::tmp< Foam::scalarField > alphaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

Effective thermal diffusivity of phase for patch [kg/m/s].

Definition at line 288 of file phaseModel.C.

References Foam::constant::atomic::alpha, and thermo.

◆ nu() [2/7]

virtual tmp<volScalarField> nu ( ) const

virtual

Return the mixture kinematic viscosity.

◆ nu() [3/7]

Foam::tmp< Foam::scalarField > nu ( const label patchi ) const

virtual

Return the mixture kinematic viscosity on patchi.

Definition at line 315 of file phaseModel.C.

References fluidThermo::nu(), and thermo.

Here is the call graph for this function:

◆ mu() [1/6]

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

virtual

Return the mixture dymanic viscosity.

Definition at line 297 of file phaseModel.C.

References psiThermo::mu(), and thermo.

Referenced by CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), Bromley::htcFilmBoil(), and LaakkonenAlopaeusAittamaa::setBreakupRate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ mu() [2/6]

Foam::tmp< Foam::scalarField > mu ( const label patchi ) const

virtual

Return the mixture dymanic viscosity on patchi.

Definition at line 303 of file phaseModel.C.

References psiThermo::mu(), and thermo.

Here is the call graph for this function:

◆ diffNo()

virtual tmp<surfaceScalarField> diffNo ( ) const

pure virtual

Diffusion number.

◆ Y() [1/4]

virtual const PtrList<volScalarField>& Y ( ) const

pure virtual

Constant access the species mass fractions.

◆ Y() [2/4]

virtual PtrList<volScalarField>& Y ( )

pure virtual

Access the species mass fractions.

◆ phi() [3/7]

virtual tmp<surfaceScalarField> phi ( ) const

pure virtual

Constant access the volumetric flux.

◆ phi() [4/7]

virtual const surfaceScalarField& phi ( )

pure virtual

Access the volumetric flux.

◆ alphaPhi() [3/7]

virtual tmp<surfaceScalarField> alphaPhi ( ) const

pure virtual

Constant access the volumetric flux of the phase.

◆ alphaPhi() [4/7]

virtual surfaceScalarField& alphaPhi ( )

pure virtual

Access the volumetric flux of the phase.

◆ U() [3/6]

virtual tmp<volVectorField> U ( ) const

pure virtual

Access const reference to U.

◆ ClassName() [2/2]

ClassName ( "phaseModel" )

Runtime type information.

◆ declareRunTimeSelectionTable() [2/2]

declareRunTimeSelectionTable	(	autoPtr	,
		phaseModel	,
		phaseSystem	,
		(const phaseSystem &fluid, const word &phaseName, const label index)	,
		(fluid, phaseName, index)
	)

◆ clone() [2/3]

autoPtr<phaseModel> clone ( ) const

Return clone.

◆ New() [2/2]

Foam::autoPtr< Foam::phaseModel > New	(	const phaseSystem &	fluid,
		const word &	phaseName,
		const label	index
	)

static

Definition at line 92 of file phaseModel.C.

References Foam::abort(), dict, Foam::endl(), Foam::FatalIOError, FatalIOErrorInLookup, fluid, dictionary::get(), Foam::Info, and dictionary::subDict().

Here is the call graph for this function:

◆ name() [3/5]

const word& name ( ) const

Return the name of this phase.

◆ keyword() [2/3]

const word& keyword ( ) const

Return the name of the phase for use as the keyword in PtrDictionary.

◆ index()

Foam::label index ( ) const

Return the index of the phase.

Definition at line 142 of file phaseModel.C.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), MomentumTransferPhaseSystem< BasePhaseSystem >::partialElimination(), and MomentumTransferPhaseSystem< BasePhaseSystem >::partialEliminationf().

Here is the caller graph for this function:

◆ fluid() [2/3]

const phaseSystem& fluid ( ) const

Return the system to which this phase belongs.

◆ residualAlpha() [1/2]

const Foam::dimensionedScalar & residualAlpha ( ) const

Return the residual phase-fraction for given phase.

Used to stabilize the phase momentum as the phase-fraction -> 0

Definition at line 154 of file phaseModel.C.

Referenced by LehrMilliesMewesCoalescence::addToCoalescenceRate().

Here is the caller graph for this function:

◆ alphaMax() [1/2]

Foam::scalar alphaMax ( ) const

Return the maximum phase-fraction (e.g. packing limit)

Definition at line 160 of file phaseModel.C.

◆ d() [2/3]

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

◆ dPtr()

const Foam::autoPtr< Foam::diameterModel > & dPtr ( ) const

Return const-reference to diameterModel of the phase.

Definition at line 172 of file phaseModel.C.

◆ correct() [3/5]

virtual void correct ( )

virtual

Correct the phase properties.

◆ correctKinematics()

void correctKinematics ( )

virtual

Correct the kinematics.

Definition at line 184 of file phaseModel.C.

◆ correctThermo()

void correctThermo ( )

virtual

Correct the thermodynamics.

Definition at line 188 of file phaseModel.C.

◆ correctTurbulence() [2/2]

virtual void correctTurbulence ( )

virtual

Correct the turbulence.

◆ correctEnergyTransport()

void correctEnergyTransport ( )

virtual

Correct the energy transport.

Definition at line 196 of file phaseModel.C.

◆ correctInflowOutflow() [2/3]

void correctInflowOutflow ( surfaceScalarField & alphaPhi ) const

Ensure that the flux at inflow/outflow BCs is preserved.

◆ read() [3/5]

virtual bool read ( )

virtual

Read phase properties dictionary.

◆ compressible()

virtual bool compressible ( ) const

pure virtual

Return true if the phase is compressible otherwise false.

◆ divU() [1/2]

virtual tmp<volScalarField> divU ( ) const

pure virtual

Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

◆ divU() [2/2]

virtual void divU ( tmp< volScalarField > divU )

pure virtual

Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

◆ isothermal()

virtual bool isothermal ( ) const

pure virtual

Return whether the phase is isothermal.

◆ heEqn()

virtual tmp<fvScalarMatrix> heEqn ( )

pure virtual

Return the enthalpy equation.

◆ thermo() [3/7]

virtual const rhoThermo& thermo ( ) const

pure virtual

Return the thermophysical model.

◆ thermoRef()

virtual rhoThermo& thermoRef ( )

pure virtual

Access the thermophysical model.

◆ rho() [4/5]

virtual tmp<volScalarField> rho ( ) const

pure virtual

Return the density field.

◆ pure()

virtual bool pure ( ) const

pure virtual

Return whether the phase is pure (i.e., not multi-component)

◆ YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField & Yi )

pure virtual

Return the species fraction equation.

◆ Y() [3/4]

virtual const PtrList<volScalarField>& Y ( ) const

pure virtual

Return the species mass fractions.

◆ Y() [4/4]

virtual const volScalarField& Y ( const word & name ) const

pure virtual

Return a species mass fraction by name.

◆ YRef()

virtual PtrList<volScalarField>& YRef ( )

pure virtual

Access the species mass fractions.

◆ YActive()

virtual const UPtrList<volScalarField>& YActive ( ) const

pure virtual

Return the active species mass fractions.

◆ YActiveRef()

virtual UPtrList<volScalarField>& YActiveRef ( )

pure virtual

Access the active species mass fractions.

◆ stationary()

virtual bool stationary ( ) const

pure virtual

Return whether the phase is stationary.

◆ UEqn()

virtual tmp<fvVectorMatrix> UEqn ( )

pure virtual

Return the momentum equation.

◆ UfEqn()

virtual tmp<fvVectorMatrix> UfEqn ( )

pure virtual

Return the momentum equation for the face-based algorithm.

◆ U() [4/6]

virtual tmp<volVectorField> U ( ) const

pure virtual

Return the velocity.

◆ URef()

virtual volVectorField& URef ( )

pure virtual

Access the velocity.

◆ phi() [5/7]

virtual tmp<surfaceScalarField> phi ( ) const

pure virtual

Return the volumetric flux.

◆ phiRef()

virtual surfaceScalarField& phiRef ( )

pure virtual

Access the volumetric flux.

◆ alphaPhi() [5/7]

virtual tmp<surfaceScalarField> alphaPhi ( ) const

pure virtual

Return the volumetric flux of the phase.

◆ alphaPhiRef()

virtual surfaceScalarField& alphaPhiRef ( )

pure virtual

Access the volumetric flux of the phase.

◆ alphaRhoPhi() [1/3]

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const

pure virtual

Return the mass flux of the phase.

◆ alphaRhoPhiRef()

virtual surfaceScalarField& alphaRhoPhiRef ( )

pure virtual

Access the mass flux of the phase.

◆ DUDt()

virtual tmp<volVectorField> DUDt ( ) const

pure virtual

Return the substantive acceleration.

Referenced by phaseForces::execute(), and MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer().

Here is the caller graph for this function:

◆ DUDtf()

virtual tmp<surfaceScalarField> DUDtf ( ) const

pure virtual

Return the substantive acceleration on the faces.

◆ continuityError()

virtual tmp<volScalarField> continuityError ( ) const

pure virtual

Return the continuity error.

◆ continuityErrorFlow()

virtual tmp<volScalarField> continuityErrorFlow ( ) const

pure virtual

Return the continuity error due to the flow field.

◆ continuityErrorSources()

virtual tmp<volScalarField> continuityErrorSources ( ) const

pure virtual

Return the continuity error due to any sources.

◆ K()

virtual tmp<volScalarField> K ( ) const

pure virtual

Return the phase kinetic energy.

◆ mu() [3/6]

virtual tmp<volScalarField> mu ( ) const

pure virtual

Return the laminar dynamic viscosity.

◆ mu() [4/6]

virtual tmp<scalarField> mu ( const label patchi ) const

pure virtual

Return the laminar dynamic viscosity on a patch.

◆ nu() [4/7]

virtual tmp<volScalarField> nu ( ) const

pure virtual

Return the laminar kinematic viscosity.

◆ nu() [5/7]

virtual tmp<scalarField> nu ( const label patchi ) const

pure virtual

Return the laminar kinematic viscosity on a patch.

◆ alpha() [3/6]

virtual tmp<volScalarField> alpha ( ) const

pure virtual

Thermal diffusivity for enthalpy of mixture [kg/m/s].

◆ alpha() [4/6]

virtual tmp<scalarField> alpha ( const label patchi ) const

pure virtual

Thermal diffusivity for enthalpy of mixture for patch [kg/m/s].

◆ kappa() [4/7]

virtual tmp<volScalarField> kappa ( ) const

pure virtual

Thermal diffusivity for temperature of mixture [J/m/s/K].

◆ kappa() [5/7]

virtual tmp<scalarField> kappa ( const label patchi ) const

pure virtual

Thermal diffusivity for temperature of mixture.

for patch [J/m/s/K]

◆ alphahe() [3/6]

virtual tmp<volScalarField> alphahe ( ) const

pure virtual

Thermal diffusivity for energy of mixture [kg/m/s].

◆ alphahe() [4/6]

virtual tmp<scalarField> alphahe ( const label patchi ) const

pure virtual

Thermal diffusivity for energy of mixture for patch [kg/m/s].

◆ kappaEff() [3/8]

virtual tmp<volScalarField> kappaEff ( const volScalarField & alphat ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture [J/m/s/K]

◆ kappaEff() [4/8]

virtual tmp<scalarField> kappaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture for patch [J/m/s/K]

◆ alphaEff() [3/8]

virtual tmp<volScalarField> alphaEff ( const volScalarField & alphat ) const

pure virtual

Effective thermal turbulent diffusivity of mixture [kg/m/s].

◆ alphaEff() [4/8]

virtual tmp<scalarField> alphaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

pure virtual

Effective thermal turbulent diffusivity of mixture.

for patch [kg/m/s]

◆ mut()

virtual tmp<volScalarField> mut ( ) const

pure virtual

Return the turbulent dynamic viscosity.

◆ muEff()

virtual tmp<volScalarField> muEff ( ) const

pure virtual

Return the effective dynamic viscosity.

◆ nut()

virtual tmp<volScalarField> nut ( ) const

pure virtual

Return the turbulent kinematic viscosity.

◆ nuEff()

virtual tmp<volScalarField> nuEff ( ) const

pure virtual

Return the effective kinematic viscosity.

◆ kappaEff() [5/8]

virtual tmp<volScalarField> kappaEff ( ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture [J/m/s/K]

◆ kappaEff() [6/8]

virtual tmp<scalarField> kappaEff ( const label patchi ) const

pure virtual

Effective thermal turbulent diffusivity for temperature.

of mixture for patch [J/m/s/K]

◆ alphaEff() [5/8]

virtual tmp<volScalarField> alphaEff ( ) const

pure virtual

Effective thermal turbulent diffusivity of mixture [kg/m/s].

◆ alphaEff() [6/8]

virtual tmp<scalarField> alphaEff ( const label patchi ) const

pure virtual

Effective thermal turbulent diffusivity of mixture.

for patch [kg/m/s]

◆ k()

virtual tmp<volScalarField> k ( ) const

pure virtual

Return the turbulent kinetic energy.

◆ pPrime()

virtual tmp<volScalarField> pPrime ( ) const

pure virtual

Return the phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

◆ name() [4/5]

const word& name ( ) const

inline

Return the name of this phase.

Definition at line 123 of file phaseModel.H.

◆ fluid() [3/3]

const twoPhaseSystem& fluid ( ) const

inline

Return the twoPhaseSystem to which this phase belongs.

Definition at line 129 of file phaseModel.H.

◆ otherPhase()

const Foam::phaseModel & otherPhase ( ) const

Return the other phase in this two-phase system.

Definition at line 218 of file phaseModel.C.

References phaseModel::otherPhase().

Referenced by ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrByAs(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::iDmdt(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), phaseModel::otherPhase(), and IATEsource::otherPhase().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ residualAlpha() [2/2]

const dimensionedScalar& residualAlpha ( ) const

inline

Return the residual phase-fraction for given phase.

Used to stabilize the phase momentum as the phase-fraction -> 0

Definition at line 139 of file phaseModel.H.

◆ alphaMax() [2/2]

scalar alphaMax ( ) const

inline

Optional maximum phase-fraction (e.g. packing limit)

Defaults to 1

Definition at line 146 of file phaseModel.H.

◆ d() [3/3]

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

◆ turbulence() [1/2]

const Foam::PhaseCompressibleTurbulenceModel< Foam::phaseModel > & turbulence ( ) const

Return the turbulence model.

Definition at line 238 of file phaseModel.C.

◆ turbulence() [2/2]

Foam::PhaseCompressibleTurbulenceModel< Foam::phaseModel > & turbulence ( )

Return non-const access to the turbulence model.

for correction

Definition at line 231 of file phaseModel.C.

◆ thermo() [4/7]

const rhoThermo& thermo ( ) const

inline

Return the thermophysical model.

Definition at line 164 of file phaseModel.H.

◆ thermo() [5/7]

rhoThermo& thermo ( )

inline

Return non-const access to the thermophysical model.

for correction

Definition at line 171 of file phaseModel.H.

◆ nu() [6/7]

tmp<volScalarField> nu ( ) const

inline

Return the laminar viscosity.

Definition at line 177 of file phaseModel.H.

◆ nu() [7/7]

tmp<scalarField> nu ( const label patchi ) const

inline

Return the laminar viscosity for patch.

Definition at line 183 of file phaseModel.H.

◆ mu() [5/6]

tmp<volScalarField> mu ( ) const

inline

Return the laminar dynamic viscosity.

Definition at line 189 of file phaseModel.H.

◆ mu() [6/6]

tmp<scalarField> mu ( const label patchi ) const

inline

Return the laminar dynamic viscosity for patch.

Definition at line 195 of file phaseModel.H.

◆ kappa() [6/7]

tmp<scalarField> kappa ( const label patchi ) const

inline

Return the thermal conductivity on a patch.

Definition at line 201 of file phaseModel.H.

◆ kappa() [7/7]

tmp<volScalarField> kappa ( ) const

inline

Return the thermal conductivity.

Definition at line 207 of file phaseModel.H.

◆ alphahe() [5/6]

tmp<volScalarField> alphahe ( ) const

inline

Thermal diffusivity for energy of mixture [kg/m/s].

Definition at line 213 of file phaseModel.H.

◆ alphahe() [6/6]

tmp<scalarField> alphahe ( const label patchi ) const

inline

Thermal diffusivity for energy of mixture for patch [kg/m/s].

Definition at line 219 of file phaseModel.H.

◆ kappaEff() [7/8]

tmp<volScalarField> kappaEff ( const volScalarField & alphat ) const

inline

Return the laminar thermal conductivity.

Definition at line 226 of file phaseModel.H.

◆ kappaEff() [8/8]

tmp<scalarField> kappaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

inline

Return the laminar thermal conductivity on a patch.

Definition at line 235 of file phaseModel.H.

◆ alpha() [5/6]

tmp<volScalarField> alpha ( ) const

inline

Return the laminar thermal diffusivity for enthalpy.

Definition at line 244 of file phaseModel.H.

◆ alpha() [6/6]

tmp<scalarField> alpha ( const label patchi ) const

inline

Return the laminar thermal diffusivity for enthalpy on a patch.

Definition at line 250 of file phaseModel.H.

◆ alphaEff() [7/8]

tmp<volScalarField> alphaEff ( const volScalarField & alphat ) const

inline

Return the effective thermal diffusivity for enthalpy.

Definition at line 257 of file phaseModel.H.

◆ alphaEff() [8/8]

tmp<scalarField> alphaEff	(	const scalarField &	alphat,
		const label	patchi
	)		const

inline

Return the effective thermal diffusivity for enthalpy on a patch.

Definition at line 266 of file phaseModel.H.

◆ Cp() [4/4]

tmp<volScalarField> Cp ( ) const

inline

Return the specific heat capacity.

Definition at line 275 of file phaseModel.H.

◆ rho() [5/5]

const volScalarField& rho ( ) const

inline

Return the density.

Definition at line 281 of file phaseModel.H.

◆ U() [5/6]

const volVectorField& U ( ) const

inline

Return the velocity.

Definition at line 287 of file phaseModel.H.

◆ U() [6/6]

volVectorField& U ( )

inline

Return non-const access to the velocity.

Used in the momentum equation

Definition at line 294 of file phaseModel.H.

◆ phi() [6/7]

const surfaceScalarField& phi ( ) const

inline

Return the volumetric flux.

Definition at line 300 of file phaseModel.H.

◆ phi() [7/7]

surfaceScalarField& phi ( )

inline

Return non-const access to the volumetric flux.

Definition at line 306 of file phaseModel.H.

◆ alphaPhi() [6/7]

const surfaceScalarField& alphaPhi ( ) const

inline

Return the volumetric flux of the phase.

Definition at line 312 of file phaseModel.H.

◆ alphaPhi() [7/7]

surfaceScalarField& alphaPhi ( )

inline

Return non-const access to the volumetric flux of the phase.

Definition at line 318 of file phaseModel.H.

◆ alphaRhoPhi() [2/3]

const surfaceScalarField& alphaRhoPhi ( ) const

inline

Return the mass flux of the phase.

Definition at line 324 of file phaseModel.H.

◆ alphaRhoPhi() [3/3]

surfaceScalarField& alphaRhoPhi ( )

inline

Return non-const access to the mass flux of the phase.

Definition at line 330 of file phaseModel.H.

◆ correctInflowOutflow() [3/3]

void correctInflowOutflow ( surfaceScalarField & alphaPhi ) const

Ensure that the flux at inflow/outflow BCs is preserved.

◆ correct() [4/5]

void correct ( )

Correct the phase properties.

other than the thermodynamics and turbulence which have special treatment

◆ read() [4/5]

virtual bool read ( const dictionary & phaseProperties )

virtual

Read phaseProperties dictionary.

◆ read() [5/5]

virtual bool read ( )

inlinevirtual

Dummy Read for transportModel.

Definition at line 347 of file phaseModel.H.

◆ clone() [3/3]

autoPtr<phaseModel> clone ( ) const

Return clone.

◆ name() [5/5]

const word& name ( ) const

inline

Definition at line 109 of file phaseModel.H.

◆ keyword() [3/3]

const word& keyword ( ) const

inline

Definition at line 114 of file phaseModel.H.

References phaseModel::name().

Here is the call graph for this function:

◆ thermo() [6/7]

const rhoThermo& thermo ( ) const

inline

Return const-access to phase rhoThermo.

Definition at line 120 of file phaseModel.H.

◆ thermo() [7/7]

rhoThermo& thermo ( )

inline

Return access to phase rhoThermo.

Definition at line 126 of file phaseModel.H.

◆ dgdt() [1/2]

const volScalarField& dgdt ( ) const

inline

Return const-access to phase divergence.

Definition at line 132 of file phaseModel.H.

◆ dgdt() [2/2]

volScalarField& dgdt ( )

inline

Return access to phase divergence.

Definition at line 138 of file phaseModel.H.

◆ correct() [5/5]

void correct ( )

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

src/phaseSystemModels/multiphaseEuler/multiphaseSystem/phaseModel/phaseModel.H
src/phaseSystemModels/multiphaseEuler/multiphaseSystem/phaseModel/phaseModel.C

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseModel() [1/5]

◆ ~phaseModel() [1/4]

◆ phaseModel() [2/5]

◆ ~phaseModel() [2/4]

◆ phaseModel() [3/5]

◆ ~phaseModel() [3/4]

◆ phaseModel() [4/5]

◆ ~phaseModel() [4/4]

◆ phaseModel() [5/5]

Member Function Documentation

◆ clone() [1/3]

◆ name() [1/5]

◆ keyword() [1/3]

◆ d() [1/3]

◆ nu() [1/7]

◆ kappa() [1/7]

◆ Cp() [1/4]

◆ rho() [1/5]

◆ U() [1/6]

◆ U() [2/6]

◆ DDtU() [1/2]

◆ DDtU() [2/2]

◆ phi() [1/7]

◆ phi() [2/7]

◆ alphaPhi() [1/7]

◆ alphaPhi() [2/7]

◆ correctInflowOutflow() [1/3]

◆ correct() [1/5]

◆ read() [1/5]

◆ ClassName() [1/2]

◆ declareRunTimeSelectionTable() [1/2]

◆ New() [1/2]

◆ name() [2/5]

◆ fluid() [1/3]

◆ correct() [2/5]

◆ correctTurbulence() [1/2]

◆ solveYi()

◆ read() [2/5]

◆ thermo() [1/7]

◆ thermo() [2/7]

◆ rho() [2/5]

◆ rho() [3/5]

◆ hc()

◆ Cp() [2/4]

◆ Cp() [3/4]

◆ Cv() [1/2]

◆ Cv() [2/2]

◆ gamma() [1/2]

◆ gamma() [2/2]

◆ Cpv() [1/2]

◆ Cpv() [2/2]

◆ CpByCpv() [1/2]

◆ CpByCpv() [2/2]

◆ dpdt()

◆ alpha() [1/6]

◆ alpha() [2/6]

◆ kappa() [2/7]

◆ kappa() [3/7]

◆ alphahe() [1/6]

◆ alphahe() [2/6]

◆ kappaEff() [1/8]

◆ kappaEff() [2/8]

◆ alphaEff() [1/8]

◆ alphaEff() [2/8]

◆ nu() [2/7]

◆ nu() [3/7]

◆ mu() [1/6]

◆ mu() [2/6]

◆ diffNo()

◆ Y() [1/4]

◆ Y() [2/4]

◆ phi() [3/7]

◆ phi() [4/7]

◆ alphaPhi() [3/7]