src/turbulenceModels/LES/incompressible/scaleSimilarity/scaleSimilarity.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 OpenCFD Ltd.
   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 Class
  26     Foam::incompressible::LESModels::scaleSimilarity
  27
  28 Description
  29     General base class for all scale similarity models
  30     for incompressible flows.
  31
  32     Since such models do not work without additional eddy viscosity terms,
  33     this class must be combined with an eddy viscosity model of some form.
  34
  35 SourceFiles
  36     scaleSimilarity.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef scaleSimilarity_H
  41 #define scaleSimilarity_H
  42
  43 #include "LESModel.H"
  44 #include "LESfilter.H"
  45
  46 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  47
  48 namespace Foam
  49 {
  50 namespace incompressible
  51 {
  52 namespace LESModels
  53 {
  54
  55 /*---------------------------------------------------------------------------*\
  56                            Class scaleSimilarity Declaration
  57 \*---------------------------------------------------------------------------*/
  58
  59 class scaleSimilarity
  60 :
  61     virtual public LESModel
  62 {
  63     // Private data
  64
  65         autoPtr<LESfilter> filterPtr_;
  66         LESfilter& filter_;
  67
  68
  69     // Private Member Functions
  70
  71         // Disallow default bitwise copy construct and assignment
  72         scaleSimilarity(const scaleSimilarity&);
  73         scaleSimilarity& operator=(const scaleSimilarity&);
  74
  75
  76 public:
  77
  78     //- Runtime type information
  79     TypeName("scaleSimilarity");
  80
  81     // Constructors
  82
  83         //- Construct from components
  84         scaleSimilarity
  85         (
  86             const volVectorField& U,
  87             const surfaceScalarField& phi,
  88             transportModel& transport
  89         );
  90
  91
  92     // Destructor
  93
  94         ~scaleSimilarity();
  95
  96
  97     // Member Functions
  98
  99         //- Return the SGS turbulent kinetic energy.
 100         tmp<volScalarField> k() const;
 101
 102         //- Return the SGS turbulent dissipation.
 103         tmp<volScalarField> epsilon() const;
 104
 105         //- Return the sub-grid stress tensor.
 106         tmp<volSymmTensorField> B() const;
 107
 108         //- Return the deviatoric part of the effective sub-grid
 109         //  turbulence stress tensor including the laminar stress
 110         tmp<volSymmTensorField> devBeff() const;
 111
 112         //- Return the deviatoric part of the divergence of Beff
 113         //  i.e. the additional term in the filtered NSE.
 114         tmp<fvVectorMatrix> divDevBeff(volVectorField& U) const;
 115
 116         //- Correct Eddy-Viscosity and related properties
 117         void correct(const tmp<volTensorField>&);
 118
 119         //- Read turbulenceProperties dictionary
 120         bool read();
 121 };
 122
 123
 124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 125
 126 } // End namespace LESModels
 127 } // End namespace incompressible
 128 } // End namespace Foam
 129
 130 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 131
 132 #endif
 133
 134 // ************************************************************************* //