Average.hpp

//===========================================================================
//
// File: Average.hpp<2>
//
// Created: Wed Jul  1 12:25:57 2009
//
// Author(s): Atgeirr F Rasmussen <atgeirr@sintef.no>
//            Bård Skaflestad     <bard.skaflestad@sintef.no>
//
// $Date$
//
// $Revision$
//
//===========================================================================
 
/*
  Copyright 2009, 2010 SINTEF ICT, Applied Mathematics.
  Copyright 2009, 2010 Statoil ASA.
 
  This file is part of the Open Porous Media project (OPM).
 
  OPM is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  OPM is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with OPM.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef OPM_AVERAGE_HEADER
#define OPM_AVERAGE_HEADER
 
 
#include <type_traits>
#include <cmath>
 
namespace Opm {
    namespace utils {
 
 
 
        template <typename T, typename Tresult>
        Tresult arithmeticAverage(const T& t1, const T& t2)
        {
            // To avoid some user errors, we disallow taking averages of
            // integral values.
            static_assert(std::is_integral<T>::value == false, "");
            Tresult retval(t1);
            retval += t2;
            retval *= 0.5;
            return retval;
        }
 
 
 
        template <typename T>
        T geometricAverage(const T& t1, const T& t2)
        {
            // To avoid some user errors, we disallow taking averages of
            // integral values.
            static_assert(std::is_integral<T>::value == false, "");
            if (t1*t2 <= 0)
                return 0;
            return std::sqrt(t1*t2);
        }
 
 
 
        template <typename T>
        T harmonicAverage(const T& t1, const T& t2)
        {
            // To avoid some user errors, we disallow taking averages of
            // integral values.
            static_assert(std::is_integral<T>::value == false, "");
            if (t1*t2 <= 0)
                return 0;
            return (2*t1*t2)/(t1 + t2);
        }
 
 
 
    } // namespace utils
} // namespace Opm
 
 
 
#endif // OPM_AVERAGE_HEADER