Class which represents a moving fluid phase. Holds the velocity, fluxes and momentumTransport model and can generate the momentum equation. The interface is quite restrictive as it also has to support an equivalent stationary model, which does not store motion fields or a momentumTransport model. More...

Inheritance diagram for MovingPhaseModel< BasePhaseModel >:

[legend]

Collaboration diagram for MovingPhaseModel< BasePhaseModel >:

[legend]

Public Member Functions
	MovingPhaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)

virtual	~MovingPhaseModel ()
	Destructor. More...

virtual void	correct ()
	Correct the phase properties other than the thermo. More...

virtual void	correctContinuityError (const volScalarField &source)
	Correct the continuity error. More...

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

virtual void	predictMomentumTransport ()
	Predict the momentumTransport. More...

virtual void	correctMomentumTransport ()
	Correct the momentumTransport. More...

virtual void	correctUf ()
	Correct the face velocity for moving meshes. More...

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

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

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

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

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

virtual const volVectorField &	URef () const
	Access the velocity. More...

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

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

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

virtual const autoPtr< surfaceVectorField > &	Uf () const
	Return the face velocity. More...

virtual surfaceVectorField &	UfRef ()
	Access the face velocity. More...

virtual const surfaceVectorField &	UfRef () const
	Access the face velocity. More...

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

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

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

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

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

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

virtual tmp< fvVectorMatrix >	UgradU () const
	Return the velocity transport matrix. More...

virtual tmp< fvVectorMatrix >	DUDt () const
	Return the substantive acceleration matrix. More...

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

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

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

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

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

virtual tmp< surfaceScalarField >	pPrimef () const
	Return the face-phase-pressure'. More...

Protected Attributes
volVectorField	U_
	Velocity field. More...

surfaceScalarField	phi_
	Flux. More...

surfaceScalarField	alphaPhi_
	Volumetric flux. More...

surfaceScalarField	alphaRhoPhi_
	Mass flux. More...

autoPtr< surfaceVectorField >	Uf_
	Face velocity field. More...

autoPtr< volScalarField >	divU_
	Dilatation rate. More...

autoPtr< phaseCompressible::momentumTransportModel >	momentumTransport_
	Turbulence model. More...

volScalarField	continuityError_
	Continuity error. More...

tmp< volScalarField >	K_
	Kinetic Energy. More...

Detailed Description

template<class BasePhaseModel>
class Foam::MovingPhaseModel< BasePhaseModel >

Class which represents a moving fluid phase. Holds the velocity, fluxes and momentumTransport model and can generate the momentum equation. The interface is quite restrictive as it also has to support an equivalent stationary model, which does not store motion fields or a momentumTransport model.

Possible future extensions include separating the turbulent functionality into another layer.

See also: StationaryPhaseModel

Source files

Definition at line 60 of file MovingPhaseModel.H.

Constructor & Destructor Documentation

◆ MovingPhaseModel()

MovingPhaseModel	(	const phaseSystem &	fluid,
		const word &	phaseName,
		const bool	referencePhase,
		const label	index
	)

Definition at line 158 of file MovingPhaseModel.C.

References IOobject::AUTO_WRITE, MovingPhaseModel< BasePhaseModel >::correctKinematics(), fvMesh::dynamic(), IOobject::groupName(), Foam::fvc::interpolate(), phaseSystem::mesh(), dimensioned< Type >::name(), Foam::name(), MovingPhaseModel< BasePhaseModel >::phi_, IOobject::READ_IF_PRESENT, fvMesh::time(), MovingPhaseModel< BasePhaseModel >::U_, MovingPhaseModel< BasePhaseModel >::Uf_, and IOobject::writeOpt().

Here is the call graph for this function:

◆ ~MovingPhaseModel()

~MovingPhaseModel

virtual

Destructor.

Definition at line 261 of file MovingPhaseModel.C.

Member Function Documentation

◆ correct()

void correct

virtual

Correct the phase properties other than the thermo.

and momentumTransport

Definition at line 279 of file MovingPhaseModel.C.

References Foam::MULES::correct().

Here is the call graph for this function:

◆ correctContinuityError()

void correctContinuityError ( const volScalarField & source )

virtual

Correct the continuity error.

Definition at line 268 of file MovingPhaseModel.C.

References Foam::fvc::ddt(), Foam::fvc::div(), and rho.

Here is the call graph for this function:

◆ correctKinematics()

void correctKinematics

virtual

Correct the kinematics.

Definition at line 286 of file MovingPhaseModel.C.

References Foam::magSqr(), and U.

Referenced by MovingPhaseModel< BasePhaseModel >::MovingPhaseModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ predictMomentumTransport()

void predictMomentumTransport

virtual

Predict the momentumTransport.

Definition at line 298 of file MovingPhaseModel.C.

◆ correctMomentumTransport()

void correctMomentumTransport

virtual

Correct the momentumTransport.

Definition at line 306 of file MovingPhaseModel.C.

◆ correctUf()

void correctUf

virtual

Correct the face velocity for moving meshes.

Definition at line 314 of file MovingPhaseModel.C.

References Foam::fvc::absolute(), Foam::fvc::interpolate(), fvMesh::magSf(), mesh, n, and fvMesh::Sf().

Here is the call graph for this function:

◆ stationary()

bool stationary

virtual

Return whether the phase is stationary.

Definition at line 333 of file MovingPhaseModel.C.

◆ UEqn()

Foam::tmp< Foam::fvVectorMatrix > UEqn

virtual

Return the momentum equation.

Definition at line 341 of file MovingPhaseModel.C.

References alpha(), Foam::fvc::DDt(), Foam::fvm::ddt(), Foam::fvm::div(), MRF(), rho, and Foam::fvm::SuSp().

Here is the call graph for this function:

◆ UfEqn()

Foam::tmp< Foam::fvVectorMatrix > UfEqn

virtual

Return the momentum equation for the face-based algorithm.

Definition at line 359 of file MovingPhaseModel.C.

References alpha(), Foam::fvc::ddt(), Foam::fvc::DDt(), Foam::fvm::div(), MRF(), rho, and Foam::fvm::SuSp().

Here is the call graph for this function:

◆ U()

Foam::tmp< Foam::volVectorField > U

virtual

Return the velocity.

Definition at line 378 of file MovingPhaseModel.C.

◆ URef() [1/2]

Foam::volVectorField & URef

virtual

Access the velocity.

Definition at line 386 of file MovingPhaseModel.C.

◆ URef() [2/2]

const Foam::volVectorField & URef

virtual

Access the velocity.

Definition at line 394 of file MovingPhaseModel.C.

◆ phi()

Foam::tmp< Foam::surfaceScalarField > phi

virtual

Return the volumetric flux.

Definition at line 402 of file MovingPhaseModel.C.

◆ phiRef() [1/2]

Foam::surfaceScalarField & phiRef

virtual

Access the volumetric flux.

Definition at line 410 of file MovingPhaseModel.C.

◆ phiRef() [2/2]

const Foam::surfaceScalarField & phiRef

virtual

Access the volumetric flux.

Definition at line 418 of file MovingPhaseModel.C.

◆ Uf()

const Foam::autoPtr< Foam::surfaceVectorField > & Uf

virtual

Return the face velocity.

Required for moving mesh cases

Definition at line 426 of file MovingPhaseModel.C.

◆ UfRef() [1/2]

Foam::surfaceVectorField & UfRef

virtual

Access the face velocity.

Required for moving mesh cases

Definition at line 434 of file MovingPhaseModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and GeometricField< Type, GeoMesh, PrimitiveField >::null().

Here is the call graph for this function:

◆ UfRef() [2/2]

const Foam::surfaceVectorField & UfRef

virtual

Access the face velocity.

Required for moving mesh cases

Definition at line 453 of file MovingPhaseModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and GeometricField< Type, GeoMesh, PrimitiveField >::null().

Here is the call graph for this function:

◆ alphaPhi()

Foam::tmp< Foam::surfaceScalarField > alphaPhi

virtual

Return the volumetric flux of the phase.

Definition at line 472 of file MovingPhaseModel.C.

◆ alphaPhiRef() [1/2]

Foam::surfaceScalarField & alphaPhiRef

virtual

Access the volumetric flux of the phase.

Definition at line 480 of file MovingPhaseModel.C.

◆ alphaPhiRef() [2/2]

const Foam::surfaceScalarField & alphaPhiRef

virtual

Access the volumetric flux of the phase.

Definition at line 488 of file MovingPhaseModel.C.

◆ alphaRhoPhi()

Foam::tmp< Foam::surfaceScalarField > alphaRhoPhi

virtual

Return the mass flux of the phase.

Definition at line 496 of file MovingPhaseModel.C.

◆ alphaRhoPhiRef() [1/2]

Foam::surfaceScalarField & alphaRhoPhiRef

virtual

Access the mass flux of the phase.

Definition at line 504 of file MovingPhaseModel.C.

◆ alphaRhoPhiRef() [2/2]

const Foam::surfaceScalarField & alphaRhoPhiRef

virtual

Access the mass flux of the phase.

Definition at line 512 of file MovingPhaseModel.C.

◆ UgradU()

Foam::tmp< Foam::fvVectorMatrix > UgradU

virtual

Return the velocity transport matrix.

Definition at line 520 of file MovingPhaseModel.C.

References Foam::fvc::absolute(), Foam::fvc::div(), Foam::fvm::div(), and Foam::fvm::Sp().

Here is the call graph for this function:

◆ DUDt()

Foam::tmp< Foam::fvVectorMatrix > DUDt

virtual

Return the substantive acceleration matrix.

Definition at line 533 of file MovingPhaseModel.C.

References Foam::fvm::ddt().

Here is the call graph for this function:

◆ continuityError()

Foam::tmp< Foam::volScalarField > continuityError

virtual

Return the continuity error.

Definition at line 541 of file MovingPhaseModel.C.

◆ K()

Foam::tmp< Foam::volScalarField > K

virtual

Return the phase kinetic energy.

Definition at line 549 of file MovingPhaseModel.C.

References IOobject::groupName(), Foam::magSqr(), Foam::name(), and U.

Here is the call graph for this function:

◆ divU() [1/2]

const Foam::autoPtr< Foam::volScalarField > & divU

virtual

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

Definition at line 567 of file MovingPhaseModel.C.

◆ divU() [2/2]

void divU ( tmp< volScalarField > divU )

virtual

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

Definition at line 574 of file MovingPhaseModel.C.

References IOobject::groupName(), Foam::name(), and tmp< T >::ptr().

Here is the call graph for this function:

◆ k()

Foam::tmp< Foam::volScalarField > k

virtual

Return the turbulent kinetic energy.

Definition at line 591 of file MovingPhaseModel.C.

◆ pPrimef()

Foam::tmp< Foam::surfaceScalarField > pPrimef

virtual

Return the face-phase-pressure'.

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

Definition at line 599 of file MovingPhaseModel.C.

Member Data Documentation

◆ U_

volVectorField U_

protected

Velocity field.

Definition at line 69 of file MovingPhaseModel.H.

Referenced by MovingPhaseModel< BasePhaseModel >::MovingPhaseModel().

◆ phi_

surfaceScalarField phi_

protected

Flux.

Definition at line 72 of file MovingPhaseModel.H.

Referenced by MovingPhaseModel< BasePhaseModel >::MovingPhaseModel().

◆ alphaPhi_

surfaceScalarField alphaPhi_

protected

Volumetric flux.

Definition at line 75 of file MovingPhaseModel.H.

◆ alphaRhoPhi_

surfaceScalarField alphaRhoPhi_

protected

Mass flux.

Definition at line 78 of file MovingPhaseModel.H.

◆ Uf_

autoPtr<surfaceVectorField> Uf_

protected

Face velocity field.

Definition at line 81 of file MovingPhaseModel.H.

Referenced by MovingPhaseModel< BasePhaseModel >::MovingPhaseModel().

◆ divU_

autoPtr<volScalarField> divU_

protected

Dilatation rate.

Definition at line 84 of file MovingPhaseModel.H.

◆ momentumTransport_

autoPtr<phaseCompressible::momentumTransportModel> momentumTransport_

protected

Turbulence model.

Definition at line 87 of file MovingPhaseModel.H.

◆ continuityError_

volScalarField continuityError_

protected

Continuity error.

Definition at line 90 of file MovingPhaseModel.H.

◆ K_

tmp<volScalarField> K_

mutableprotected

Kinetic Energy.

Definition at line 93 of file MovingPhaseModel.H.

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

applications/modules/multiphaseEuler/phaseSystem/phaseModels/MovingPhaseModel/MovingPhaseModel.H
applications/modules/multiphaseEuler/phaseSystem/phaseModels/MovingPhaseModel/MovingPhaseModel.C

Public Member Functions

Protected Attributes

Detailed Description

template<class BasePhaseModel> class Foam::MovingPhaseModel< BasePhaseModel >

Constructor & Destructor Documentation

◆ MovingPhaseModel()

◆ ~MovingPhaseModel()

Member Function Documentation

◆ correct()

◆ correctContinuityError()

◆ correctKinematics()

◆ predictMomentumTransport()

◆ correctMomentumTransport()

◆ correctUf()

◆ stationary()

◆ UEqn()

◆ UfEqn()

◆ U()

◆ URef() [1/2]

◆ URef() [2/2]

◆ phi()

◆ phiRef() [1/2]

◆ phiRef() [2/2]

◆ Uf()

◆ UfRef() [1/2]

◆ UfRef() [2/2]

◆ alphaPhi()

◆ alphaPhiRef() [1/2]

◆ alphaPhiRef() [2/2]

◆ alphaRhoPhi()

◆ alphaRhoPhiRef() [1/2]

◆ alphaRhoPhiRef() [2/2]

◆ UgradU()

◆ DUDt()

◆ continuityError()

◆ K()

◆ divU() [1/2]

◆ divU() [2/2]

◆ k()

◆ pPrimef()

Member Data Documentation

◆ U_

◆ phi_

◆ alphaPhi_

◆ alphaRhoPhi_

◆ Uf_

◆ divU_

◆ momentumTransport_

◆ continuityError_

◆ K_

template<class BasePhaseModel>
class Foam::MovingPhaseModel< BasePhaseModel >