FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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-2010 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
00013     the Free Software Foundation, either version 3 of the License, or
00014     (at your 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, see <http://www.gnu.org/licenses/>.
00023 
00024 Class
00025     Foam::simpleFilter
00026 
00027 Description
00028     Simple top-hat filter used in dynamic LES models.
00029 
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 <LESfilters/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         //- Construct from components
00072         simpleFilter(const fvMesh& mesh);
00073 
00074         //- Construct from IOdictionary
00075         simpleFilter(const fvMesh& mesh, const dictionary&);
00076 
00077 
00078     //- Destructor
00079     virtual ~simpleFilter()
00080     {}
00081 
00082 
00083     // Member Functions
00084 
00085         //- Read the LESfilter dictionary
00086         virtual void read(const dictionary&);
00087 
00088 
00089     // Member Operators
00090 
00091         virtual tmp<volScalarField> operator()(const tmp<volScalarField>&) const;
00092 
00093         virtual tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
00094 
00095         virtual tmp<volSymmTensorField> operator()
00096         (
00097             const tmp<volSymmTensorField>&
00098         ) const;
00099 
00100         virtual tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
00101 };
00102 
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 } // End namespace Foam
00107 
00108 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00109 
00110 #endif
00111 
00112 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines