src/turbulenceModels/LES/LESfilters/laplaceFilter/laplaceFilter.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright (C) 1991-2008 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::laplaceFilter
  27
  28 Description
  29     Laplace filter for LES
  30
  31     @verbatim
  32     Kernel                 as filter          as Test filter with ratio 2
  33     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  34     Box filter:            g = delta2/24  ->  g = delta2/6
  35     Spherical box filter:  g = delta2/64  ->  g = delta2/16
  36     Gaussian filter:       g = delta2/24  ->  g = delta2/6
  37     @endverbatim
  38
  39 SourceFiles
  40     laplaceFilter.C
  41
  42 \*---------------------------------------------------------------------------*/
  43
  44 #ifndef laplaceFilter_H
  45 #define laplaceFilter_H
  46
  47 #include "LESfilter.H"
  48
  49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  50
  51 namespace Foam
  52 {
  53
  54 /*---------------------------------------------------------------------------*\
  55                            Class laplaceFilter Declaration
  56 \*---------------------------------------------------------------------------*/
  57
  58 class laplaceFilter
  59 :
  60     public LESfilter
  61 {
  62     // Private data
  63
  64         scalar widthCoeff_;
  65         volScalarField coeff_;
  66
  67
  68     // Private Member Functions
  69
  70         //- Disallow default bitwise copy construct and assignment
  71         laplaceFilter(const laplaceFilter&);
  72         void operator=(const laplaceFilter&);
  73
  74
  75 public:
  76
  77     //- Runtime type information
  78     TypeName("laplace");
  79
  80
  81     // Constructors
  82
  83         //- from components
  84         laplaceFilter(const fvMesh& mesh, scalar widthCoeff);
  85
  86         //- from IOdictionary
  87         laplaceFilter(const fvMesh& mesh, const dictionary&);
  88
  89
  90     // Destructor
  91
  92         ~laplaceFilter()
  93         {}
  94
  95
  96     // Member Functions
  97
  98         //- Read the LESfilter dictionary
  99         void read(const dictionary&);
 100
 101
 102     // Member Operators
 103
 104         tmp<volScalarField> operator()(const tmp<volScalarField>&) const;
 105         tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
 106         tmp<volSymmTensorField> operator()
 107         (
 108             const tmp<volSymmTensorField>&
 109         ) const;
 110         tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
 111 };
 112
 113
 114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 115
 116 } // End namespace Foam
 117
 118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 119
 120 #endif
 121
 122 // ************************************************************************* //