FreeFOAM The Cross-Platform CFD Toolkit
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) 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::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 <LESfilters/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
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()(const tmp<volScalarField>&) const;
102 
103  virtual tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
104 
105  virtual tmp<volSymmTensorField> operator()
106  (
108  ) const;
109 
110  virtual tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
111 };
112 
113 
114 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
115 
116 } // End namespace Foam
117 
118 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
119 
120 #endif
121 
122 // ************************ vim: set sw=4 sts=4 et: ************************ //