DASpalartAllmarasFv3FieldInversion.H

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 
    DAFoam  : Discrete Adjoint with OpenFOAM
    Version : v3
 
    Description:
    Child class for the SpalartAllmarasFv3 model with a betaFieldInversion field multiplying 
    to the production term. This betaFieldInversion term can then be trained to improve the
    SA turbulence model.
 
    This file is modified from OpenFOAM's source code
    src/TurbulenceModels/turbulenceModels/RAS/SpalartAllmaras/SpalartAllmaras.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 DASpalartAllmarasFv3FieldInversion_H
#define DASpalartAllmarasFv3FieldInversion_H
 
#include "DATurbulenceModel.H"
#include "addToRunTimeSelectionTable.H"
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
namespace Foam
{
 
/*---------------------------------------------------------------------------*\
                       Class DASpalartAllmarasFv3FieldInversion Declaration
\*---------------------------------------------------------------------------*/
 
class DASpalartAllmarasFv3FieldInversion
    : public DATurbulenceModel
{
 
protected:
 
    dimensionedScalar sigmaNut_;
    dimensionedScalar kappa_;
    dimensionedScalar Cb1_;
    dimensionedScalar Cb2_;
    dimensionedScalar Cw1_;
    dimensionedScalar Cw2_;
    dimensionedScalar Cw3_;
    dimensionedScalar Cv1_;
    dimensionedScalar Cv2_;
 
 
    tmp<volScalarField> chi() const;
 
    tmp<volScalarField> fv1(const volScalarField& chi) const;
 
    tmp<volScalarField> fv2(
        const volScalarField& chi,
        const volScalarField& fv1) const;
 
    tmp<volScalarField> fv3(
        const volScalarField& chi,
        const volScalarField& fv1) const;
 
    tmp<volScalarField> fw(const volScalarField& Stilda) const;
 
 
 
    volScalarField& nuTilda_;
    volScalarField nuTildaRes_;
    volScalarField nuTildaResPartDeriv_;
 
    volScalarField& betaFieldInversion_; 
 
    volVectorField UData_; 
 
    volScalarField surfaceFriction_;
 
    volScalarField surfaceFrictionData_; 
 
    volScalarField pData_; 
 
    volScalarField USingleComponentData_; 
 
    const volScalarField& y_;
 
    label solveTurbState_ = 0;
 
    label printInterval_;
 
public:
    TypeName("SpalartAllmarasFv3FieldInversion");
    // Constructors
 
    //- Construct from components
    DASpalartAllmarasFv3FieldInversion(
        const word modelType,
        const fvMesh& mesh,
        const DAOption& daOption);
 
    //- Destructor
    virtual ~DASpalartAllmarasFv3FieldInversion()
    {
    }
 
    // Member functions
 
    tmp<volScalarField> DnuTildaEff() const;
 
    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();
 
    virtual void getTurbProdTerm(scalarList& prodTerm) const;
};
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
} // End namespace Foam
 
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 
#endif
 
// ************************************************************************* //