src/turbulenceModels/LES/LESdeltas/LESdelta/LESdelta.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::LESdelta
  27
  28 Description
  29     Abstract base class for LES deltas
  30
  31 SourceFiles
  32     LESdelta.C
  33     newDelta.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef LESdelta_H
  38 #define LESdelta_H
  39
  40 #include "volFields.H"
  41 #include "typeInfo.H"
  42 #include "autoPtr.H"
  43 #include "runTimeSelectionTables.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 class fvMesh;
  51
  52 /*---------------------------------------------------------------------------*\
  53                           Class LESdelta Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class LESdelta
  57 {
  58
  59 protected:
  60
  61     // Protected data
  62
  63         const fvMesh& mesh_;
  64
  65         volScalarField delta_;
  66
  67
  68 private:
  69
  70     // Private Member Functions
  71
  72         // Disallow default bitwise copy construct and assignment
  73         LESdelta(const LESdelta&);
  74         void operator=(const LESdelta&);
  75
  76
  77 public:
  78
  79     //- Runtime type information
  80     TypeName("LESdelta");
  81
  82
  83     // Declare run-time constructor selection table
  84
  85         declareRunTimeSelectionTable
  86         (
  87             autoPtr,
  88             LESdelta,
  89             dictionary,
  90             (
  91                 const word& name,
  92                 const fvMesh& mesh,
  93                 const dictionary& LESdeltaDict
  94             ),
  95             (name, mesh, LESdeltaDict)
  96         );
  97
  98
  99     // Constructors
 100
 101         //- Construct from name and mesh
 102         LESdelta(const word& name, const fvMesh&);
 103
 104
 105     // Selectors
 106
 107         //- Return a reference to the selected LES delta
 108         static autoPtr<LESdelta> New
 109         (
 110             const word& name,
 111             const fvMesh&,
 112             const dictionary&
 113         );
 114
 115
 116     //- Destructor
 117     virtual ~LESdelta()
 118     {}
 119
 120
 121     // Member Functions
 122
 123         //- Return mesh reference
 124         const fvMesh& mesh() const
 125         {
 126             return mesh_;
 127         }
 128
 129         //- Read the LESdelta dictionary
 130         virtual void read(const dictionary&) = 0;
 131
 132         // Correct values
 133         virtual void correct() = 0;
 134
 135
 136     // Member Operators
 137
 138         virtual operator const volScalarField&() const
 139         {
 140             return delta_;
 141         }
 142 };
 143
 144
 145 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 146
 147 } // End namespace Foam
 148
 149 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 150
 151 #endif
 152
 153 // ************************************************************************* //