SaturationPropsBasic.hpp

Go to the documentation of this file.

/*
  Copyright 2012 SINTEF ICT, Applied Mathematics.
 
  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_SATURATIONPROPSBASIC_HEADER_INCLUDED
#define OPM_SATURATIONPROPSBASIC_HEADER_INCLUDED
 
#include <opm/core/utility/parameters/ParameterGroup.hpp>
 
namespace Opm
{
 
 
    class SaturationPropsBasic
    {
    public:
        SaturationPropsBasic();
 
        void init(const ParameterGroup& param);
 
        enum RelPermFunc { Constant, Linear, Quadratic };
 
        void init(const int num_phases,
                  const RelPermFunc& relperm_func)
        {
            num_phases_ = num_phases;
            relperm_func_ = relperm_func;
        }
 
        int numPhases() const;
 
        void relperm(const int n,
                     const double* s,
                     double* kr,
                     double* dkrds) const;
 
        void capPress(const int n,
                      const double* s,
                      double* pc,
                      double* dpcds) const;
 
        void satRange(const int n,
                      double* smin,
                      double* smax) const;
 
 
    private:
        int num_phases_;
        RelPermFunc relperm_func_;
    };
 
 
 
} // namespace Opm
 
 
 
 
#endif // OPM_SATURATIONPROPSBASIC_HEADER_INCLUDED