FreeFOAM The Cross-Platform CFD Toolkit
simpleFilter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration |
5  \\ / A nd | Copyright (C) 1991-2010 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
13  the Free Software Foundation, either version 3 of the License, or
14  (at your 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, see <http://www.gnu.org/licenses/>.
23 
24 Class
25  Foam::simpleFilter
26 
27 Description
28  Simple top-hat filter used in dynamic LES models.
29 
30  Implemented as a surface integral of the face interpolate of the field.
31 
32 SourceFiles
33  simpleFilter.C
34 
35 \*---------------------------------------------------------------------------*/
36 
37 #ifndef simpleFilter_H
38 #define simpleFilter_H
39 
40 #include <LESfilters/LESfilter.H>
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class simpleFilter Declaration
49 \*---------------------------------------------------------------------------*/
50 
52 :
53  public LESfilter
54 
55 {
56  // Private Member Functions
57 
58  //- Disallow default bitwise copy construct and assignment
59  simpleFilter(const simpleFilter&);
60  void operator=(const simpleFilter&);
61 
62 
63 public:
64 
65  //- Runtime type information
66  TypeName("simple");
67 
68 
69  // Constructors
70 
71  //- Construct from components
72  simpleFilter(const fvMesh& mesh);
73 
74  //- Construct from IOdictionary
75  simpleFilter(const fvMesh& mesh, const dictionary&);
76 
77 
78  //- Destructor
79  virtual ~simpleFilter()
80  {}
81 
82 
83  // Member Functions
84 
85  //- Read the LESfilter dictionary
86  virtual void read(const dictionary&);
87 
88 
89  // Member Operators
90 
92 
94 
95  virtual tmp<volSymmTensorField> operator()
96  (
98  ) const;
99 
100  virtual tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
101 };
102 
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 } // End namespace Foam
107 
108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 
110 #endif
111 
112 // ************************ vim: set sw=4 sts=4 et: ************************ //