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

cellLimitedGrad.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::fv::cellLimitedGrad
00026 
00027 Description
00028     cellLimitedGrad gradient scheme applied to a runTime selected base gradient
00029     scheme.
00030 
00031     The scalar limiter based on limiting the extrapolated face values
00032     between the maximum and minumum cell and cell neighbour values and is
00033     applied to all components of the gradient.
00034 
00035 SourceFiles
00036     cellLimitedGrad.C
00037 
00038 \*---------------------------------------------------------------------------*/
00039 
00040 #ifndef cellLimitedGrad_H
00041 #define cellLimitedGrad_H
00042 
00043 #include <finiteVolume/gradScheme.H>
00044 
00045 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00046 
00047 namespace Foam
00048 {
00049 
00050 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00051 
00052 namespace fv
00053 {
00054 
00055 /*---------------------------------------------------------------------------*\
00056                        Class cellLimitedGrad Declaration
00057 \*---------------------------------------------------------------------------*/
00058 
00059 template<class Type>
00060 class cellLimitedGrad
00061 :
00062     public fv::gradScheme<Type>
00063 {
00064     // Private Data
00065 
00066         tmp<fv::gradScheme<Type> > basicGradScheme_;
00067 
00068         //- Limiter coefficient
00069         const scalar k_;
00070 
00071 
00072     // Private Member Functions
00073 
00074         //- Disallow default bitwise copy construct
00075         cellLimitedGrad(const cellLimitedGrad&);
00076 
00077         //- Disallow default bitwise assignment
00078         void operator=(const cellLimitedGrad&);
00079 
00080 
00081 public:
00082 
00083     //- RunTime type information
00084     TypeName("cellLimited");
00085 
00086 
00087     // Constructors
00088 
00089         //- Construct from mesh and schemeData
00090         cellLimitedGrad(const fvMesh& mesh, Istream& schemeData)
00091         :
00092             gradScheme<Type>(mesh),
00093             basicGradScheme_(fv::gradScheme<Type>::New(mesh, schemeData)),
00094             k_(readScalar(schemeData))
00095         {
00096             if (k_ < 0 || k_ > 1)
00097             {
00098                 FatalIOErrorIn
00099                 (
00100                     "cellLimitedGrad(const fvMesh&, Istream& schemeData)",
00101                     schemeData
00102                 )   << "coefficient = " << k_
00103                     << " should be >= 0 and <= 1"
00104                     << exit(FatalIOError);
00105             }
00106         }
00107 
00108 
00109     // Member Functions
00110 
00111         static inline void limitFace
00112         (
00113             Type& limiter,
00114             const Type& maxDelta,
00115             const Type& minDelta,
00116             const Type& extrapolate
00117         );
00118 
00119 
00120         tmp
00121         <
00122             GeometricField
00123             <typename outerProduct<vector, Type>::type, fvPatchField, volMesh>
00124         > grad
00125         (
00126             const GeometricField<Type, fvPatchField, volMesh>&
00127         ) const;
00128 };
00129 
00130 
00131 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00132 
00133 } // End namespace fv
00134 
00135 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00136 
00137 } // End namespace Foam
00138 
00139 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00140 
00141 #endif
00142 
00143 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines