Gamma.H
Go to the documentation of this file.
1 /*---------------------------------------------------------------------------*\
2  ========= |
3  \\ / F ield | OpenFOAM: The Open Source CFD Toolbox
4  \\ / O peration | Website: https://openfoam.org
5  \\ / A nd | Copyright (C) 2011-2022 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::GammaLimiter
26 
27 Description
28  Class with limiter function which returns the limiter for the
29  Gamma interpolation scheme based on phict obtained from the LimiterFunc
30  class.
31 
32  Used in conjunction with the template class LimitedScheme.
33 
34 SourceFiles
35  Gamma.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef Gamma_H
40 #define Gamma_H
41 
42 #include "vector.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class GammaLimiter Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class LimiterFunc>
54 class GammaLimiter
55 :
56  public LimiterFunc
57 {
58  scalar k_;
59 
60 public:
61 
63  :
64  k_(readScalar(is))
65  {
66  if (k_ < 0 || k_ > 1)
67  {
69  << "coefficient = " << k_
70  << " should be >= 0 and <= 1"
71  << exit(FatalIOError);
72  }
73 
74  // Rescale k_ to be >= 0 and <= 0.5 (TVD conformant)
75  // and avoid the /0 when k_ = 0
76  k_ = max(k_/2.0, small);
77  }
78 
79  scalar limiter
80  (
81  const scalar cdWeight,
82  const scalar faceFlux,
83  const typename LimiterFunc::phiType& phiP,
84  const typename LimiterFunc::phiType& phiN,
85  const typename LimiterFunc::gradPhiType& gradcP,
86  const typename LimiterFunc::gradPhiType& gradcN,
87  const vector& d
88  ) const
89  {
90  scalar phict = LimiterFunc::phict
91  (
92  faceFlux, phiP, phiN, gradcP, gradcN, d
93  );
94 
95  return min(max(phict/k_, 0), 1);
96  }
97 };
98 
99 
100 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
101 
102 } // End namespace Foam
103 
104 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
105 
106 #endif
107 
108 // ************************************************************************* //
Class with limiter function which returns the limiter for the Gamma interpolation scheme based on phi...
Definition: Gamma.H:56
GammaLimiter(Istream &is)
Definition: Gamma.H:61
scalar limiter(const scalar cdWeight, const scalar faceFlux, const typename LimiterFunc::phiType &phiP, const typename LimiterFunc::phiType &phiN, const typename LimiterFunc::gradPhiType &gradcP, const typename LimiterFunc::gradPhiType &gradcN, const vector &d) const
Definition: Gamma.H:79
An Istream is an abstract base class for all input systems (streams, files, token lists etc)....
Definition: Istream.H:60
#define FatalIOErrorInFunction(ios)
Report an error message using Foam::FatalIOError.
Definition: error.H:346
Namespace for OpenFOAM.
errorManipArg< error, int > exit(error &err, const int errNo=1)
Definition: errorManip.H:124
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)
bool readScalar(const char *buf, doubleScalar &s)
Read whole of buf as a scalar. Return true if successful.
Definition: doubleScalar.H:75
layerAndWeight max(const layerAndWeight &a, const layerAndWeight &b)
IOerror FatalIOError