src/finiteVolume/interpolation/surfaceInterpolation/limitedSchemes/limitedCubic/limitedCubic.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::limitedCubicLimiter
  27
  28 Description
  29     Class with limiter function which returns the limiter for the
  30     TVD limited centred-cubic differencing scheme based on r obtained from
  31     the LimiterFunc class.
  32
  33     Used in conjunction with the template class LimitedScheme.
  34
  35 SourceFiles
  36     limitedCubic.C
  37
  38 \*---------------------------------------------------------------------------*/
  39
  40 #ifndef limitedCubic_H
  41 #define limitedCubic_H
  42
  43 #include "vector.H"
  44
  45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  46
  47 namespace Foam
  48 {
  49
  50 /*---------------------------------------------------------------------------*\
  51                       Class limitedCubicLimiter Declaration
  52 \*---------------------------------------------------------------------------*/
  53
  54 template<class LimiterFunc>
  55 class limitedCubicLimiter
  56 :
  57     public LimiterFunc
  58 {
  59     scalar k_;
  60     scalar twoByk_;
  61
  62 public:
  63
  64     limitedCubicLimiter(Istream& is)
  65     :
  66         k_(readScalar(is))
  67     {
  68         if (k_ < 0 || k_ > 1)
  69         {
  70             FatalIOErrorIn("limitedCubicLimiter(Istream& is)", is)
  71                 << "coefficient = " << k_
  72                 << " should be >= 0 and <= 1"
  73                 << exit(FatalIOError);
  74         }
  75
  76         // Avoid the /0 when k_ = 0
  77         twoByk_ = 2.0/max(k_, 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 twor = twoByk_*LimiterFunc::r
  92         (
  93             faceFlux, phiP, phiN, gradcP, gradcN, d
  94         );
  95
  96         scalar phiU;
  97
  98         if (faceFlux > 0)
  99         {
 100             phiU = phiP;
 101         }
 102         else
 103         {
 104             phiU = phiN;
 105         }
 106
 107         // Calculate the face value using cubic interpolation
 108         scalar phif =
 109             cdWeight*(phiP - 0.25*(d & gradcN))
 110           + (1 - cdWeight)*(phiN + 0.25*(d & gradcP));
 111
 112         scalar phiCD = cdWeight*phiP + (1 - cdWeight)*phiN;
 113
 114         // Calculate the effective limiter for the cubic interpolation
 115         scalar cubicLimiter = (phif - phiU)/stabilise(phiCD - phiU, SMALL);
 116
 117         /*
 118         if (twor < 0.05)
 119         {
 120             cubicLimiter = twor;
 121         }
 122
 123         return max(min(cubicLimiter, 2), 0);
 124         */
 125
 126         // Limit the limiter to obey the TVD constraint
 127         return max(min(min(twor, cubicLimiter), 2), 0);
 128     }
 129 };
 130
 131
 132 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 133
 134 } // End namespace Foam
 135
 136 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 137
 138 #endif
 139
 140 // ************************************************************************* //