src/turbulenceModels/incompressible/turbulenceModel/turbulenceModel.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Namespace
  26     Foam::incompressible::turbulenceModels
  27
  28 Description
  29     Namespace for incompressible turbulence turbulence models.
  30
  31 Class
  32     Foam::incompressible::turbulenceModel
  33
  34 Description
  35     Abstract base class for incompressible turbulence models
  36     (RAS, LES and laminar).
  37
  38 SourceFiles
  39     turbulenceModel.C
  40     newTurbulenceModel.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef turbulenceModel_H
  45 #define turbulenceModel_H
  46
  47 #include "primitiveFieldsFwd.H"
  48 #include "volFieldsFwd.H"
  49 #include "surfaceFieldsFwd.H"
  50 #include "fvMatricesFwd.H"
  51 #include "incompressible/transportModel/transportModel.H"
  52 #include "autoPtr.H"
  53 #include "runTimeSelectionTables.H"
  54
  55 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  56
  57 namespace Foam
  58 {
  59
  60 // Forward declarations
  61 class fvMesh;
  62
  63 namespace incompressible
  64 {
  65
  66 /*---------------------------------------------------------------------------*\
  67                            Class turbulenceModel Declaration
  68 \*---------------------------------------------------------------------------*/
  69
  70 class turbulenceModel
  71 {
  72
  73 protected:
  74
  75     // Protected data
  76
  77         const Time& runTime_;
  78         const fvMesh& mesh_;
  79
  80         const volVectorField& U_;
  81         const surfaceScalarField& phi_;
  82
  83         transportModel& transportModel_;
  84
  85
  86 private:
  87
  88     // Private Member Functions
  89
  90         //- Disallow default bitwise copy construct
  91         turbulenceModel(const turbulenceModel&);
  92
  93         //- Disallow default bitwise assignment
  94         void operator=(const turbulenceModel&);
  95
  96
  97 public:
  98
  99     //- Runtime type information
 100     TypeName("turbulenceModel");
 101
 102
 103     // Declare run-time New selection table
 104
 105 #ifndef SWIG
 106         declareRunTimeNewSelectionTable
 107         (
 108             autoPtr,
 109             turbulenceModel,
 110             turbulenceModel,
 111             (
 112                 const volVectorField& U,
 113                 const surfaceScalarField& phi,
 114                 transportModel& lamTransportModel
 115             ),
 116             (U, phi, lamTransportModel)
 117         );
 118 #endif
 119
 120
 121     // Constructors
 122
 123         //- Construct from components
 124         turbulenceModel
 125         (
 126             const volVectorField& U,
 127             const surfaceScalarField& phi,
 128             transportModel& lamTransportModel
 129         );
 130
 131
 132     // Selectors
 133
 134         //- Return a reference to the selected turbulence model
 135         static autoPtr<incompressible::turbulenceModel> New
 136         (
 137             const volVectorField& U,
 138             const surfaceScalarField& phi,
 139             transportModel& lamTransportModel
 140         );
 141
 142
 143     // Destructor
 144
 145         virtual ~turbulenceModel()
 146         {}
 147
 148
 149     // Member Functions
 150
 151         //- Access function to velocity field
 152         inline const volVectorField& U() const
 153         {
 154             return U_;
 155         }
 156
 157         //- Access function to flux field
 158         inline const surfaceScalarField& phi() const
 159         {
 160             return phi_;
 161         }
 162
 163         //- Access function to incompressible transport model
 164         inline transportModel& transport() const
 165         {
 166             return transportModel_;
 167         }
 168
 169         //- Return the laminar viscosity
 170         const volScalarField& nu() const
 171         {
 172             return transportModel_.nu();
 173         }
 174
 175         //- Return the turbulence viscosity
 176         virtual tmp<volScalarField> nut() const = 0;
 177
 178         //- Return the effective viscosity
 179         virtual tmp<volScalarField> nuEff() const = 0;
 180
 181         //- Return the turbulence kinetic energy
 182         virtual tmp<volScalarField> k() const = 0;
 183
 184         //- Return the turbulence kinetic energy dissipation rate
 185         virtual tmp<volScalarField> epsilon() const = 0;
 186
 187         //- Return the Reynolds stress tensor
 188         virtual tmp<volSymmTensorField> R() const = 0;
 189
 190         //- Return the effective stress tensor including the laminar stress
 191         virtual tmp<volSymmTensorField> devReff() const = 0;
 192
 193         //- Return the source term for the momentum equation
 194         virtual tmp<fvVectorMatrix> divDevReff(volVectorField& U) const = 0;
 195
 196         //- Solve the turbulence equations and correct the turbulence viscosity
 197         virtual void correct() = 0;
 198
 199         //- Read turbulenceProperties dictionary
 200         virtual bool read() = 0;
 201 };
 202
 203
 204 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 205
 206 } // End namespace incompressible
 207 } // End namespace Foam
 208
 209 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 210
 211 #endif
 212
 213 // ************************************************************************* //