DAkEpsilon.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v4
 
    Description:
    Child class for the kEpsilon model
 
    This file is modified from OpenFOAM's source code
    src/TurbulenceModels/turbulenceModels/RAS/kEpsilon/kEpsilon.H
 
    OpenFOAM: The Open Source CFD Toolbox
 
    Copyright (C): 2011-2016 OpenFOAM Foundation
 
    OpenFOAM License:
 
        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/>.
 
\*---------------------------------------------------------------------------*/
 
#ifndef DAkEpsilon_H
#define DAkEpsilon_H
 
#include "DATurbulenceModel.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DAkEpsilon Declaration
\*---------------------------------------------------------------------------*/
 
class DAkEpsilon
    : public DATurbulenceModel
{
 
protected:
 
    dimensionedScalar Cmu_;
    dimensionedScalar C1_;
    dimensionedScalar C2_;
    dimensionedScalar C3_;
    dimensionedScalar sigmak_;
    dimensionedScalar sigmaEps_;
 
 
    tmp<fvScalarMatrix> kSource() const;
    tmp<fvScalarMatrix> epsilonSource() const;
    //- Return the effective diffusivity for k
    tmp<volScalarField> DkEff() const;
    //- Return the effective diffusivity for epsilon
    tmp<volScalarField> DepsilonEff() const;
    //- 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_;
    }
 
 
    volScalarField& epsilon_;
    volScalarField epsilonRes_;
    volScalarField& k_;
    volScalarField kRes_;
 
    autoPtr<volScalarField::Internal> GPtr_;
 
    volScalarField betaFIK_;
    volScalarField betaFIEpsilon_;
 
    scalarList epsilonNearWall_;
 
    label solveTurbState_ = 0;
 
public:
    TypeName("kEpsilon");
    // Constructors
 
    //- Construct from components
    DAkEpsilon(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption);
 
    //- Destructor
    virtual ~DAkEpsilon()
    {
    }
 
    // Member functions
 
    virtual void correctModelStates(wordList& modelStates) const;
 
    virtual void correctNut();
 
    virtual void correctBoundaryConditions();
 
    virtual void updateIntermediateVariables();
 
    virtual void correctStateResidualModelCon(List<List<word>>& stateCon) const;
 
    virtual void addModelResidualCon(HashTable<List<List<word>>>& allCon) const;
 
    virtual void calcResiduals(const dictionary& options);
 
    virtual void correct(label printToScreen);
 
    void saveEpsilonNearWall();
 
    void setEpsilonNearWall();
 
    void correctEpsilonBoundaryConditions();
 
    virtual void getFvMatrixFields(
        const word varName,
        scalarField& diag,
        scalarField& upper,
        scalarField& lower);
 
    virtual void getTurbProdOverDestruct(volScalarField& PoD) const;
 
    virtual void getTurbConvOverProd(volScalarField& CoP) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //