All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
SFCD.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::SFCDLimiter
26 
27 Description
28  Class with limiter function which returns the limiter for the
29  SFCD differencing scheme based on phict obtained from the LimiterFunc
30  class.
31 
32  Used in conjunction with the template class LimitedScheme.
33 
34 SourceFiles
35  SFCD.C
36 
37 \*---------------------------------------------------------------------------*/
38 
39 #ifndef SFCD_H
40 #define SFCD_H
41 
42 #include "vector.H"
43 
44 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
45 
46 namespace Foam
47 {
48 
49 /*---------------------------------------------------------------------------*\
50  Class SFCDLimiter Declaration
51 \*---------------------------------------------------------------------------*/
52 
53 template<class LimiterFunc>
54 class SFCDLimiter
55 :
56  public LimiterFunc
57 {
58 
59 public:
60 
62  {}
63 
64  scalar limiter
65  (
66  const scalar cdWeight,
67  const scalar faceFlux,
68  const typename LimiterFunc::phiType& phiP,
69  const typename LimiterFunc::phiType& phiN,
70  const typename LimiterFunc::gradPhiType& gradcP,
71  const typename LimiterFunc::gradPhiType& gradcN,
72  const vector& d
73  ) const
74  {
75  scalar phict = LimiterFunc::phict
76  (
77  faceFlux, phiP, phiN, gradcP, gradcN, d
78  );
79 
80  scalar limitPhict = min(max(phict, 0), 0.5);
81  return limitPhict/(1 - limitPhict);
82  }
83 };
84 
85 
86 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
87 
88 } // End namespace Foam
89 
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
91 
92 #endif
93 
94 // ************************************************************************* //
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: SFCD.H:64
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
Class with limiter function which returns the limiter for the SFCD differencing scheme based on phict...
Definition: SFCD.H:53
dimensioned< Type > min(const dimensioned< Type > &, const dimensioned< Type > &)
SFCDLimiter(Istream &)
Definition: SFCD.H:60
Namespace for OpenFOAM.