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) 1991-2009 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::cubeRootVolDelta
  27
  28 Description
  29     Simple cube-root of cell volume delta used in LES models.
  30
  31 SourceFiles
  32     cubeRootVolDelta.C
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef cubeRootVolDelta_H
  37 #define cubeRootVolDelta_H
  38
  39 #include "LESdelta.H"
  40
  41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  42
  43 namespace Foam
  44 {
  45
  46 /*---------------------------------------------------------------------------*\
  47                            Class cubeRootVolDelta Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 class cubeRootVolDelta
  51 :
  52     public LESdelta
  53 {
  54     // Private data
  55
  56         scalar deltaCoeff_;
  57
  58
  59     // Private Member Functions
  60
  61         //- Disallow default bitwise copy construct and assignment
  62         cubeRootVolDelta(const cubeRootVolDelta&);
  63         void operator=(const cubeRootVolDelta&);
  64
  65         // Calculate the delta values
  66         void calcDelta();
  67
  68
  69 public:
  70
  71     //- Runtime type information
  72     TypeName("cubeRootVol");
  73
  74
  75     // Constructors
  76
  77         //- Construct from name, mesh and IOdictionary
  78         cubeRootVolDelta
  79         (
  80             const word& name,
  81             const fvMesh& mesh,
  82             const dictionary&
  83         );
  84
  85
  86     //- Destructor
  87     virtual ~cubeRootVolDelta()
  88     {}
  89
  90
  91     // Member Functions
  92
  93         //- Read the LESdelta dictionary
  94         virtual void read(const dictionary&);
  95
  96         // Correct values
  97         virtual void correct();
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //