singlePhaseTransportModel.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) 2011-2016 OpenFOAM Foundation
-------------------------------------------------------------------------------
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::singlePhaseTransportModel
 
Description
    A simple single-phase transport model based on viscosityModel.
 
    Used by the incompressible single-phase solvers like simpleFoam,
    pimpleFoam etc.
 
SourceFiles
    singlePhaseTransportModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef singlePhaseTransportModel_H
#define singlePhaseTransportModel_H
 
#include "incompressible/transportModel/transportModel.H"
#include "IOdictionary.H"
#include "autoPtr.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
class viscosityModel;
 
/*---------------------------------------------------------------------------*\
                Class singlePhaseTransportModel Declaration
\*---------------------------------------------------------------------------*/
 
class singlePhaseTransportModel
:
    public IOdictionary,
    public transportModel
{
    // Private Data
 
        autoPtr<viscosityModel> viscosityModelPtr_;
 
 
    // Private Member Functions
 
        //- No copy construct
        singlePhaseTransportModel(const singlePhaseTransportModel&) = delete;
 
        //- No copy assignment
        void operator=(const singlePhaseTransportModel&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("singlePhaseTransportModel");
 
 
    // Constructors
 
        //- Construct from components
        singlePhaseTransportModel
        (
            const volVectorField& U,
            const surfaceScalarField& phi
        );
 
 
    //- Destructor
    virtual ~singlePhaseTransportModel();
 
 
    // Member Functions
 
        //- Return the laminar viscosity
        virtual tmp<volScalarField> nu() const;
 
        //- Return the laminar viscosity for patch
        virtual tmp<scalarField> nu(const label patchi) const;
 
        //- Correct the laminar viscosity
        virtual void correct();
 
        //- Read transportProperties dictionary
        virtual bool read();
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //