1 /*---------------------------------------------------------------------------*\
3 \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
5 \\ / A nd | Copyright (C) 1991-2009 OpenCFD Ltd.
7 -------------------------------------------------------------------------------
9 This file is part of OpenFOAM.
11 OpenFOAM is free software; you can redistribute it and/or modify it
12 under the terms of the GNU General Public License as published by the
13 Free Software Foundation; either version 2 of the License, or (at your
14 option) any later version.
16 OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
17 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
18 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
21 You should have received a copy of the GNU General Public License
22 along with OpenFOAM; if not, write to the Free Software Foundation,
23 Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26 Foam::limitedLinearLimiter
29 Class with limiter function which returns the limiter for the
30 TVD limited linear differencing scheme based on r obtained from the
33 Used in conjunction with the template class LimitedScheme.
38 \*---------------------------------------------------------------------------*/
40 #ifndef limitedLinear_H
41 #define limitedLinear_H
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
50 /*---------------------------------------------------------------------------*\
51 Class limitedLinearLimiter Declaration
52 \*---------------------------------------------------------------------------*/
54 template<class LimiterFunc>
55 class limitedLinearLimiter
64 limitedLinearLimiter(Istream& is)
70 FatalIOErrorIn("limitedLinearLimiter(Istream& is)", is)
71 << "coefficient = " << k_
72 << " should be >= 0 and <= 1"
73 << exit(FatalIOError);
76 // Avoid the /0 when k_ = 0
77 twoByk_ = 2.0/max(k_, SMALL);
82 const scalar cdWeight,
83 const scalar faceFlux,
84 const typename LimiterFunc::phiType& phiP,
85 const typename LimiterFunc::phiType& phiN,
86 const typename LimiterFunc::gradPhiType& gradcP,
87 const typename LimiterFunc::gradPhiType& gradcN,
91 scalar r = LimiterFunc::r
93 faceFlux, phiP, phiN, gradcP, gradcN, d
96 return max(min(twoByk_*r, 1), 0);
101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
103 } // End namespace Foam
105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
109 // ************************************************************************* //