My Project
Means.hpp
Go to the documentation of this file.
1 // -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
2 // vi: set et ts=4 sw=4 sts=4:
3 /*
4  This file is part of the Open Porous Media project (OPM).
5 
6  OPM is free software: you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation, either version 2 of the License, or
9  (at your option) any later version.
10 
11  OPM is distributed in the hope that it will be useful,
12  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  GNU General Public License for more details.
15 
16  You should have received a copy of the GNU General Public License
17  along with OPM. If not, see <http://www.gnu.org/licenses/>.
18 
19  Consult the COPYING file in the top-level source directory of this
20  module for the precise wording of the license and the list of
21  copyright holders.
22 */
30 #ifndef OPM_MEANS_HH
31 #define OPM_MEANS_HH
32 
33 #include <cmath>
34 
35 namespace Opm {
44 template <class Scalar>
45 inline Scalar arithmeticMean(Scalar x, Scalar y)
46 { return (x+y)/2; }
47 
56 template <class Scalar>
57 inline Scalar geometricMean(Scalar x, Scalar y)
58 {
59  if (x*y <= 0.0)
60  return 0.0;
61 
62  return std::sqrt(x*y);
63 }
64 
73 template <class Scalar>
74 inline Scalar harmonicMean(Scalar x, Scalar y)
75 {
76  if (x*y <= 0)
77  return 0.0;
78 
79  return (2*x*y)/(y + x);
80 }
81 
82 } // namespace Ewoms
83 
84 #endif // EWOMS_AVERAGE_HH
Scalar geometricMean(Scalar x, Scalar y)
Computes the geometric average of two values.
Definition: Means.hpp:57
Scalar harmonicMean(Scalar x, Scalar y)
Computes the harmonic average of two values.
Definition: Means.hpp:74
Scalar arithmeticMean(Scalar x, Scalar y)
Computes the arithmetic average of two values.
Definition: Means.hpp:45