Forward compatibility: flex
[foam-extend-3.2.git] / src / transportModels / interfaceProperties / interfaceCompression / interfaceCompression.H
blob487927d6e69787cbcc8520b1da8909ef3c1a4cff
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | foam-extend: Open Source CFD
4    \\    /   O peration     | Version:     3.2
5     \\  /    A nd           | Web:         http://www.foam-extend.org
6      \\/     M anipulation  | For copyright notice see file Copyright
7 -------------------------------------------------------------------------------
8 License
9     This file is part of foam-extend.
11     foam-extend 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 3 of the License, or (at your
14     option) any later version.
16     foam-extend is distributed in the hope that it will be useful, but
17     WITHOUT ANY WARRANTY; without even the implied warranty of
18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
19     General Public License for more details.
21     You should have received a copy of the GNU General Public License
22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
24 Class
25     Foam::interfaceCompressionLimiter
27 Description
28     Interface compression scheme currently based on the generic limited
29     scheme although it does not use the NVD/TVD functions.
31 SourceFiles
32     interfaceCompression.C
34 \*---------------------------------------------------------------------------*/
36 #ifndef interfaceCompression_H
37 #define interfaceCompression_H
39 #include "vector.H"
41 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
43 namespace Foam
46 /*---------------------------------------------------------------------------*\
47                  Class interfaceCompressionLimiter Declaration
48 \*---------------------------------------------------------------------------*/
50 class interfaceCompressionLimiter
53 public:
55     interfaceCompressionLimiter(Istream&)
56     {}
58     scalar limiter
59     (
60         const scalar cdWeight,
61         const scalar faceFlux,
62         const scalar& phiP,
63         const scalar& phiN,
64         const vector&,
65         const scalar&
66     ) const
67     {
68         // Quadratic compression scheme
69         // return min(max(4*min(phiP*(1 - phiP), phiN*(1 - phiN)), 0), 1);
71         // Quartic compression scheme
72         return
73             min
74             (
75                 max
76                 (
77                     1 - max
78                     (
79                         sqr(1 - 4*phiP*(1 - phiP)),
80                         sqr(1 - 4*phiN*(1 - phiN))
81                     ),
82                     0
83                 ),
84                 1
85             );
86     }
90 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
92 } // End namespace Foam
94 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
96 #endif
98 // ************************************************************************* //