MovingPhaseModel< BasePhaseModel > Class Template Reference

Class which represents a moving fluid phase. Holds the velocity, fluxes and turbulence 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 turbulence model. More...

Inheritance diagram for MovingPhaseModel< BasePhaseModel >:
Collaboration diagram for MovingPhaseModel< BasePhaseModel >:

Public Member Functions

 MovingPhaseModel (const phaseSystem &fluid, const word &phaseName, const label index)
 
virtual ~MovingPhaseModel ()
 Destructor. More...
 
virtual void correct ()
 Correct the phase properties other than the thermo and turbulence. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual void correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 
virtual bool stationary () const
 Return whether the phase is stationary. More...
 
virtual tmp< fvVectorMatrixUEqn ()
 Return the momentum equation. More...
 
virtual tmp< fvVectorMatrixUfEqn ()
 Return the momentum equation for the face-based algorithm. More...
 
virtual tmp< volVectorFieldU () const
 Return the velocity. More...
 
virtual volVectorFieldURef ()
 Access the velocity. More...
 
virtual tmp< surfaceScalarFieldphi () const
 Return the volumetric flux. More...
 
virtual surfaceScalarFieldphiRef ()
 Access the volumetric flux. More...
 
virtual tmp< surfaceScalarFieldalphaPhi () const
 Return the volumetric flux of the phase. More...
 
virtual surfaceScalarFieldalphaPhiRef ()
 Access the volumetric flux of the phase. More...
 
virtual tmp< surfaceScalarFieldalphaRhoPhi () const
 Return the mass flux of the phase. More...
 
virtual surfaceScalarFieldalphaRhoPhiRef ()
 Access the mass flux of the phase. More...
 
virtual tmp< volVectorFieldDUDt () const
 Return the substantive acceleration. More...
 
virtual tmp< surfaceScalarFieldDUDtf () const
 Return the substantive acceleration on the faces. More...
 
virtual tmp< volScalarFieldcontinuityError () const
 Return the continuity error. More...
 
virtual tmp< volScalarFieldcontinuityErrorFlow () const
 Return the continuity error due to the flow field. More...
 
virtual tmp< volScalarFieldcontinuityErrorSources () const
 Return the continuity error due to any sources. More...
 
virtual tmp< volScalarFieldK () const
 Return the phase kinetic energy. More...
 
virtual tmp< volScalarFielddivU () 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< volScalarFieldmut () const
 Return the turbulent dynamic viscosity. More...
 
virtual tmp< volScalarFieldmuEff () const
 Return the effective dynamic viscosity. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulent kinematic viscosity. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective kinematic viscosity. More...
 
virtual tmp< volScalarFieldkappaEff () const
 Return the effective thermal conductivity. More...
 
virtual tmp< scalarFieldkappaEff (const label patchi) const
 Return the effective thermal conductivity on a patch. More...
 
virtual tmp< volScalarFieldalphaEff () const
 Return the effective thermal diffusivity. More...
 
virtual tmp< scalarFieldalphaEff (const label patchi) const
 Return the effective thermal conductivity on a patch. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulent kinetic energy. More...
 
virtual tmp< volScalarFieldpPrime () const
 Return the phase-pressure'. More...
 

Protected Attributes

volVectorField U_
 Velocity field. More...
 
surfaceScalarField phi_
 Flux. More...
 
surfaceScalarField alphaPhi_
 Volumetric flux. More...
 
surfaceScalarField alphaRhoPhi_
 Mass flux. More...
 
tmp< volVectorFieldDUDt_
 Lagrangian acceleration field (needed for virtual-mass) More...
 
tmp< surfaceScalarFieldDUDtf_
 Lagrangian acceleration field on the faces (needed for virtual-mass) More...
 
tmp< volScalarFielddivU_
 Dilatation rate. More...
 
autoPtr< phaseCompressibleTurbulenceModelturbulence_
 Turbulence model. More...
 
volScalarField continuityErrorFlow_
 Continuity error due to the flow. More...
 
volScalarField continuityErrorSources_
 Continuity error due to any sources. More...
 
tmp< volScalarFieldK_
 Kinetic Energy. More...
 

Detailed Description

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

Class which represents a moving fluid phase. Holds the velocity, fluxes and turbulence 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 turbulence model.

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

See also
StationaryPhaseModel
Source files

Definition at line 59 of file MovingPhaseModel.H.

Constructor & Destructor Documentation

◆ MovingPhaseModel()

MovingPhaseModel ( const phaseSystem fluid,
const word phaseName,
const label  index 
)

◆ ~MovingPhaseModel()

virtual ~MovingPhaseModel ( )
virtual

Destructor.

Member Function Documentation

◆ correct()

virtual void correct ( )
virtual

Correct the phase properties other than the thermo and turbulence.

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

◆ stationary()

virtual bool stationary ( ) const
virtual

Return whether the phase is stationary.

◆ UEqn()

virtual tmp<fvVectorMatrix> UEqn ( )
virtual

Return the momentum equation.

◆ UfEqn()

virtual tmp<fvVectorMatrix> UfEqn ( )
virtual

Return the momentum equation for the face-based algorithm.

◆ U()

virtual tmp<volVectorField> U ( ) const
virtual

Return the velocity.

◆ URef()

virtual volVectorField& URef ( )
virtual

Access the velocity.

◆ phi()

virtual tmp<surfaceScalarField> phi ( ) const
virtual

Return the volumetric flux.

◆ phiRef()

virtual surfaceScalarField& phiRef ( )
virtual

Access the volumetric flux.

◆ alphaPhi()

virtual tmp<surfaceScalarField> alphaPhi ( ) const
virtual

Return the volumetric flux of the phase.

◆ alphaPhiRef()

virtual surfaceScalarField& alphaPhiRef ( )
virtual

Access the volumetric flux of the phase.

◆ alphaRhoPhi()

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const
virtual

Return the mass flux of the phase.

◆ alphaRhoPhiRef()

virtual surfaceScalarField& alphaRhoPhiRef ( )
virtual

Access the mass flux of the phase.

◆ DUDt()

virtual tmp<volVectorField> DUDt ( ) const
virtual

Return the substantive acceleration.

◆ DUDtf()

virtual tmp<surfaceScalarField> DUDtf ( ) const
virtual

Return the substantive acceleration on the faces.

◆ continuityError()

virtual tmp<volScalarField> continuityError ( ) const
virtual

Return the continuity error.

◆ continuityErrorFlow()

virtual tmp<volScalarField> continuityErrorFlow ( ) const
virtual

Return the continuity error due to the flow field.

◆ continuityErrorSources()

virtual tmp<volScalarField> continuityErrorSources ( ) const
virtual

Return the continuity error due to any sources.

◆ K()

virtual tmp<volScalarField> K ( ) const
virtual

Return the phase kinetic energy.

◆ divU() [1/2]

virtual tmp<volScalarField> divU ( ) const
virtual

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

◆ divU() [2/2]

virtual void divU ( tmp< volScalarField divU)
virtual

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

◆ mut()

virtual tmp<volScalarField> mut ( ) const
virtual

Return the turbulent dynamic viscosity.

◆ muEff()

virtual tmp<volScalarField> muEff ( ) const
virtual

Return the effective dynamic viscosity.

◆ nut()

virtual tmp<volScalarField> nut ( ) const
virtual

Return the turbulent kinematic viscosity.

◆ nuEff()

virtual tmp<volScalarField> nuEff ( ) const
virtual

Return the effective kinematic viscosity.

◆ kappaEff() [1/2]

virtual tmp<volScalarField> kappaEff ( ) const
virtual

Return the effective thermal conductivity.

◆ kappaEff() [2/2]

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

Return the effective thermal conductivity on a patch.

◆ alphaEff() [1/2]

virtual tmp<volScalarField> alphaEff ( ) const
virtual

Return the effective thermal diffusivity.

◆ alphaEff() [2/2]

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

Return the effective thermal conductivity on a patch.

◆ k()

virtual tmp<volScalarField> k ( ) const
virtual

Return the turbulent kinetic energy.

◆ pPrime()

virtual tmp<volScalarField> pPrime ( ) const
virtual

Return the phase-pressure'.

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

Member Data Documentation

◆ U_

volVectorField U_
protected

Velocity field.

Definition at line 68 of file MovingPhaseModel.H.

◆ phi_

surfaceScalarField phi_
protected

Flux.

Definition at line 71 of file MovingPhaseModel.H.

◆ alphaPhi_

surfaceScalarField alphaPhi_
protected

Volumetric flux.

Definition at line 74 of file MovingPhaseModel.H.

◆ alphaRhoPhi_

surfaceScalarField alphaRhoPhi_
protected

Mass flux.

Definition at line 77 of file MovingPhaseModel.H.

◆ DUDt_

tmp<volVectorField> DUDt_
mutableprotected

Lagrangian acceleration field (needed for virtual-mass)

Definition at line 80 of file MovingPhaseModel.H.

◆ DUDtf_

tmp<surfaceScalarField> DUDtf_
mutableprotected

Lagrangian acceleration field on the faces (needed for virtual-mass)

Definition at line 83 of file MovingPhaseModel.H.

◆ divU_

tmp<volScalarField> divU_
protected

Dilatation rate.

Definition at line 86 of file MovingPhaseModel.H.

◆ turbulence_

autoPtr<phaseCompressibleTurbulenceModel> turbulence_
protected

Turbulence model.

Definition at line 89 of file MovingPhaseModel.H.

◆ continuityErrorFlow_

volScalarField continuityErrorFlow_
protected

Continuity error due to the flow.

Definition at line 92 of file MovingPhaseModel.H.

◆ continuityErrorSources_

volScalarField continuityErrorSources_
protected

Continuity error due to any sources.

Definition at line 95 of file MovingPhaseModel.H.

◆ K_

tmp<volScalarField> K_
mutableprotected

Kinetic Energy.

Definition at line 98 of file MovingPhaseModel.H.


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