StationaryPhaseModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     | Website:  https://openfoam.org
    \\  /    A nd           | Copyright (C) 2015-2023 OpenFOAM Foundation
     \\/     M anipulation  |
-------------------------------------------------------------------------------
License
    This file is part of OpenFOAM.
 
    OpenFOAM is free software: you can redistribute it and/or modify it
    under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
    for more details.
 
    You should have received a copy of the GNU General Public License
    along with OpenFOAM.  If not, see <http://www.gnu.org/licenses/>.
 
Class
    Foam::StationaryPhaseModel
 
Description
    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
 
SourceFiles
    StationaryPhaseModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef StationaryPhaseModel_H
#define StationaryPhaseModel_H
 
#include "phaseModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                    Class StationaryPhaseModel Declaration
\*---------------------------------------------------------------------------*/
 
template<class BasePhaseModel>
class StationaryPhaseModel
:
    public BasePhaseModel
{
public:
 
    // Constructors
 
        StationaryPhaseModel
        (
            const phaseSystem& fluid,
            const word& phaseName,
            const bool referencePhase,
            const label index
        );
 
 
    //- Destructor
    virtual ~StationaryPhaseModel();
 
 
    // Member Functions
 
        // Momentum
 
            //- Return whether the phase is stationary
            virtual bool stationary() const;
 
            //- Return the momentum equation
            virtual tmp<fvVectorMatrix> UEqn();
 
            //- Return the momentum equation for the face-based algorithm
            virtual tmp<fvVectorMatrix> UfEqn();
 
            //- Return the velocity
            virtual tmp<volVectorField> U() const;
 
            //- Access the velocity
            virtual volVectorField& URef();
 
            //- Access the velocity
            virtual const volVectorField& URef() const;
 
            //- Return the volumetric flux
            virtual tmp<surfaceScalarField> phi() const;
 
            //- Access the volumetric flux
            virtual surfaceScalarField& phiRef();
 
            //- Access the volumetric flux
            virtual const surfaceScalarField& phiRef() const;
 
            //- Return the face velocity
            //  Required for moving mesh cases
            virtual const autoPtr<surfaceVectorField>& Uf() const;
 
            //- Access the face velocity
            //  Required for moving mesh cases
            virtual surfaceVectorField& UfRef();
 
            //- Access the face velocity
            //  Required for moving mesh cases
            virtual const surfaceVectorField& UfRef() const;
 
            //- Return the volumetric flux of the phase
            virtual tmp<surfaceScalarField> alphaPhi() const;
 
            //- Access the volumetric flux of the phase
            virtual surfaceScalarField& alphaPhiRef();
 
            //- Access the volumetric flux of the phase
            virtual const surfaceScalarField& alphaPhiRef() const;
 
            //- Return the mass flux of the phase
            virtual tmp<surfaceScalarField> alphaRhoPhi() const;
 
            //- Access the mass flux of the phase
            virtual surfaceScalarField& alphaRhoPhiRef();
 
            //- Access the mass flux of the phase
            virtual const surfaceScalarField& alphaRhoPhiRef() const;
 
            //- Return the substantive acceleration
            virtual tmp<volVectorField> DUDt() const;
 
            //- Return the substantive acceleration on the faces
            virtual tmp<surfaceScalarField> DUDtf() const;
 
            //- Return the continuity error
            virtual tmp<volScalarField> continuityError() const;
 
            //- Return the phase kinetic energy
            virtual tmp<volScalarField> K() const;
 
 
        // Compressibility (variable density)
 
            //- Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi))
            virtual const autoPtr<volScalarField>& divU() const;
 
            //- Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi))
            virtual void divU(tmp<volScalarField> divU);
 
 
        // Momentum transport
 
            //- Return the effective thermal conductivity on a patch
            virtual tmp<scalarField> kappaEff(const label patchi) const;
 
            //- Return the turbulent kinetic energy
            virtual tmp<volScalarField> k() const;
 
            //- Return the phase-pressure'
            //  (derivative of phase-pressure w.r.t. phase-fraction)
            virtual tmp<volScalarField> pPrime() const;
 
 
        // Thermophysical transport
 
            //- Return the source term for the energy equation
            virtual tmp<fvScalarMatrix> divq(volScalarField& he) const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "StationaryPhaseModel.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //