simpleFilter.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2020 OpenFOAM Foundation
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 "LESfilter.H"
41 
42 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 
44 namespace Foam
45 {
46 
47 /*---------------------------------------------------------------------------*\
48  Class simpleFilter Declaration
49 \*---------------------------------------------------------------------------*/
50 
51 class simpleFilter
52 :
53  public LESfilter
54 
55 {
56 public:
57 
58  //- Runtime type information
59  TypeName("simple");
60 
61 
62  // Constructors
63 
64  //- Construct from components
65  simpleFilter(const fvMesh& mesh);
66 
67  //- Construct from IOdictionary
68  simpleFilter(const fvMesh& mesh, const dictionary&);
69 
70  //- Disallow default bitwise copy construction
71  simpleFilter(const simpleFilter&) = delete;
72 
73 
74  //- Destructor
75  virtual ~simpleFilter()
76  {}
77 
78 
79  // Member Functions
80 
81  //- Read the LESfilter dictionary
82  virtual void read(const dictionary&);
83 
84 
85  // Member Operators
86 
87  virtual tmp<volScalarField> operator()
88  (
89  const tmp<volScalarField>&
90  ) const;
91 
92  virtual tmp<volVectorField> operator()
93  (
94  const tmp<volVectorField>&
95  ) const;
96 
97  virtual tmp<volSymmTensorField> operator()
98  (
100  ) const;
101 
102  virtual tmp<volTensorField> operator()
103  (
104  const tmp<volTensorField>&
105  ) const;
106 
107 
108  // Member Operators
109 
110  //- Disallow default bitwise assignment
111  void operator=(const simpleFilter&) = delete;
112 };
113 
114 
115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
116 
117 } // End namespace Foam
118 
119 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
120 
121 #endif
122 
123 // ************************************************************************* //
Abstract class for LES filters.
Definition: LESfilter.H:55
const fvMesh & mesh() const
Return mesh reference.
Definition: LESfilter.H:130
A list of keyword definitions, which are a keyword followed by any number of values (e....
Definition: dictionary.H:162
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:99
Simple top-hat filter used in dynamic LES models.
Definition: simpleFilter.H:54
void operator=(const simpleFilter &)=delete
Disallow default bitwise assignment.
simpleFilter(const fvMesh &mesh)
Construct from components.
Definition: simpleFilter.C:43
TypeName("simple")
Runtime type information.
virtual void read(const dictionary &)
Read the LESfilter dictionary.
Definition: simpleFilter.C:59
virtual ~simpleFilter()
Destructor.
Definition: simpleFilter.H:74
A class for managing temporary objects.
Definition: tmp.H:55
Namespace for OpenFOAM.