src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/Phi/Phi.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::PhiLimiter
  27
  28 Description
  29     Class with limiter function which returns the limiter for the
  30     Phi differencing scheme.
  31
  32     Used in conjunction with the template class PhiScheme.
  33
  34 SourceFiles
  35     Phi.C
  36
  37 \*---------------------------------------------------------------------------*/
  38
  39 #ifndef Phi_H
  40 #define Phi_H
  41
  42 #include "vector.H"
  43
  44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  45
  46 namespace Foam
  47 {
  48
  49 /*---------------------------------------------------------------------------*\
  50                            Class PhiLimiter Declaration
  51 \*---------------------------------------------------------------------------*/
  52
  53 class PhiLimiter
  54 {
  55     scalar k_;
  56
  57 public:
  58
  59     PhiLimiter(Istream& is)
  60     :
  61         k_(readScalar(is))
  62     {
  63         if (k_ < 0 || k_ > 1)
  64         {
  65             FatalIOErrorIn("PhiLimiter(Istream& is)", is)
  66                 << "coefficient = " << k_
  67                 << " should be >= 0 and <= 1"
  68                 << exit(FatalIOError);
  69         }
  70     }
  71
  72     scalar limiter
  73     (
  74         const scalar cdWeight,
  75         const scalar faceFlux,
  76         const vector& PhiP,
  77         const vector& PhiN,
  78         const vector& Sf,
  79         const scalar&
  80     ) const
  81     {
  82         scalar phiP = Sf&PhiP;
  83         scalar phiN = Sf&PhiN;
  84
  85         scalar phiU;
  86
  87         if (faceFlux > 0)
  88         {
  89             phiU = phiP;
  90         }
  91         else
  92         {
  93             phiU = phiN;
  94         }
  95
  96         scalar phiCD = cdWeight*phiP + (1 - cdWeight)*phiN;
  97
  98         // Calculate the effective limiter for the Phi interpolation
  99         //scalar PLimiter =
 100         //    (1.0 - k_) + k_*(faceFlux - phiU)/stabilise(phiCD - phiU, SMALL);
 101
 102         scalar PLimiter =
 103             ((faceFlux - phiU)/stabilise(phiCD - phiU, SMALL) + k_);
 104
 105         // Limit the limiter between upwind and central
 106         return max(min(PLimiter, 1), 0);
 107     }
 108 };
 109
 110
 111 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 112
 113 } // End namespace Foam
 114
 115 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 116
 117 #endif
 118
 119 // ************************************************************************* //