anisotropicFilter.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) 2011 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::anisotropicFilter
26 
27 Description
28  anisotropic filter
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  anisotropicFilter.C
40 
41 \*---------------------------------------------------------------------------*/
42 
43 #ifndef anisotropicFilter_H
44 #define anisotropicFilter_H
45 
46 #include "LESfilter.H"
47 
48 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
49 
50 namespace Foam
51 {
52 
53 /*---------------------------------------------------------------------------*\
54  Class anisotropicFilter Declaration
55 \*---------------------------------------------------------------------------*/
56 
58 :
59  public LESfilter
60 {
61  // Private data
62 
63  scalar widthCoeff_;
64  volVectorField coeff_;
65 
66 
67  // Private Member Functions
68 
69  // Disallow default bitwise copy construct and assignment
71  void operator=(const anisotropicFilter&);
72 
73 
74 public:
75 
76  //- Runtime type information
77  TypeName("anisotropic");
78 
79  // Constructors
80 
81  //- Construct from components
82  anisotropicFilter(const fvMesh& mesh, scalar widthCoeff);
83 
84  //- Construct from IOdictionary
85  anisotropicFilter(const fvMesh& mesh, const dictionary&);
86 
87 
88  //- Destructor
89  virtual ~anisotropicFilter()
90  {}
91 
92 
93  // Member Functions
94 
95  //- Read the LESfilter dictionary
96  virtual void read(const dictionary&);
97 
98 
99  // Member Operators
100 
101  virtual tmp<volScalarField> operator()
102  (
103  const tmp<volScalarField>&
104  ) const;
105 
106  virtual tmp<volVectorField> operator()
107  (
108  const tmp<volVectorField>&
109  ) const;
110 
111  virtual tmp<volSymmTensorField> operator()
112  (
114  ) const;
115 
116  virtual tmp<volTensorField> operator()
117  (
118  const tmp<volTensorField>&
119  ) const;
120 };
121 
122 
123 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
124 
125 } // End namespace Foam
126 
127 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
128 
129 #endif
130 
131 // ************************************************************************* //
Abstract class for LES filters.
Definition: LESfilter.H:54
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
anisotropic filter
TypeName("anisotropic")
Runtime type information.
Mesh data needed to do the Finite Volume discretisation.
Definition: fvMesh.H:78
virtual void read(const dictionary &)
Read the LESfilter dictionary.
virtual ~anisotropicFilter()
Destructor.
A class for managing temporary objects.
Definition: PtrList.H:54
Namespace for OpenFOAM.