src/turbulenceModels/LES/LESdeltas/cubeRootVolDelta/cubeRootVolDelta.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 2004-2010 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
  13     the Free Software Foundation, either version 3 of the License, or
  14     (at your 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, see <http://www.gnu.org/licenses/>.
  23
  24 Class
  25     Foam::cubeRootVolDelta
  26
  27 Description
  28     Simple cube-root of cell volume delta used in LES models.
  29
  30 SourceFiles
  31     cubeRootVolDelta.C
  32
  33 \*---------------------------------------------------------------------------*/
  34
  35 #ifndef cubeRootVolDelta_H
  36 #define cubeRootVolDelta_H
  37
  38 #include "LESdelta.H"
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 namespace Foam
  43 {
  44
  45 /*---------------------------------------------------------------------------*\
  46                            Class cubeRootVolDelta Declaration
  47 \*---------------------------------------------------------------------------*/
  48
  49 class cubeRootVolDelta
  50 :
  51     public LESdelta
  52 {
  53     // Private data
  54
  55         scalar deltaCoeff_;
  56
  57
  58     // Private Member Functions
  59
  60         //- Disallow default bitwise copy construct and assignment
  61         cubeRootVolDelta(const cubeRootVolDelta&);
  62         void operator=(const cubeRootVolDelta&);
  63
  64         // Calculate the delta values
  65         void calcDelta();
  66
  67
  68 public:
  69
  70     //- Runtime type information
  71     TypeName("cubeRootVol");
  72
  73
  74     // Constructors
  75
  76         //- Construct from name, mesh and IOdictionary
  77         cubeRootVolDelta
  78         (
  79             const word& name,
  80             const fvMesh& mesh,
  81             const dictionary&
  82         );
  83
  84
  85     //- Destructor
  86     virtual ~cubeRootVolDelta()
  87     {}
  88
  89
  90     // Member Functions
  91
  92         //- Read the LESdelta dictionary
  93         virtual void read(const dictionary&);
  94
  95         // Correct values
  96         virtual void correct();
  97 };
  98
  99
 100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 101
 102 } // End namespace Foam
 103
 104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 105
 106 #endif
 107
 108 // ************************************************************************* //