laplaceFilter.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 | www.openfoam.com
6  \\/ M anipulation |
7 -------------------------------------------------------------------------------
8  Copyright (C) 2011 OpenFOAM Foundation
9 -------------------------------------------------------------------------------
10 License
11  This file is part of OpenFOAM.
12 
13  OpenFOAM is free software: you can redistribute it and/or modify it
14  under the terms of the GNU General Public License as published by
15  the Free Software Foundation, either version 3 of the License, or
16  (at your option) any later version.
17 
18  OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
20  FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21  for more details.
22 
23  You should have received a copy of the GNU General Public License
24  along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
25 
26 Class
27  Foam::laplaceFilter
28 
29 Description
30  Laplace filter for LES
31 
32  \verbatim
33  Kernel as filter as Test filter with ratio 2
34  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
35  Box filter: g = delta2/24 -> g = delta2/6
36  Spherical box filter: g = delta2/64 -> g = delta2/16
37  Gaussian filter: g = delta2/24 -> g = delta2/6
38  \endverbatim
39 
40 SourceFiles
41  laplaceFilter.C
42 
43 \*---------------------------------------------------------------------------*/
44 
45 #ifndef laplaceFilter_H
46 #define laplaceFilter_H
47 
48 #include "LESfilter.H"
49 
50 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 
52 namespace Foam
53 {
54 
55 /*---------------------------------------------------------------------------*\
56  Class laplaceFilter Declaration
57 \*---------------------------------------------------------------------------*/
58 
59 class laplaceFilter
60 :
61  public LESfilter
62 {
63  // Private data
64 
65  scalar widthCoeff_;
66  volScalarField coeff_;
67 
68 
69  // Private Member Functions
70 
71  //- No copy construct
72  laplaceFilter(const laplaceFilter&) = delete;
73 
74  //- No copy assignment
75  void operator=(const laplaceFilter&) = delete;
76 
77 
78 public:
79 
80  //- Runtime type information
81  TypeName("laplace");
82 
83 
84  // Constructors
85 
86  //- Construct from components
87  laplaceFilter(const fvMesh& mesh, scalar widthCoeff);
88 
89  //- Construct from IOdictionary
90  laplaceFilter(const fvMesh& mesh, const dictionary&);
91 
92 
93  //- Destructor
94  virtual ~laplaceFilter() = default;
95 
96 
97  // Member Functions
98 
99  //- Read the LESfilter dictionary
100  virtual void read(const dictionary&);
101 
102 
103  // Member Operators
104 
105  virtual tmp<volScalarField> operator()
106  (
107  const tmp<volScalarField>&
108  ) const;
109 
110  virtual tmp<volVectorField> operator()
111  (
112  const tmp<volVectorField>&
113  ) const;
114 
115  virtual tmp<volSymmTensorField> operator()
116  (
118  ) const;
119 
120  virtual tmp<volTensorField> operator()
121  (
122  const tmp<volTensorField>&
123  ) const;
124 };
125 
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 } // End namespace Foam
130 
131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
132 
133 #endif
134 
135 // ************************************************************************* //
Foam::laplaceFilter::read
virtual void read(const dictionary &)
Read the LESfilter dictionary.
Definition: laplaceFilter.C:92
Foam::laplaceFilter::TypeName
TypeName("laplace")
Runtime type information.
Foam::tmp< volScalarField >
Foam::LESfilter::mesh
const fvMesh & mesh() const
Return mesh reference.
Definition: LESfilter.H:138
LESfilter.H
Foam::laplaceFilter::~laplaceFilter
virtual ~laplaceFilter()=default
Destructor.
Foam::laplaceFilter
Laplace filter for LES.
Definition: laplaceFilter.H:58
Foam::dictionary
A list of keyword definitions, which are a keyword followed by a number of values (eg,...
Definition: dictionary.H:121
Foam::LESfilter
Abstract class for LES filters.
Definition: LESfilter.H:57
Foam::fvMesh
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:84
Foam
Namespace for OpenFOAM.
Definition: atmBoundaryLayer.C:33
Foam::GeometricField< scalar, fvPatchField, volMesh >