src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/SuperBee/SuperBee.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  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.
  15
  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.
  20
  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
  24
  25 Class
  26     Foam::SuperBeeLimiter
  27
  28 Description
  29     Class with limiter function which returns the limiter for the
  30     SuperBee differencing scheme based on r obtained from the LimiterFunc
  31     class.
  32
  33     Used in conjunction with the template class LimitedScheme.
  34
  35 SourceFiles
  36     SuperBee.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef SuperBee_H
  41 #define SuperBee_H
  42
  43 #include "vector.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                        Class SuperBeeLimiter Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class LimiterFunc>
  55 class SuperBeeLimiter
  56 :
  57     public LimiterFunc
  58 {
  59
  60 public:
  61
  62     SuperBeeLimiter(Istream&)
  63     {}
  64
  65     scalar limiter
  66     (
  67         const scalar cdWeight,
  68         const scalar faceFlux,
  69         const typename LimiterFunc::phiType& phiP,
  70         const typename LimiterFunc::phiType& phiN,
  71         const typename LimiterFunc::gradPhiType& gradcP,
  72         const typename LimiterFunc::gradPhiType& gradcN,
  73         const vector& d
  74     ) const
  75     {
  76         scalar r = LimiterFunc::r
  77         (
  78             faceFlux, phiP, phiN, gradcP, gradcN, d
  79         );
  80
  81         return max(max(min(2*r, 1), min(r, 2)), 0);
  82     }
  83 };
  84
  85
  86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  87
  88 } // End namespace Foam
  89
  90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  91
  92 #endif
  93
  94 // ************************************************************************* //