src/turbulenceModels/LES/LESfilters/simpleFilter/simpleFilter.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::simpleFilter
  27
  28 Description
  29     Simple top-hat filter used in dynamic LES models.
  30
  31     Implemented as a surface integral of the face interpolate of the field.
  32
  33 SourceFiles
  34     simpleFilter.C
  35
  36 \*---------------------------------------------------------------------------*/
  37
  38 #ifndef simpleFilter_H
  39 #define simpleFilter_H
  40
  41 #include "LESfilter.H"
  42
  43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  44
  45 namespace Foam
  46 {
  47
  48 /*---------------------------------------------------------------------------*\
  49                            Class simpleFilter Declaration
  50 \*---------------------------------------------------------------------------*/
  51
  52 class simpleFilter
  53 :
  54     public LESfilter
  55
  56 {
  57     // Private Member Functions
  58
  59         //- Disallow default bitwise copy construct and assignment
  60         simpleFilter(const simpleFilter&);
  61         void operator=(const simpleFilter&);
  62
  63
  64 public:
  65
  66     //- Runtime type information
  67     TypeName("simple");
  68
  69
  70     // Constructors
  71
  72         //- Construct from components
  73         simpleFilter(const fvMesh& mesh);
  74
  75         //- Construct from IOdictionary
  76         simpleFilter(const fvMesh& mesh, const dictionary&);
  77
  78
  79     //- Destructor
  80     virtual ~simpleFilter()
  81     {}
  82
  83
  84     // Member Functions
  85
  86         //- Read the LESfilter dictionary
  87         virtual void read(const dictionary&);
  88
  89
  90     // Member Operators
  91
  92         virtual tmp<volScalarField> operator()(const tmp<volScalarField>&) const;
  93
  94         virtual tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
  95
  96         virtual tmp<volSymmTensorField> operator()
  97         (
  98             const tmp<volSymmTensorField>&
  99         ) const;
 100
 101         virtual tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
 102 };
 103
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 } // End namespace Foam
 108
 109 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 110
 111 #endif
 112
 113 // ************************************************************************* //