initial commit for version 1.6.x patch release
[OpenFOAM-1.6.x.git] / src / finiteVolume / interpolation / surfaceInterpolation / limitedSchemes / QUICK / QUICKV.H
blobf8917861c705577a1415458fa3244d511cfd3954
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 1991-2009 OpenCFD Ltd.
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
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
19     for more details.
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
25 Class
26     Foam::QUICKVLimiter
28 Description
29     Class with limiter function which returns the limiter for the
30     quadratic-upwind differencing scheme.
32     Note that the weighting factors are not bounded between upwind and
33     central-differencing, some downwind contribution is possible although
34     the interpolate is limited to be between the upwind and downwind cell
35     values.
37     Used in conjunction with the template class LimitedScheme.
39 SourceFiles
40     QUICKV.C
42 \*---------------------------------------------------------------------------*/
44 #ifndef QUICKV_H
45 #define QUICKV_H
47 #include "vector.H"
49 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
51 namespace Foam
54 /*---------------------------------------------------------------------------*\
55                            Class QUICKVLimiter Declaration
56 \*---------------------------------------------------------------------------*/
58 template<class LimiterFunc>
59 class QUICKVLimiter
61     public LimiterFunc
64 public:
66     QUICKVLimiter(Istream&)
67     {}
69     scalar limiter
70     (
71         const scalar cdWeight,
72         const scalar faceFlux,
73         const typename LimiterFunc::phiType& phiP,
74         const typename LimiterFunc::phiType& phiN,
75         const typename LimiterFunc::gradPhiType& gradcP,
76         const typename LimiterFunc::gradPhiType& gradcN,
77         const vector& d
78     ) const
79     {
80         vector gradfV = phiN - phiP;
82         scalar phiCD = gradfV & (cdWeight*phiP + (1 - cdWeight)*phiN);
84         scalar phiU, phif;
86         if (faceFlux > 0)
87         {
88             phiU = gradfV & phiP;
89             phif = 0.5*(phiCD + phiU + (1 - cdWeight)*(gradfV & (d & gradcP)));
90         }
91         else
92         {
93             phiU = gradfV & phiN;
94             phif = 0.5*(phiCD + phiU - cdWeight*(gradfV & (d & gradcN)));
95         }
97         // Calculate the effective limiter for the QUICK interpolation
98         scalar QLimiter = (phif - phiU)/stabilise(phiCD - phiU, SMALL);
100         // Limit the limiter between upwind and downwind
101         return max(min(QLimiter, 2), 0);
102     }
106 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
108 } // End namespace Foam
110 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
112 #endif
114 // ************************************************************************* //