OpenFOAM logo
Open Source CFD Toolkit

laplaceFilter.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     laplaceFilter
00027 
00028 Description
00029     Kernel                 as filter          as Test filter with ratio 2
00030     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
00031     Box filter:            g = delta2/24  ->  g = delta2/6
00032     Spherical box filter:  g = delta2/64  ->  g = delta2/16
00033     Gaussian filter:       g = delta2/24  ->  g = delta2/6
00034 
00035 SourceFiles
00036     laplaceFilter.C
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef laplaceFilter_H
00041 #define laplaceFilter_H
00042 
00043 #include "LESfilter.H"
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 /*---------------------------------------------------------------------------*\
00051                            Class laplaceFilter Declaration
00052 \*---------------------------------------------------------------------------*/
00053 
00054 class laplaceFilter
00055 :
00056     public LESfilter
00057 {
00058     // Private data
00059 
00060         scalar widthCoeff_;
00061         volScalarField coeff_;
00062 
00063 
00064     // Private Member Functions
00065 
00066         //- Disallow default bitwise copy construct and assignment
00067         laplaceFilter(const laplaceFilter&);
00068         void operator=(const laplaceFilter&);
00069 
00070 
00071 public:
00072 
00073     //- Runtime type information
00074     TypeName("laplace");
00075 
00076 
00077     // Constructors
00078 
00079         //- from components
00080         laplaceFilter(const fvMesh& mesh, scalar widthCoeff);
00081 
00082         //- from IOdictionary
00083         laplaceFilter(const fvMesh& mesh, const dictionary&);
00084 
00085 
00086     // Destructor
00087 
00088         ~laplaceFilter()
00089         {}
00090 
00091 
00092     // Member Functions
00093 
00094         //- Read the LESfilter dictionary
00095         void read(const dictionary&);
00096 
00097 
00098     // Member Operators
00099 
00100         tmp<volScalarField> operator()(const tmp<volScalarField>&) const;
00101         tmp<volVectorField> operator()(const tmp<volVectorField>&) const;
00102         tmp<volTensorField> operator()(const tmp<volTensorField>&) const;
00103 };
00104 
00105 
00106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00107 
00108 } // End namespace Foam
00109 
00110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00111 
00112 #endif
00113 
00114 // ************************************************************************* //
For further information go to www.openfoam.org