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

Gamma.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::GammaLimiter
00026 
00027 Description
00028     Class with limiter function which returns the limiter for the
00029     Gamma differencing scheme based on phict obtained from the LimiterFunc
00030     class.
00031 
00032     Used in conjunction with the template class LimitedScheme.
00033 
00034 SourceFiles
00035     Gamma.C
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef Gamma_H
00040 #define Gamma_H
00041 
00042 #include <OpenFOAM/vector.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                         Class GammaLimiter Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 template<class LimiterFunc>
00054 class GammaLimiter
00055 :
00056     public LimiterFunc
00057 {
00058     scalar k_;
00059 
00060 public:
00061 
00062     GammaLimiter(Istream& is)
00063     :
00064         k_(readScalar(is))
00065     {
00066         if (k_ < 0 || k_ > 1)
00067         {
00068             FatalIOErrorIn("GammaLimiter(Istream& is)", is)
00069                 << "coefficient = " << k_
00070                 << " should be >= 0 and <= 1"
00071                 << exit(FatalIOError);
00072         }
00073 
00074         // Rescale k_ to be >= 0 and <= 0.5 (TVD conformant)
00075         // and avoid the /0 when k_ = 0
00076         k_ = max(k_/2.0, SMALL);
00077     }
00078 
00079     scalar limiter
00080     (
00081         const scalar cdWeight,
00082         const scalar faceFlux,
00083         const typename LimiterFunc::phiType& phiP,
00084         const typename LimiterFunc::phiType& phiN,
00085         const typename LimiterFunc::gradPhiType& gradcP,
00086         const typename LimiterFunc::gradPhiType& gradcN,
00087         const vector& d
00088     ) const
00089     {
00090         scalar phict = LimiterFunc::phict
00091         (
00092             faceFlux, phiP, phiN, gradcP, gradcN, d
00093         );
00094 
00095         return min(max(phict/k_, 0), 1);
00096     }
00097 };
00098 
00099 
00100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00101 
00102 } // End namespace Foam
00103 
00104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00105 
00106 #endif
00107 
00108 // ************************ vim: set sw=4 sts=4 et: ************************ //
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines