src/turbulenceModels/LES/LESfilters/LESfilter/LESfilter.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::LESfilter
  27
  28 Description
  29     Abstract class for LES filters
  30
  31 SourceFiles
  32     LESfilter.C
  33     newFilter.C
  34
  35 \*---------------------------------------------------------------------------*/
  36
  37 #ifndef LESfilter_H
  38 #define LESfilter_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 LESfilter Declaration
  54 \*---------------------------------------------------------------------------*/
  55
  56 class LESfilter
  57 {
  58     // Private data
  59
  60         const fvMesh& mesh_;
  61
  62
  63     // Private Member Functions
  64
  65         // Disallow default bitwise copy construct and assignment
  66         LESfilter(const LESfilter&);
  67         void operator=(const LESfilter&);
  68
  69
  70 public:
  71
  72     //- Runtime type information
  73     TypeName("LESfilter");
  74
  75
  76     // Declare run-time constructor selection table
  77
  78         declareRunTimeSelectionTable
  79         (
  80             autoPtr,
  81             LESfilter,
  82             dictionary,
  83             (
  84                 const fvMesh& mesh,
  85                 const dictionary& LESfilterDict
  86             ),
  87             (mesh, LESfilterDict)
  88         );
  89
  90
  91     // Constructors
  92
  93         //- Construct from components
  94         LESfilter(const fvMesh& mesh)
  95         :
  96             mesh_(mesh)
  97         {}
  98
  99
 100     // Selectors
 101
 102         //- Return a reference to the selected LES filter
 103         static autoPtr<LESfilter> New
 104         (
 105             const fvMesh&,
 106             const dictionary&
 107         );
 108
 109
 110     //- Destructor
 111     virtual ~LESfilter()
 112     {}
 113
 114
 115     // Member Functions
 116
 117         //- Return mesh reference
 118         const fvMesh& mesh() const
 119         {
 120             return mesh_;
 121         }
 122
 123         //- Read the LESfilter dictionary
 124         virtual void read(const dictionary&) = 0;
 125
 126
 127     // Member Operators
 128
 129         virtual tmp<volScalarField> operator()
 130         (
 131             const tmp<volScalarField>&
 132         ) const = 0;
 133
 134         virtual tmp<volVectorField> operator()
 135         (
 136             const tmp<volVectorField>&
 137         ) const = 0;
 138
 139         virtual tmp<volSymmTensorField> operator()
 140         (
 141             const tmp<volSymmTensorField>&
 142         ) const = 0;
 143
 144         virtual tmp<volTensorField> operator()
 145         (
 146             const tmp<volTensorField>&
 147         ) const = 0;
 148 };
 149
 150
 151 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 152
 153 } // End namespace Foam
 154
 155 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 156
 157 #endif
 158
 159 // ************************************************************************* //