MovingPhaseModel.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | www.openfoam.com
     \\/     M anipulation  |
-------------------------------------------------------------------------------
    Copyright (C) 2017 OpenCFD Ltd.
-------------------------------------------------------------------------------
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::MovingPhaseModel
 
Description
    Class which represents a moving fluid phase. Holds the velocity, fluxes and
    turbulence model. Provides access to the turbulent quantities.
 
    Possible future extensions include separating the turbulent fuctionality
    into another layer.
 
SourceFiles
    MovingPhaseModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef MovingPhaseModel_H
#define MovingPhaseModel_H
 
#include "phaseModel.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                           Class phaseModel Declaration
\*---------------------------------------------------------------------------*/
 
template<class BasePhaseModel>
class MovingPhaseModel
:
    public BasePhaseModel
{
    // Private data
 
        //- Reference to U
        const volVectorField& U_;
 
        //- Reference to phi
        const surfaceScalarField& phi_;
 
        //- Volumetric flux
        surfaceScalarField alphaPhi_;
 
 
public:
 
    // Constructors
 
        MovingPhaseModel
        (
            const phaseSystem& fluid,
            const word& phaseName
        );
 
 
    //- Destructor
    virtual ~MovingPhaseModel() = default;
 
 
    // Member Functions
 
        //- Correct the phase properties other than the thermo and turbulence
        virtual void correct();
 
 
        // Momentum
 
            //- Constant access the volumetric flux
            virtual tmp<surfaceScalarField> phi() const;
 
            //- Access the volumetric flux
            virtual const surfaceScalarField& phi();
 
            //- Constant access the volumetric flux of the phase
            virtual tmp<surfaceScalarField> alphaPhi() const;
 
            //- Access the volumetric flux of the phase
            virtual surfaceScalarField& alphaPhi();
 
            //- Access const reference to U
            virtual tmp<volVectorField> U() const;
 
            //- Diffusion number
            virtual tmp<surfaceScalarField> diffNo() const;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
#   include "MovingPhaseModel.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //