Skip to content
Snippets Groups Projects
SpecificIncompressibleTurbulenceModel.H 3.36 KiB
Newer Older
Henry's avatar
Henry committed
/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   \\    /   O peration     |
    \\  /    A nd           | Copyright (C) 2015 OpenFOAM Foundation
Henry's avatar
Henry committed
     \\/     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::SpecificIncompressibleTurbulenceModel
Henry's avatar
Henry committed

Description
    Templated abstract base class for specific (RAS/LES) incompressible
    turbulence models
Henry's avatar
Henry committed

SourceFiles
    SpecificIncompressibleTurbulenceModel.C
Henry's avatar
Henry committed

\*---------------------------------------------------------------------------*/

#ifndef SpecificIncompressibleTurbulenceModel_H
#define SpecificIncompressibleTurbulenceModel_H
Henry's avatar
Henry committed

#include "IncompressibleTurbulenceModel.H"
Henry's avatar
Henry committed

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

namespace Foam
{

/*---------------------------------------------------------------------------*\
           Class SpecificIncompressibleTurbulenceModel Declaration
Henry's avatar
Henry committed
\*---------------------------------------------------------------------------*/

template<class BasicIncompressibleTurbulenceModel>
class SpecificIncompressibleTurbulenceModel
Henry's avatar
Henry committed
:
    public BasicIncompressibleTurbulenceModel
    typedef typename BasicIncompressibleTurbulenceModel::transportModel
        transportModel;

Henry's avatar
Henry committed
    // Constructors

        //- Construct from components
        SpecificIncompressibleTurbulenceModel
Henry's avatar
Henry committed
        (
            const word& type,
            const geometricOneField& alpha,
            const geometricOneField& rho,
Henry's avatar
Henry committed
            const volVectorField& U,
            const surfaceScalarField& alphaRhoPhi,
Henry's avatar
Henry committed
            const surfaceScalarField& phi,
Henry's avatar
Henry committed
        );


    //- Destructor
    virtual ~SpecificIncompressibleTurbulenceModel()
Henry's avatar
Henry committed

        //- Return a reference to the selected turbulence model
        static autoPtr<SpecificIncompressibleTurbulenceModel> New
        (
            const volVectorField& U,
            const surfaceScalarField& phi,
            const transportModel& transport,
            const word& propertiesName = turbulenceModel::propertiesName
        );
Henry's avatar
Henry committed
};


// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

} // End namespace Foam

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

#ifdef NoRepository
#   include "SpecificIncompressibleTurbulenceModel.C"
#endif

// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //

Henry's avatar
Henry committed
#endif

// ************************************************************************* //