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