laplaceFilter.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-2018 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::laplaceFilter
26 
27 Description
28  Laplace filter for LES
29 
30  \verbatim
31  Kernel as filter as Test filter with ratio 2
32  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33  Box filter: g = delta2/24 -> g = delta2/6
34  Spherical box filter: g = delta2/64 -> g = delta2/16
35  Gaussian filter: g = delta2/24 -> g = delta2/6
36  \endverbatim
37 
38 SourceFiles
39  laplaceFilter.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef laplaceFilter_H
44 #define laplaceFilter_H
45 
46 #include "LESfilter.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class laplaceFilter Declaration
55 \*---------------------------------------------------------------------------*/
56 
57 class laplaceFilter
58 :
59  public LESfilter
60 {
61  // Private data
62 
63  scalar widthCoeff_;
64  volScalarField coeff_;
65 
66 
67  // Private Member Functions
68 
69  //- Disallow default bitwise copy construct and assignment
71  void operator=(const laplaceFilter&);
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("laplace");
78 
79 
80  // Constructors
81 
82  //- Construct from components
83  laplaceFilter(const fvMesh& mesh, scalar widthCoeff);
84 
85  //- Construct from IOdictionary
86  laplaceFilter(const fvMesh& mesh, const dictionary&);
87 
88 
89  //- Destructor
90  virtual ~laplaceFilter()
91  {}
92 
93 
94  // Member Functions
95 
96  //- Read the LESfilter dictionary
97  virtual void read(const dictionary&);
98 
99 
100  // Member Operators
101 
102  virtual tmp<volScalarField> operator()
103  (
104  const tmp<volScalarField>&
105  ) const;
106 
107  virtual tmp<volVectorField> operator()
108  (
109  const tmp<volVectorField>&
110  ) const;
111 
112  virtual tmp<volSymmTensorField> operator()
113  (
115  ) const;
116 
117  virtual tmp<volTensorField> operator()
118  (
119  const tmp<volTensorField>&
120  ) const;
121 };
122 
123 
124 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
125 
126 } // End namespace Foam
127 
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
129 
130 #endif
131 
132 // ************************************************************************* //
Abstract class for LES filters.
Definition: LESfilter.H:54
virtual ~laplaceFilter()
Destructor.
Definition: laplaceFilter.H:89
virtual void read(const dictionary &)
Read the LESfilter dictionary.
Definition: laplaceFilter.C:90
A list of keyword definitions, which are a keyword followed by any number of values (e...
Definition: dictionary.H:137
const fvMesh & mesh() const
Return mesh reference.
Definition: LESfilter.H:134
TypeName("laplace")
Runtime type information.
Laplace filter for LES.
Definition: laplaceFilter.H:56
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
A class for managing temporary objects.
Definition: PtrList.H:53
Namespace for OpenFOAM.