src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Gamma/Gamma.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::GammaLimiter
  27
  28 Description
  29     Class with limiter function which returns the limiter for the
  30     Gamma differencing scheme based on phict obtained from the LimiterFunc
  31     class.
  32
  33     Used in conjunction with the template class LimitedScheme.
  34
  35 SourceFiles
  36     Gamma.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef Gamma_H
  41 #define Gamma_H
  42
  43 #include "vector.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                         Class GammaLimiter Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class LimiterFunc>
  55 class GammaLimiter
  56 :
  57     public LimiterFunc
  58 {
  59     scalar k_;
  60
  61 public:
  62
  63     GammaLimiter(Istream& is)
  64     :
  65         k_(readScalar(is))
  66     {
  67         if (k_ < 0 || k_ > 1)
  68         {
  69             FatalIOErrorIn("GammaLimiter(Istream& is)", is)
  70                 << "coefficient = " << k_
  71                 << " should be >= 0 and <= 1"
  72                 << exit(FatalIOError);
  73         }
  74
  75         // Rescale k_ to be >= 0 and <= 0.5 (TVD conformant)
  76         // and avoid the /0 when k_ = 0
  77         k_ = max(k_/2.0, SMALL);
  78     }
  79
  80     scalar limiter
  81     (
  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,
  88         const vector& d
  89     ) const
  90     {
  91         scalar phict = LimiterFunc::phict
  92         (
  93             faceFlux, phiP, phiN, gradcP, gradcN, d
  94         );
  95
  96         return min(max(phict/k_, 0), 1);
  97     }
  98 };
  99
 100
 101 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 102
 103 } // End namespace Foam
 104
 105 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 106
 107 #endif
 108
 109 // ************************************************************************* //