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

LESfilter.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::LESfilter
00026 
00027 Description
00028     Abstract class for LES filters
00029 
00030 SourceFiles
00031     LESfilter.C
00032     newFilter.C
00033 
00034 \*---------------------------------------------------------------------------*/
00035 
00036 #ifndef LESfilter_H
00037 #define LESfilter_H
00038 
00039 #include <finiteVolume/volFields.H>
00040 #include <OpenFOAM/typeInfo.H>
00041 #include <OpenFOAM/autoPtr.H>
00042 #include <OpenFOAM/runTimeSelectionTables.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 class fvMesh;
00050 
00051 /*---------------------------------------------------------------------------*\
00052                            Class LESfilter Declaration
00053 \*---------------------------------------------------------------------------*/
00054 
00055 class LESfilter
00056 {
00057     // Private data
00058 
00059         const fvMesh& mesh_;
00060 
00061 
00062     // Private Member Functions
00063 
00064         // Disallow default bitwise copy construct and assignment
00065         LESfilter(const LESfilter&);
00066         void operator=(const LESfilter&);
00067 
00068 
00069 public:
00070 
00071     //- Runtime type information
00072     TypeName("LESfilter");
00073 
00074 
00075     // Declare run-time constructor selection table
00076 
00077         declareRunTimeSelectionTable
00078         (
00079             autoPtr,
00080             LESfilter,
00081             dictionary,
00082             (
00083                 const fvMesh& mesh,
00084                 const dictionary& LESfilterDict
00085             ),
00086             (mesh, LESfilterDict)
00087         );
00088 
00089 
00090     // Constructors
00091 
00092         //- Construct from components
00093         LESfilter(const fvMesh& mesh)
00094         :
00095             mesh_(mesh)
00096         {}
00097 
00098 
00099     // Selectors
00100 
00101         //- Return a reference to the selected LES filter
00102         static autoPtr<LESfilter> New
00103         (
00104             const fvMesh&,
00105             const dictionary&
00106         );
00107 
00108 
00109     //- Destructor
00110     virtual ~LESfilter()
00111     {}
00112 
00113 
00114     // Member Functions
00115 
00116         //- Return mesh reference
00117         const fvMesh& mesh() const
00118         {
00119             return mesh_;
00120         }
00121 
00122         //- Read the LESfilter dictionary
00123         virtual void read(const dictionary&) = 0;
00124 
00125 
00126     // Member Operators
00127 
00128         virtual tmp<volScalarField> operator()
00129         (
00130             const tmp<volScalarField>&
00131         ) const = 0;
00132 
00133         virtual tmp<volVectorField> operator()
00134         (
00135             const tmp<volVectorField>&
00136         ) const = 0;
00137 
00138         virtual tmp<volSymmTensorField> operator()
00139         (
00140             const tmp<volSymmTensorField>&
00141         ) const = 0;
00142 
00143         virtual tmp<volTensorField> operator()
00144         (
00145             const tmp<volTensorField>&
00146         ) const = 0;
00147 };
00148 
00149 
00150 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00151 
00152 } // End namespace Foam
00153 
00154 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00155 
00156 #endif
00157 
00158 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines