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

   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.
  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::MinmodLimiter
  27
  28 Description
  29     Class with limiter function which returns the limiter for the
  30     Minmod differencing scheme.
  31
  32     Used in conjunction with the template class LimitedScheme.
  33
  34 SourceFiles
  35     Minmod.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef Minmod_H
  40 #define Minmod_H
  41
  42 #include "vector.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                        Class MinmodLimiter Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 template<class LimiterFunc>
  54 class MinmodLimiter
  55 :
  56     public LimiterFunc
  57 {
  58
  59 public:
  60
  61     MinmodLimiter(Istream&)
  62     {}
  63
  64     scalar limiter
  65     (
  66         const scalar cdWeight,
  67         const scalar faceFlux,
  68         const typename LimiterFunc::phiType& phiP,
  69         const typename LimiterFunc::phiType& phiN,
  70         const typename LimiterFunc::gradPhiType& gradcP,
  71         const typename LimiterFunc::gradPhiType& gradcN,
  72         const vector& d
  73     ) const
  74     {
  75         scalar r = LimiterFunc::r
  76         (
  77             faceFlux, phiP, phiN, gradcP, gradcN, d
  78         );
  79
  80         return max(min(r, 1), 0);
  81     }
  82 };
  83
  84
  85 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  86
  87 } // End namespace Foam
  88
  89 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  90
  91 #endif
  92
  93 // ************************************************************************* //