UMIST.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::UMISTLimiter
26 
27 Description
28  Class with limiter function which returns the limiter for the
29  UMIST interpolation scheme.
30 
31  Used in conjunction with the template class LimitedScheme.
32 
33 SourceFiles
34  UMIST.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef UMIST_H
39 #define UMIST_H
40 
41 #include "vector.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class UMISTLimiter Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class LimiterFunc>
53 class UMISTLimiter
54 :
55  public LimiterFunc
56 {
57 
58 public:
59 
61  {}
62 
63  scalar limiter
64  (
65  const scalar cdWeight,
66  const scalar faceFlux,
67  const typename LimiterFunc::phiType& phiP,
68  const typename LimiterFunc::phiType& phiN,
69  const typename LimiterFunc::gradPhiType& gradcP,
70  const typename LimiterFunc::gradPhiType& gradcN,
71  const vector& d
72  ) const
73  {
74  scalar r = LimiterFunc::r
75  (
76  faceFlux, phiP, phiN, gradcP, gradcN, d
77  );
78 
79  return max(min(min(min(2*r, 0.75*r + 0.25), 0.25*r + 0.75), 2), 0);
80  }
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
UMISTLimiter(Istream &)
Definition: UMIST.H:59
layerAndWeight max(const layerAndWeight &a, const layerAndWeight &b)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
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: UMIST.H:63
layerAndWeight min(const layerAndWeight &a, const layerAndWeight &b)
Class with limiter function which returns the limiter for the UMIST interpolation scheme...
Definition: UMIST.H:52
Namespace for OpenFOAM.