Forward compatibility: flex
[foam-extend-3.2.git] / src / dbns / limiter / firstOrderLimiter.H
blobb497c5683b37660154333549465c286f379047ea
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     firstOrderLimiter
27 Description
28     First order limiter: all second order terms are removed
30 Author
31     Hrvoje Jasak
33 \*---------------------------------------------------------------------------*/
35 #ifndef firstOrderLimiter_H
36 #define firstOrderLimiter_H
38 #include "vector.H"
40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
42 namespace Foam
45 /*---------------------------------------------------------------------------*\
46                   Class firstOrderLimiter Declaration
47 \*---------------------------------------------------------------------------*/
49 class firstOrderLimiter
51 public:
53     // Constructor
55         //- Construct null
56         firstOrderLimiter()
57         {}
59         //- Return limiter
60         inline scalar limiter
61         (
62             const scalar& cellVolume,
63             const scalar& deltaOneMax,
64             const scalar& deltaOneMin,
65             const scalar& deltaTwo
66         )
67         {
68             return 0;
69         }
71         //- Return limiter for a scalar
72         inline scalar limiter
73         (
74             const scalar& cellVolume,
75             const scalar& faceFlux,
76             const scalar& deltaOneMax,
77             const scalar& deltaOneMin,
78             const vector& gradPhiP,
79             const vector& gradPhiN,
80             const vector& d
81         )
82         {
83             return 0;
84         }
86         //- Return limiter for a vector
87         inline vector limiter
88         (
89             const scalar& cellVolume,
90             const scalar& faceFlux,
91             const vector& deltaOneMax,
92             const vector& deltaOneMin,
93             const tensor& gradPhiP,
94             const tensor& gradPhiN,
95             const vector& d
96         )
97         {
98             return vector::zero;
99         }
101         //- Return limiter for a symmTensor
102         inline symmTensor limiter
103         (
104             const scalar& cellVolume,
105             const scalar& faceFlux,
106             const symmTensor& deltaOneMax,
107             const symmTensor& deltaOneMin,
108             const vector& gradPhiPXX,
109             const vector& gradPhiNXX,
110             const vector& gradPhiPXY,
111             const vector& gradPhiNXY,
112             const vector& gradPhiPXZ,
113             const vector& gradPhiNXZ,
114             const vector& gradPhiPYY,
115             const vector& gradPhiNYY,
116             const vector& gradPhiPYZ,
117             const vector& gradPhiNYZ,
118             const vector& gradPhiPZZ,
119             const vector& gradPhiNZZ,
120             const vector& d
121         )
122         {
123             return symmTensor::zero;
124         }
128 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
130 } // End namespace Foam
132 #endif
134 // ************************************************************************* //