ENH: autoLayerDriver: better layering information message
[OpenFOAM-2.0.x.git] / src / transportModels / interfaceProperties / interfaceCompression / interfaceCompression.H
blobff14f844551ed68856794e84c2def38ae1c784f9
1 /*---------------------------------------------------------------------------*\
2   =========                 |
3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
4    \\    /   O peration     |
5     \\  /    A nd           | Copyright (C) 2011 OpenFOAM Foundation
6      \\/     M anipulation  |
7 -------------------------------------------------------------------------------
8 License
9     This file is part of OpenFOAM.
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.
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.
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/>.
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 interfaceCompressionWeight 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(max(
74             1 - max(sqr(1 - 4*phiP*(1 - phiP)), sqr(1 - 4*phiN*(1 - phiN))),
75             0), 1);
76     }
80 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
82 } // End namespace Foam
84 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
86 #endif
88 // ************************************************************************* //