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

limitedLinear.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::limitedLinearLimiter
00026 
00027 Description
00028     Class with limiter function which returns the limiter for the
00029     TVD limited linear differencing scheme based on r obtained from the
00030     LimiterFunc class.
00031 
00032     Used in conjunction with the template class LimitedScheme.
00033 
00034 SourceFiles
00035     limitedLinear.C
00036 
00037 \*---------------------------------------------------------------------------*/
00038 
00039 #ifndef limitedLinear_H
00040 #define limitedLinear_H
00041 
00042 #include <OpenFOAM/vector.H>
00043 
00044 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
00045 
00046 namespace Foam
00047 {
00048 
00049 /*---------------------------------------------------------------------------*\
00050                     Class limitedLinearLimiter Declaration
00051 \*---------------------------------------------------------------------------*/
00052 
00053 template<class LimiterFunc>
00054 class limitedLinearLimiter
00055 :
00056     public LimiterFunc
00057 {
00058     scalar k_;
00059     scalar twoByk_;
00060 
00061 public:
00062 
00063     limitedLinearLimiter(Istream& is)
00064     :
00065         k_(readScalar(is))
00066     {
00067         if (k_ < 0 || k_ > 1)
00068         {
00069             FatalIOErrorIn("limitedLinearLimiter(Istream& is)", is)
00070                 << "coefficient = " << k_
00071                 << " should be >= 0 and <= 1"
00072                 << exit(FatalIOError);
00073         }
00074 
00075         // Avoid the /0 when k_ = 0
00076         twoByk_ = 2.0/max(k_, 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 r = LimiterFunc::r
00091         (
00092             faceFlux, phiP, phiN, gradcP, gradcN, d
00093         );
00094 
00095         return max(min(twoByk_*r, 1), 0);
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