StationaryPhaseModel< BasePhaseModel > Class Template Reference

Class which represents a stationary (and therefore probably solid) phase. Generates, but does not store, zero velocity and flux field and turbulent quantities. Throws an error when non-const access is requested to the motion fields or when the momentum equation is requested. Usage must must protect against such calls. More...

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

Public Member Functions

 StationaryPhaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
 
virtual ~StationaryPhaseModel ()
 Destructor. 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 const volVectorFieldURef () const
 Access the velocity. More...
 
virtual tmp< surfaceScalarFieldphi () const
 Return the volumetric flux. More...
 
virtual surfaceScalarFieldphiRef ()
 Access the volumetric flux. More...
 
virtual const surfaceScalarFieldphiRef () const
 Access the volumetric flux. More...
 
virtual const autoPtr< surfaceVectorField > & Uf () const
 Return the face velocity. More...
 
virtual surfaceVectorFieldUfRef ()
 Access the face velocity. More...
 
virtual const surfaceVectorFieldUfRef () const
 Access the face velocity. More...
 
virtual tmp< surfaceScalarFieldalphaPhi () const
 Return the volumetric flux of the phase. More...
 
virtual surfaceScalarFieldalphaPhiRef ()
 Access the volumetric flux of the phase. More...
 
virtual const surfaceScalarFieldalphaPhiRef () const
 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 const surfaceScalarFieldalphaRhoPhiRef () const
 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< volScalarFieldK () 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< scalarFieldkappaEff (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...
 
virtual tmp< fvScalarMatrixdivq (volScalarField &he) const
 Return the source term for the energy equation. More...
 

Detailed Description

template<class BasePhaseModel>
class Foam::StationaryPhaseModel< BasePhaseModel >

Class which represents a stationary (and therefore probably solid) phase. Generates, but does not store, zero velocity and flux field and turbulent quantities. Throws an error when non-const access is requested to the motion fields or when the momentum equation is requested. Usage must must protect against such calls.

See also
MovingPhaseModel
Source files

Definition at line 56 of file StationaryPhaseModel.H.

Constructor & Destructor Documentation

◆ StationaryPhaseModel()

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

Definition at line 32 of file StationaryPhaseModel.C.

◆ ~StationaryPhaseModel()

Destructor.

Definition at line 47 of file StationaryPhaseModel.C.

Member Function Documentation

◆ stationary()

bool stationary
virtual

Return whether the phase is stationary.

Definition at line 54 of file StationaryPhaseModel.C.

◆ UEqn()

Return the momentum equation.

Definition at line 62 of file StationaryPhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

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 74 of file StationaryPhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ U()

Return the velocity.

Definition at line 86 of file StationaryPhaseModel.C.

References Foam::dimVelocity, IOobject::groupName(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::Zero.

Here is the call graph for this function:

◆ URef() [1/2]

Foam::volVectorField & URef
virtual

Access the velocity.

Definition at line 99 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ URef() [2/2]

const Foam::volVectorField & URef
virtual

Access the velocity.

Definition at line 111 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ phi()

Return the volumetric flux.

Definition at line 123 of file StationaryPhaseModel.C.

References Foam::dimTime, Foam::dimVolume, IOobject::groupName(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ phiRef() [1/2]

Foam::surfaceScalarField & phiRef
virtual

Access the volumetric flux.

Definition at line 136 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ phiRef() [2/2]

const Foam::surfaceScalarField & phiRef
virtual

Access the volumetric flux.

Definition at line 148 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ Uf()

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

Return the face velocity.

Required for moving mesh cases

Definition at line 160 of file StationaryPhaseModel.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ UfRef() [1/2]

Foam::surfaceVectorField & UfRef
virtual

Access the face velocity.

Required for moving mesh cases

Definition at line 173 of file StationaryPhaseModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and GeometricField< Type, PatchField, GeoMesh >::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 185 of file StationaryPhaseModel.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and GeometricField< Type, PatchField, GeoMesh >::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 197 of file StationaryPhaseModel.C.

References Foam::dimTime, Foam::dimVolume, IOobject::groupName(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ alphaPhiRef() [1/2]

Foam::surfaceScalarField & alphaPhiRef
virtual

Access the volumetric flux of the phase.

Definition at line 210 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ alphaPhiRef() [2/2]

const Foam::surfaceScalarField & alphaPhiRef
virtual

Access the volumetric flux of the phase.

Definition at line 222 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ alphaRhoPhi()

Foam::tmp< Foam::surfaceScalarField > alphaRhoPhi
virtual

Return the mass flux of the phase.

Definition at line 234 of file StationaryPhaseModel.C.

References Foam::dimMass, Foam::dimTime, IOobject::groupName(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ alphaRhoPhiRef() [1/2]

Foam::surfaceScalarField & alphaRhoPhiRef
virtual

Access the mass flux of the phase.

Definition at line 247 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ alphaRhoPhiRef() [2/2]

const Foam::surfaceScalarField & alphaRhoPhiRef
virtual

Access the mass flux of the phase.

Definition at line 259 of file StationaryPhaseModel.C.

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

Here is the call graph for this function:

◆ DUDt()

Return the substantive acceleration.

Definition at line 271 of file StationaryPhaseModel.C.

References Foam::dimTime, Foam::dimVelocity, IOobject::groupName(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::Zero.

Here is the call graph for this function:

◆ DUDtf()

Return the substantive acceleration on the faces.

Definition at line 284 of file StationaryPhaseModel.C.

References Foam::dimTime, Foam::dimVolume, IOobject::groupName(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqr().

Here is the call graph for this function:

◆ continuityError()

Foam::tmp< Foam::volScalarField > continuityError
virtual

Return the continuity error.

Definition at line 297 of file StationaryPhaseModel.C.

References Foam::dimDensity, Foam::dimTime, IOobject::groupName(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ K()

Return the phase kinetic energy.

Definition at line 310 of file StationaryPhaseModel.C.

References Foam::dimVelocity, IOobject::groupName(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqr().

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 323 of file StationaryPhaseModel.C.

◆ divU() [2/2]

void divU ( tmp< volScalarField divU)
virtual

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

Definition at line 331 of file StationaryPhaseModel.C.

References Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

◆ kappaEff()

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

Return the effective thermal conductivity on a patch.

Definition at line 344 of file StationaryPhaseModel.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), basicThermo::kappa(), patchi, and thermo.

Here is the call graph for this function:

◆ k()

Return the turbulent kinetic energy.

Definition at line 352 of file StationaryPhaseModel.C.

References Foam::dimVelocity, IOobject::groupName(), Foam::name(), GeometricField< Type, PatchField, GeoMesh >::New(), and Foam::sqr().

Here is the call graph for this function:

◆ pPrime()

Foam::tmp< Foam::volScalarField > pPrime
virtual

Return the phase-pressure'.

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

Definition at line 365 of file StationaryPhaseModel.C.

References Foam::dimPressure, IOobject::groupName(), Foam::name(), and GeometricField< Type, PatchField, GeoMesh >::New().

Here is the call graph for this function:

◆ divq()

Foam::tmp< Foam::fvScalarMatrix > divq ( volScalarField he) const
virtual

Return the source term for the energy equation.

Definition at line 378 of file StationaryPhaseModel.C.

References alpha(), he(), Foam::fvc::interpolate(), Foam::fvc::laplacian(), Foam::fvm::laplacianCorrection(), IOobject::name(), Foam::T(), and thermo.

Here is the call graph for this function:

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