All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Minmod.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-2020 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::MinmodLimiter
26 
27 Description
28  Class with limiter function which returns the limiter for the
29  Minmod differencing scheme.
30 
31  Used in conjunction with the template class LimitedScheme.
32 
33 SourceFiles
34  Minmod.C
35 
36 \*---------------------------------------------------------------------------*/
37 
38 #ifndef Minmod_H
39 #define Minmod_H
40 
41 #include "vector.H"
42 
43 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
44 
45 namespace Foam
46 {
47 
48 /*---------------------------------------------------------------------------*\
49  Class MinmodLimiter Declaration
50 \*---------------------------------------------------------------------------*/
51 
52 template<class LimiterFunc>
53 class MinmodLimiter
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(r, 1), 0);
80  }
81 };
82 
83 
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
85 
86 } // End namespace Foam
87 
88 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
89 
90 #endif
91 
92 // ************************************************************************* //
Class with limiter function which returns the limiter for the Minmod differencing scheme...
Definition: Minmod.H:52
dimensioned< Type > max(const dimensioned< Type > &, const dimensioned< Type > &)
An Istream is an abstract base class for all input systems (streams, files, token lists etc)...
Definition: Istream.H:57
MinmodLimiter(Istream &)
Definition: Minmod.H:59
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
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: Minmod.H:63
Namespace for OpenFOAM.