SSG.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::RASModels::SSG
 
Description
    Speziale, Sarkar and Gatski Reynolds-stress turbulence model for
    incompressible and compressible flows.
 
    Reference:
    \verbatim
        Speziale, C. G., Sarkar, S., & Gatski, T. B. (1991).
        Modelling the pressure–strain correlation of turbulence:
        an invariant dynamical systems approach.
        Journal of Fluid Mechanics, 227, 245-272.
    \endverbatim
 
    Including the generalised gradient diffusion model of
    Daly and Harlow:
    \verbatim
        Daly, B. J., & Harlow, F. H. (1970).
        Transport equations in turbulence.
        Physics of Fluids (1958-1988), 13(11), 2634-2649.
    \endverbatim
 
    The default model coefficients are:
    \verbatim
        SSGCoeffs
        {
            Cmu             0.09;
 
            C1              3.4;
            C1s             1.8;
            C2              4.2;
            C3              0.8;
            C3s             1.3;
            C4              1.25;
            C5              0.4;
 
            Ceps1           1.44;
            Ceps2           1.92;
            Cs              0.25;
            Ceps            0.15;
 
            couplingFactor  0.0;
        }
    \endverbatim
 
SourceFiles
    SSG.C
 
\*---------------------------------------------------------------------------*/
 
#ifndef SSG_H
#define SSG_H
 
#include "RASModel.H"
#include "ReynoldsStress.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
namespace RASModels
{
 
/*---------------------------------------------------------------------------*\
                             Class SSG Declaration
\*---------------------------------------------------------------------------*/
 
template<class BasicMomentumTransportModel>
class SSG
:
    public ReynoldsStress<RASModel<BasicMomentumTransportModel>>
{
protected:
 
    // Protected data
 
        // Model coefficients
 
            dimensionedScalar Cmu_;
 
            dimensionedScalar C1_;
            dimensionedScalar C1s_;
            dimensionedScalar C2_;
            dimensionedScalar C3_;
            dimensionedScalar C3s_;
            dimensionedScalar C4_;
            dimensionedScalar C5_;
 
            dimensionedScalar Ceps1_;
            dimensionedScalar Ceps2_;
            dimensionedScalar Cs_;
            dimensionedScalar Ceps_;
 
        // Fields
 
            volScalarField k_;
            volScalarField epsilon_;
 
 
    // Protected Member Functions
 
        //- Bound epsilon and return Cmu*sqr(k) for nut
        tmp<volScalarField> boundEpsilon();
 
        //- Correct the eddy-viscosity nut
        virtual void correctNut();
 
        //- Source term for the epsilon equation
        virtual tmp<fvScalarMatrix> epsilonSource() const;
 
 
public:
 
    typedef typename BasicMomentumTransportModel::alphaField alphaField;
    typedef typename BasicMomentumTransportModel::rhoField rhoField;
 
 
    //- Runtime type information
    TypeName("SSG");
 
 
    // Constructors
 
        //- Construct from components
        SSG
        (
            const alphaField& alpha,
            const rhoField& rho,
            const volVectorField& U,
            const surfaceScalarField& alphaRhoPhi,
            const surfaceScalarField& phi,
            const viscosity& viscosity,
            const word& type = typeName
        );
 
        //- Disallow default bitwise copy construction
        SSG(const SSG&) = delete;
 
 
    //- Destructor
    virtual ~SSG()
    {}
 
 
    // Member Functions
 
        //- Read model coefficients if they have changed
        virtual bool read();
 
        //- Return the turbulence kinetic energy
        virtual tmp<volScalarField> k() const
        {
            return k_;
        }
 
        //- Return the turbulence kinetic energy dissipation rate
        virtual tmp<volScalarField> epsilon() const
        {
            return epsilon_;
        }
 
        //- Return the turbulence specific dissipation rate
        virtual tmp<volScalarField> omega() const
        {
            return volScalarField::New
            (
                "omega",
                epsilon_/(Cmu_*k_)
            );
        }
 
        //- Return the effective diffusivity for R
        tmp<volSymmTensorField> DREff() const;
 
        //- Return the effective diffusivity for epsilon
        tmp<volSymmTensorField> DepsilonEff() const;
 
        //- Solve the turbulence equations and correct eddy-Viscosity and
        //  related properties
        virtual void correct();
 
 
    // Member Operators
 
        //- Disallow default bitwise assignment
        void operator=(const SSG&) = delete;
};
 
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace RASModels
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#ifdef NoRepository
    #include "SSG.C"
#endif
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //