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]

Data Structures
class	iNew
	Return a pointer to a new phaseModel created on freestore. More...

Public Member Functions
	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 ()

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

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 e.g. alphat. More...

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

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

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

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

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

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

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

virtual const volScalarField &	K () const
	Return the phase kinetic energy. More...

virtual const surfaceScalarField &	DbyA () const
	Return the phase diffusivity divided by the momentum coefficient. More...

virtual void	DbyA (const tmp< surfaceScalarField > &DbyA)
	Set the phase diffusivity divided by the momentum coefficient. More...

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

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

virtual tmp< volScalarField >	rho () const =0
	Return the density field. 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< volVectorField >	U () const =0
	Constant access the velocity. More...

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

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

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

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

virtual 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< surfaceScalarField >	alphaRhoPhi () const =0
	Constant access the mass flux of the phase. More...

virtual surfaceScalarField &	alphaRhoPhi ()=0
	Access the mass flux of the phase. 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 >	kappa () const =0
	Return the laminar thermal conductivity. More...

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

virtual tmp< volScalarField >	kappaEff (const volScalarField &alphat) const =0
	Return the effective thermal conductivity. More...

virtual tmp< scalarField >	kappaEff (const scalarField &alphat, const label patchi) const =0
	Access the effective thermal conductivity. More...

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

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

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

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

virtual const phaseCompressibleTurbulenceModel &	turbulence () const =0
	Return the turbulence model. 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 >	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	correct ()
	Correct the phase properties. More...

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

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

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

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensions and patch type. More...

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

	GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType())
	Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...

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

	GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type > > &)
	Constructor from components. More...

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

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

	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy. More...

	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &)
	Construct as copy resetting name. More...

	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh > > &)
	Construct as copy resetting name. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

virtual	~GeometricField ()
	Destructor. More...

DimensionedInternalField &	dimensionedInternalField ()
	Return dimensioned internal field. More...

const DimensionedInternalField &	dimensionedInternalField () const
	Return dimensioned internal field. More...

InternalField &	internalField ()
	Return internal field. More...

const InternalField &	internalField () const
	Return internal field. More...

GeometricBoundaryField &	boundaryField ()
	Return reference to GeometricBoundaryField. More...

const GeometricBoundaryField &	boundaryField () const
	Return reference to GeometricBoundaryField for const 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< Type, PatchField, GeoMesh > &	oldTime () const
	Return old time field. More...

GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
	Return non-const old time field. More...

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

const GeometricField< Type, PatchField, GeoMesh > &	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, PatchField, GeoMesh > >	component (const direction) const
	Return a component of the field. More...

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

tmp< GeometricField< Type, PatchField, GeoMesh > >	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 ()

void	replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &)

void	replace (const direction, const dimensioned< cmptType > &)

void	max (const dimensioned< Type > &)

void	min (const dimensioned< Type > &)

void	max (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	min (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const GeometricField< Type, PatchField, GeoMesh > &)

void	scale (const GeometricField< Type, PatchField, GeoMesh > &, const dimensioned< Type > &)

void	operator= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator= (const dimensioned< Type > &)

void	operator== (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

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

void	operator+= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator-= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh > > &)

void	operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)

void	operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh > > &)

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > &	null ()
	Return a null geometric field. More...

Private Attributes
word	name_
	Name of phase. More...

const volScalarField &	p_

const volScalarField &	T_

autoPtr< rhoThermo >	thermo_
	Thermophysical properties. More...

volScalarField	dgdt_

dictionary	phaseDict_

dimensionedScalar	nu_
	Kinematic viscosity. More...

dimensionedScalar	kappa_
	Thermal conductivity. More...

dimensionedScalar	Cp_
	Heat capacity. More...

dimensionedScalar	rho_
	Density. More...

volVectorField	U_
	Velocity. More...

volVectorField	DDtU_
	Substantive derivative of the velocity. More...

surfaceScalarField	alphaPhi_
	Volumetric flux of the phase. More...

autoPtr< surfaceScalarField >	phiPtr_
	Volumetric flux for the phase. More...

autoPtr< diameterModel >	dPtr_
	Diameter model. More...

const phaseSystem &	fluid_
	Reference to the phaseSystem to which this phase belongs. More...

label	index_
	Index of phase. More...

dimensionedScalar	residualAlpha_
	Return the residual phase-fraction for given phase. More...

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

autoPtr< diameterModel >	diameterModel_
	Diameter model. More...

const twoPhaseSystem &	fluid_
	Reference to the twoPhaseSystem to which this phase belongs. More...

surfaceScalarField	alphaRhoPhi_
	Mass flux of the phase. More...

autoPtr< PhaseCompressibleTurbulenceModel< phaseModel > >	turbulence_
	Turbulence model. More...

Additional Inherited Members
Public Types inherited from GeometricField
typedef GeoMesh::Mesh	Mesh

typedef GeoMesh::BoundaryMesh	BoundaryMesh

typedef DimensionedField< Type, GeoMesh >	DimensionedInternalField

typedef Field< Type >	InternalField

typedef PatchField< Type >	PatchFieldType

typedef Field< Type >::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 53 of file phaseModel.H.

Constructor & Destructor Documentation

◆ phaseModel() [1/4]

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

Construct from components.

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

Here is the caller graph for this function:

◆ phaseModel() [2/4]

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

◆ ~phaseModel() [1/3]

virtual ~phaseModel ( )

virtual

Destructor.

◆ phaseModel() [3/4]

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

◆ ~phaseModel() [2/3]

virtual ~phaseModel ( )

virtual

Destructor.

◆ phaseModel() [4/4]

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

◆ ~phaseModel() [3/3]

virtual ~phaseModel ( )

virtual

Destructor.

Member Function Documentation

◆ clone() [1/3]

autoPtr<phaseModel> clone ( ) const

Return clone.

◆ name() [1/4]

const word& name ( ) const

inline

Definition at line 109 of file phaseModel.H.

References phaseModel::name_.

Referenced by phaseModel::keyword().

Here is the caller graph for this function:

◆ keyword() [1/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() [1/6]

const rhoThermo& thermo ( ) const

inline

Return const-access to phase rhoThermo.

Definition at line 120 of file phaseModel.H.

References phaseModel::thermo_.

◆ thermo() [2/6]

rhoThermo& thermo ( )

inline

Return access to phase rhoThermo.

Definition at line 126 of file phaseModel.H.

References phaseModel::thermo_.

◆ dgdt() [1/2]

const volScalarField& dgdt ( ) const

inline

Return const-access to phase divergence.

Definition at line 132 of file phaseModel.H.

References phaseModel::dgdt_.

◆ dgdt() [2/2]

volScalarField& dgdt ( )

inline

Return access to phase divergence.

Definition at line 138 of file phaseModel.H.

References phaseModel::dgdt_.

◆ correct() [1/4]

void correct ( )

◆ clone() [2/3]

autoPtr<phaseModel> clone ( ) const

Return clone.

◆ name() [2/4]

const word& name ( ) const

inline

Definition at line 138 of file phaseModel.H.

References phaseModel::name_.

◆ keyword() [2/3]

const word& keyword ( ) const

inline

Definition at line 143 of file phaseModel.H.

References phaseModel::name().

Here is the call graph for this function:

◆ d() [1/3]

tmp<volScalarField> d ( ) const

◆ nu() [1/5]

const dimensionedScalar& nu ( ) const

inline

Definition at line 150 of file phaseModel.H.

References phaseModel::nu_.

◆ kappa() [1/5]

const dimensionedScalar& kappa ( ) const

inline

Definition at line 155 of file phaseModel.H.

References phaseModel::kappa_.

◆ Cp() [1/2]

const dimensionedScalar& Cp ( ) const

inline

Definition at line 160 of file phaseModel.H.

References phaseModel::Cp_.

◆ rho() [1/3]

const dimensionedScalar& rho ( ) const

inline

Definition at line 165 of file phaseModel.H.

References phaseModel::rho_.

◆ U() [1/6]

const volVectorField& U ( ) const

inline

Definition at line 170 of file phaseModel.H.

References phaseModel::U_.

◆ U() [2/6]

volVectorField& U ( )

inline

Definition at line 175 of file phaseModel.H.

References phaseModel::U_.

◆ DDtU() [1/2]

const volVectorField& DDtU ( ) const

inline

Definition at line 180 of file phaseModel.H.

References phaseModel::DDtU_.

◆ DDtU() [2/2]

volVectorField& DDtU ( )

inline

Definition at line 185 of file phaseModel.H.

References phaseModel::DDtU_.

◆ phi() [1/6]

const surfaceScalarField& phi ( ) const

inline

Definition at line 190 of file phaseModel.H.

References phaseModel::phiPtr_.

◆ phi() [2/6]

surfaceScalarField& phi ( )

inline

Definition at line 195 of file phaseModel.H.

References phaseModel::phiPtr_.

◆ alphaPhi() [1/6]

const surfaceScalarField& alphaPhi ( ) const

inline

Definition at line 200 of file phaseModel.H.

References phaseModel::alphaPhi_.

◆ alphaPhi() [2/6]

surfaceScalarField& alphaPhi ( )

inline

Definition at line 205 of file phaseModel.H.

References phaseModel::alphaPhi_.

◆ correct() [2/4]

void correct ( )

Correct the phase properties.

◆ read() [1/4]

bool read ( const dictionary & phaseDict )

Read base transportProperties dictionary.

◆ ClassName()

ClassName ( "phaseModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ clone() [3/3]

autoPtr<phaseModel> clone ( ) const

Return clone.

◆ New()

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

static

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

Here is the caller graph for this function:

◆ name() [3/4]

const word& name ( ) const

Return the name of this phase.

◆ keyword() [3/3]

const word& keyword ( ) const

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

◆ index()

label index ( ) const

Return the index of the phase.

◆ fluid() [1/2]

const phaseSystem& fluid ( ) const

Return the system to which this phase belongs.

Referenced by IATEsource::fluid().

Here is the caller graph for this function:

◆ residualAlpha() [1/2]

const dimensionedScalar& residualAlpha ( ) const

Return the residual phase-fraction for given phase.

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

◆ alphaMax() [1/2]

scalar alphaMax ( ) const

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

◆ d() [2/3]

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

◆ correct() [3/4]

virtual void correct ( )

virtual

Correct the phase properties.

◆ correctKinematics()

virtual void correctKinematics ( )

virtual

Correct the kinematics.

◆ correctThermo()

virtual void correctThermo ( )

virtual

Correct the thermodynamics.

◆ correctTurbulence()

virtual void correctTurbulence ( )

virtual

Correct the turbulence.

◆ correctEnergyTransport()

virtual void correctEnergyTransport ( )

virtual

Correct the energy transport e.g. alphat.

◆ UEqn()

virtual tmp<fvVectorMatrix> UEqn ( )

pure virtual

Return the momentum equation.

◆ heEqn()

virtual tmp<fvScalarMatrix> heEqn ( )

pure virtual

Return the enthalpy equation.

◆ YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField & Yi )

pure virtual

Return the species fraction equation.

◆ read() [2/4]

virtual bool read ( )

virtual

Read phase properties dictionary.

◆ compressible()

virtual bool compressible ( ) const

virtual

Return true if the phase is compressible otherwise false.

◆ divU() [1/2]

virtual const tmp<volScalarField>& divU ( ) const

virtual

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

◆ divU() [2/2]

virtual void divU ( const tmp< volScalarField > & divU )

virtual

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

◆ K()

virtual const volScalarField& K ( ) const

virtual

Return the phase kinetic energy.

◆ DbyA() [1/2]

virtual const surfaceScalarField& DbyA ( ) const

virtual

Return the phase diffusivity divided by the momentum coefficient.

◆ DbyA() [2/2]

virtual void DbyA ( const tmp< surfaceScalarField > & DbyA )

virtual

Set the phase diffusivity divided by the momentum coefficient.

◆ thermo() [3/6]

virtual const rhoThermo& thermo ( ) const

pure virtual

Return const access to the thermophysical model.

◆ thermo() [4/6]

virtual rhoThermo& thermo ( )

pure virtual

Return non-const access to the thermophysical model.

for correction

◆ rho() [2/3]

virtual tmp<volScalarField> rho ( ) const

pure virtual

Return the density field.

◆ Y() [1/2]

virtual const PtrList<volScalarField>& Y ( ) const

pure virtual

Constant access the species mass fractions.

◆ Y() [2/2]

virtual PtrList<volScalarField>& Y ( )

pure virtual

Access the species mass fractions.

◆ U() [3/6]

virtual tmp<volVectorField> U ( ) const

pure virtual

Constant access the velocity.

◆ U() [4/6]

virtual volVectorField& U ( )

pure virtual

Access the velocity.

◆ DUDt()

virtual tmp<volVectorField> DUDt ( ) const

pure virtual

Return the substantive acceleration.

◆ continuityError()

virtual tmp<volScalarField> continuityError ( ) const

pure virtual

Constant access the continuity error.

◆ phi() [3/6]

virtual tmp<surfaceScalarField> phi ( ) const

pure virtual

Constant access the volumetric flux.

◆ phi() [4/6]

virtual surfaceScalarField& phi ( )

pure virtual

Access the volumetric flux.

◆ alphaPhi() [3/6]

virtual tmp<surfaceScalarField> alphaPhi ( ) const

pure virtual

Constant access the volumetric flux of the phase.

◆ alphaPhi() [4/6]

virtual surfaceScalarField& alphaPhi ( )

pure virtual

Access the volumetric flux of the phase.

◆ alphaRhoPhi() [1/4]

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const

pure virtual

Constant access the mass flux of the phase.

◆ alphaRhoPhi() [2/4]

virtual surfaceScalarField& alphaRhoPhi ( )

pure virtual

Access the mass flux of the phase.

◆ mu() [1/4]

virtual tmp<volScalarField> mu ( ) const

pure virtual

Return the laminar dynamic viscosity.

◆ mu() [2/4]

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

pure virtual

Return the laminar dynamic viscosity on a patch.

◆ nu() [2/5]

virtual tmp<volScalarField> nu ( ) const

pure virtual

Return the laminar kinematic viscosity.

◆ nu() [3/5]

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

pure virtual

Return the laminar kinematic viscosity on a patch.

◆ kappa() [2/5]

virtual tmp<volScalarField> kappa ( ) const

pure virtual

Return the laminar thermal conductivity.

◆ kappa() [3/5]

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

pure virtual

Return the laminar thermal conductivity on a patch.

◆ kappaEff() [1/4]

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

pure virtual

Return the effective thermal conductivity.

◆ kappaEff() [2/4]

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

pure virtual

Access the effective thermal conductivity.

◆ alpha() [1/4]

virtual tmp<volScalarField> alpha ( ) const

pure virtual

Return the laminar thermal diffusivity for enthalpy.

◆ alpha() [2/4]

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

pure virtual

Return the laminar thermal diffusivity for enthalpy on a patch.

◆ alphaEff() [1/4]

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

pure virtual

Return the effective thermal diffusivity for enthalpy.

◆ alphaEff() [2/4]

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

pure virtual

Return the effective thermal diffusivity for enthalpy on a patch.

◆ turbulence() [1/3]

virtual const phaseCompressibleTurbulenceModel& turbulence ( ) const

pure virtual

Return the turbulence model.

◆ name() [4/4]

const word& name ( ) const

inline

Return the name of this phase.

Definition at line 121 of file phaseModel.H.

References phaseModel::name_.

◆ fluid() [2/2]

const twoPhaseSystem& fluid ( ) const

inline

Return the twoPhaseSystem to which this phase belongs.

Definition at line 127 of file phaseModel.H.

References phaseModel::fluid_.

◆ otherPhase()

const phaseModel& otherPhase ( ) const

Return the other phase in this two-phase system.

Referenced by IATEsource::otherPhase().

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 137 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 144 of file phaseModel.H.

◆ d() [3/3]

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

◆ turbulence() [2/3]

const PhaseCompressibleTurbulenceModel<phaseModel>& turbulence ( ) const

Return the turbulence model.

◆ turbulence() [3/3]

PhaseCompressibleTurbulenceModel<phaseModel>& turbulence ( )

Return non-const access to the turbulence model.

for correction

◆ thermo() [5/6]

const rhoThermo& thermo ( ) const

inline

Return the thermophysical model.

Definition at line 162 of file phaseModel.H.

References phaseModel::thermo_.

◆ thermo() [6/6]

rhoThermo& thermo ( )

inline

Return non-const access to the thermophysical model.

for correction

Definition at line 169 of file phaseModel.H.

◆ nu() [4/5]

tmp<volScalarField> nu ( ) const

inline

Return the laminar viscosity.

Definition at line 175 of file phaseModel.H.

References phaseModel::thermo_.

◆ nu() [5/5]

tmp<scalarField> nu ( const label patchi ) const

inline

Return the laminar viscosity for patch.

Definition at line 181 of file phaseModel.H.

References patchi, and phaseModel::thermo_.

◆ mu() [3/4]

tmp<volScalarField> mu ( ) const

inline

Return the laminar dynamic viscosity.

Definition at line 187 of file phaseModel.H.

References phaseModel::thermo_.

◆ mu() [4/4]

tmp<scalarField> mu ( const label patchi ) const

inline

Return the laminar dynamic viscosity for patch.

Definition at line 193 of file phaseModel.H.

References patchi, and phaseModel::thermo_.

◆ kappa() [4/5]

tmp<scalarField> kappa ( const label patchi ) const

inline

Return the thermal conductivity on a patch.

Definition at line 199 of file phaseModel.H.

References patchi, and phaseModel::thermo_.

◆ kappa() [5/5]

tmp<volScalarField> kappa ( ) const

inline

Return the thermal conductivity.

Definition at line 205 of file phaseModel.H.

References phaseModel::thermo_.

◆ kappaEff() [3/4]

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

inline

Return the laminar thermal conductivity.

Definition at line 212 of file phaseModel.H.

References alphat, and phaseModel::thermo_.

◆ kappaEff() [4/4]

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

inline

Return the laminar thermal conductivity on a patch.

Definition at line 221 of file phaseModel.H.

References alphat, patchi, and phaseModel::thermo_.

◆ alpha() [3/4]

tmp<volScalarField> alpha ( ) const

inline

Return the laminar thermal diffusivity for enthalpy.

Definition at line 230 of file phaseModel.H.

References phaseModel::thermo_.

◆ alpha() [4/4]

tmp<scalarField> alpha ( const label patchi ) const

inline

Return the laminar thermal diffusivity for enthalpy on a patch.

Definition at line 236 of file phaseModel.H.

References patchi, and phaseModel::thermo_.

◆ alphaEff() [3/4]

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

inline

Return the effective thermal diffusivity for enthalpy.

Definition at line 243 of file phaseModel.H.

References alphat, and phaseModel::thermo_.

◆ alphaEff() [4/4]

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

inline

Return the effective thermal diffusivity for enthalpy on a patch.

Definition at line 252 of file phaseModel.H.

References alphat, patchi, and phaseModel::thermo_.

◆ Cp() [2/2]

tmp<volScalarField> Cp ( ) const

inline

Return the specific heat capacity.

Definition at line 261 of file phaseModel.H.

References phaseModel::thermo_.

◆ rho() [3/3]

const volScalarField& rho ( ) const

inline

Return the density.

Definition at line 267 of file phaseModel.H.

References phaseModel::thermo_.

◆ U() [5/6]

const volVectorField& U ( ) const

inline

Return the velocity.

Definition at line 273 of file phaseModel.H.

References phaseModel::U_.

◆ U() [6/6]

volVectorField& U ( )

inline

Return non-const access to the velocity.

Used in the momentum equation

Definition at line 280 of file phaseModel.H.

◆ phi() [5/6]

const surfaceScalarField& phi ( ) const

inline

Return the volumetric flux.

Definition at line 286 of file phaseModel.H.

References phaseModel::phiPtr_.

◆ phi() [6/6]

surfaceScalarField& phi ( )

inline

Return non-const access to the volumetric flux.

Definition at line 292 of file phaseModel.H.

References phaseModel::phiPtr_.

◆ alphaPhi() [5/6]

const surfaceScalarField& alphaPhi ( ) const

inline

Return the volumetric flux of the phase.

Definition at line 298 of file phaseModel.H.

References phaseModel::alphaPhi_.

◆ alphaPhi() [6/6]

surfaceScalarField& alphaPhi ( )

inline

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

Definition at line 304 of file phaseModel.H.

References phaseModel::alphaPhi_.

◆ alphaRhoPhi() [3/4]

const surfaceScalarField& alphaRhoPhi ( ) const

inline

Return the mass flux of the phase.

Definition at line 310 of file phaseModel.H.

References phaseModel::alphaRhoPhi_.

◆ alphaRhoPhi() [4/4]

surfaceScalarField& alphaRhoPhi ( )

inline

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

Definition at line 316 of file phaseModel.H.

References phaseModel::alphaRhoPhi_.

◆ correct() [4/4]

void correct ( )

Correct the phase properties.

other than the thermodynamics and turbulence which have special treatment

◆ read() [3/4]

virtual bool read ( const dictionary & phaseProperties )

virtual

Read phaseProperties dictionary.

◆ read() [4/4]

virtual bool read ( )

inlinevirtual

Dummy Read for transportModel.

Definition at line 330 of file phaseModel.H.

Field Documentation

◆ name_

word name_

private

Name of phase.

Definition at line 59 of file phaseModel.H.

Referenced by phaseModel::name().

◆ p_

const volScalarField& p_

private

Definition at line 60 of file phaseModel.H.

◆ T_

const volScalarField& T_

private

Definition at line 61 of file phaseModel.H.

◆ thermo_

autoPtr< rhoThermo > thermo_

private

Thermophysical properties.

Definition at line 62 of file phaseModel.H.

Referenced by phaseModel::alpha(), phaseModel::alphaEff(), phaseModel::Cp(), phaseModel::kappa(), phaseModel::kappaEff(), phaseModel::mu(), phaseModel::nu(), phaseModel::rho(), and phaseModel::thermo().

◆ dgdt_

volScalarField dgdt_

private

Definition at line 63 of file phaseModel.H.

Referenced by phaseModel::dgdt().

◆ phaseDict_

dictionary phaseDict_

private

Definition at line 61 of file phaseModel.H.

◆ nu_

dimensionedScalar nu_

private

Kinematic viscosity.

Definition at line 64 of file phaseModel.H.

Referenced by phaseModel::nu().

◆ kappa_

dimensionedScalar kappa_

private

Thermal conductivity.

Definition at line 67 of file phaseModel.H.

Referenced by phaseModel::kappa().

◆ Cp_

dimensionedScalar Cp_

private

Heat capacity.

Definition at line 70 of file phaseModel.H.

Referenced by phaseModel::Cp().

◆ rho_

dimensionedScalar rho_

private

Density.

Definition at line 73 of file phaseModel.H.

Referenced by phaseModel::rho().

◆ U_

volVectorField U_

private

Velocity.

Definition at line 76 of file phaseModel.H.

Referenced by phaseModel::U().

◆ DDtU_

volVectorField DDtU_

private

Substantive derivative of the velocity.

Definition at line 79 of file phaseModel.H.

Referenced by phaseModel::DDtU().

◆ alphaPhi_

surfaceScalarField alphaPhi_

private

Volumetric flux of the phase.

Definition at line 82 of file phaseModel.H.

Referenced by phaseModel::alphaPhi().

◆ phiPtr_

autoPtr< surfaceScalarField > phiPtr_

private

Volumetric flux for the phase.

Volumetric flux of the phase.

Definition at line 85 of file phaseModel.H.

Referenced by phaseModel::phi().

◆ dPtr_

autoPtr< diameterModel > dPtr_

private

Diameter model.

Definition at line 88 of file phaseModel.H.

◆ fluid_ [1/2]

const phaseSystem& fluid_

private

Reference to the phaseSystem to which this phase belongs.

Definition at line 62 of file phaseModel.H.

Referenced by phaseModel::fluid().

◆ index_

label index_

private

Index of phase.

Definition at line 68 of file phaseModel.H.

◆ residualAlpha_

dimensionedScalar residualAlpha_

private

Return the residual phase-fraction for given phase.

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

Definition at line 72 of file phaseModel.H.

◆ alphaMax_

scalar alphaMax_

private

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

Definition at line 75 of file phaseModel.H.

◆ diameterModel_

autoPtr<diameterModel> diameterModel_

private

Diameter model.

Definition at line 78 of file phaseModel.H.

◆ fluid_ [2/2]

const twoPhaseSystem& fluid_

private

Reference to the twoPhaseSystem to which this phase belongs.

Definition at line 66 of file phaseModel.H.

◆ alphaRhoPhi_

surfaceScalarField alphaRhoPhi_

private

Mass flux of the phase.

Definition at line 90 of file phaseModel.H.

Referenced by phaseModel::alphaRhoPhi().

◆ turbulence_

autoPtr<PhaseCompressibleTurbulenceModel<phaseModel> > turbulence_

private

Turbulence model.

Definition at line 99 of file phaseModel.H.

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

applications/solvers/multiphase/compressibleMultiphaseInterFoam/multiphaseMixtureThermo/phaseModel/phaseModel.H

Data Structures

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseModel() [1/4]

◆ phaseModel() [2/4]

◆ ~phaseModel() [1/3]

◆ phaseModel() [3/4]

◆ ~phaseModel() [2/3]

◆ phaseModel() [4/4]

◆ ~phaseModel() [3/3]

Member Function Documentation

◆ clone() [1/3]

◆ name() [1/4]

◆ keyword() [1/3]

◆ thermo() [1/6]

◆ thermo() [2/6]

◆ dgdt() [1/2]

◆ dgdt() [2/2]

◆ correct() [1/4]

◆ clone() [2/3]

◆ name() [2/4]

◆ keyword() [2/3]

◆ d() [1/3]

◆ nu() [1/5]

◆ kappa() [1/5]

◆ Cp() [1/2]

◆ rho() [1/3]

◆ U() [1/6]

◆ U() [2/6]

◆ DDtU() [1/2]

◆ DDtU() [2/2]

◆ phi() [1/6]

◆ phi() [2/6]

◆ alphaPhi() [1/6]

◆ alphaPhi() [2/6]

◆ correct() [2/4]

◆ read() [1/4]

◆ ClassName()

◆ declareRunTimeSelectionTable()

◆ clone() [3/3]

◆ New()

◆ name() [3/4]

◆ keyword() [3/3]

◆ index()

◆ fluid() [1/2]

◆ residualAlpha() [1/2]

◆ alphaMax() [1/2]

◆ d() [2/3]

◆ correct() [3/4]

◆ correctKinematics()

◆ correctThermo()

◆ correctTurbulence()

◆ correctEnergyTransport()

◆ UEqn()

◆ heEqn()

◆ YiEqn()

◆ read() [2/4]

◆ compressible()

◆ divU() [1/2]

◆ divU() [2/2]

◆ K()

◆ DbyA() [1/2]

◆ DbyA() [2/2]

◆ thermo() [3/6]

◆ thermo() [4/6]

◆ rho() [2/3]

◆ Y() [1/2]

◆ Y() [2/2]

◆ U() [3/6]

◆ U() [4/6]

◆ DUDt()

◆ continuityError()

◆ phi() [3/6]

◆ phi() [4/6]

◆ alphaPhi() [3/6]

◆ alphaPhi() [4/6]