transportModel.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-2013 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::transportModel
 
Description
    Base-class for all transport models used by the incompressible turbulence
    models.
 
SourceFiles
    transportModel.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef transportModel_H
#define transportModel_H
 
#include "primitiveFieldsFwd.H"
#include "volFieldsFwd.H"
#include "surfaceFieldsFwd.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                Class transportModel Declaration
\*---------------------------------------------------------------------------*/
 
class transportModel
{
    // Private Member Functions
 
        //- No copy construct
        transportModel(const transportModel&) = delete;
 
        //- No copy assignment
        void operator=(const transportModel&) = delete;
 
 
public:
 
    //- Runtime type information
    TypeName("transportModel");
 
 
    // Constructors
 
        //- Construct from components
        transportModel
        ();
 
 
    //- Destructor
    virtual ~transportModel();
 
 
    // Member Functions
 
        //- Return the laminar viscosity
        virtual tmp<volScalarField> nu() const = 0;
 
        //- Return the laminar viscosity for patch
        virtual tmp<scalarField> nu(const label patchi) const = 0;
 
        //- Correct the laminar viscosity
        virtual void correct() = 0;
 
        //- Read transportProperties dictionary
        virtual bool read() = 0;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //