Merge branch 'master' of ssh://git.code.sf.net/p/foam-extend/foam-extend-3.2
[foam-extend-3.2.git] / src / dbns / dbnsFlux / roeFlux / roeFlux.H
blob36049cba988658e4c3b6f06e0b81e4c83078179f
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     RoeFlux
27 Description
28     Implementation of inviscid numerical fluxes based on Roe & Pike FDS scheme
29     with Harten's entropy fix. This is a first order scheme
31 Author
32     Aleksandar Jemcov
33     Rewrite by Hrvoje Jasak
35 SourceFiles
36     roeFlux.H
38 \*---------------------------------------------------------------------------*/
40 #ifndef roeFlux_H
41 #define roeFlux_H
43 #include "fvCFD.H"
45 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
47 namespace Foam
50 /*---------------------------------------------------------------------------*\
51                            Class roeFlux Declaration
52 \*---------------------------------------------------------------------------*/
54 class roeFlux
56 public:
58     // Constructors
60         //- Construct null
61         roeFlux()
62         {}
65     // Destructor - default
68     // Member Functions
70         //- Update fluxes based on current left and right states
71         void evaluateFlux
72         (
73             scalar& rhoFlux,
74             vector& rhoUFlux,
75             scalar& rhoEFlux,
76             const scalar& pLeft,
77             const scalar& pRight,
78             const vector& ULeft,
79             const vector& URight,
80             const scalar& TLeft,
81             const scalar& TRight,
82             const scalar& RLeft,
83             const scalar& RRight,
84             const scalar& CvLeft,
85             const scalar& CvRight,
86             const vector& Sf,
87             const scalar& magSf
88         ) const;
91 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
93 } // End namespace Foam
95 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
97 #endif
99 // ************************************************************************* //