OpenFOAM logo
Open Source CFD Toolkit

simpleFilter.H

Go to the documentation of this file.
00001 /*---------------------------------------------------------------------------*\
00002   =========                 |
00003   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
00004    \\    /   O peration     |
00005     \\  /    A nd           | Copyright (C) 1991-2005 OpenCFD Ltd.
00006      \\/     M anipulation  |
00007 -------------------------------------------------------------------------------
00008 License
00009     This file is part of OpenFOAM.
00010 
00011     OpenFOAM is free software; you can redistribute it and/or modify it
00012     under the terms of the GNU General Public License as published by the
00013     Free Software Foundation; either version 2 of the License, or (at your
00014     option) any later version.
00015 
00016     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
00017     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00018     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
00019     for more details.
00020 
00021     You should have received a copy of the GNU General Public License
00022     along with OpenFOAM; if not, write to the Free Software Foundation,
00023     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
00024 
00025 Class
00026     simpleFilter
00027 
00028 Description
00029     Simple top-hat filter used in dynamic LES models.
00030     Implemented as a surface integral of the face interpolate of the field.
00031 
00032 SourceFiles
00033     simpleFilter.C
00034 
00035 \*---------------------------------------------------------------------------*/
00036 
00037 #ifndef simpleFilter_H
00038 #define simpleFilter_H
00039 
00040 #include "LESfilter.H"
00041 
00042 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00043 
00044 namespace Foam
00045 {
00046 
00047 /*---------------------------------------------------------------------------*\
00048                            Class simpleFilter Declaration
00049 \*---------------------------------------------------------------------------*/
00050 
00051 class simpleFilter
00052 :
00053     public LESfilter
00054 
00055 {
00056     // Private Member Functions
00057 
00058         //- Disallow default bitwise copy construct and assignment
00059         simpleFilter(const simpleFilter&);
00060         void operator=(const simpleFilter&);
00061 
00062 
00063 public:
00064 
00065     //- Runtime type information
00066     TypeName("simple");
00067 
00068 
00069     // Constructors
00070 
00071         //- from components
00072         simpleFilter(const fvMesh& mesh);
00073 
00074         //- from IOdictionary
00075         simpleFilter(const fvMesh& mesh, const dictionary&);
00076 
00077 
00078     // Destructor
00079 
00080         ~simpleFilter()
00081         {}
00082 
00083 
00084     // Member Functions
00085 
00086         //- Read the LESfilter dictionary
00087         void read(const dictionary&);
00088 
00089 
00090     // Member Operators
00091 
00092         tmp<volScalarField> operator()(const tmp<volScalarField>&) const;
00093         tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
00094         tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
00095 };
00096 
00097 
00098 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00099 
00100 } // End namespace Foam
00101 
00102 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00103 
00104 #endif
00105 
00106 // ************************************************************************* //
For further information go to www.openfoam.org