RegularizedBrooksCoreyParams.hpp

Go to the documentation of this file.

// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
// vi: set et ts=4 sw=4 sts=4:
/*
  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 2 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/>.
 
  Consult the COPYING file in the top-level source directory of this
  module for the precise wording of the license and the list of
  copyright holders.
*/
#ifndef OPM_REGULARIZED_BROOKS_COREY_PARAMS_HPP
#define OPM_REGULARIZED_BROOKS_COREY_PARAMS_HPP
 
#include "BrooksCorey.hpp"
#include "BrooksCoreyParams.hpp"
 
#include <cassert>
 
#include <opm/material/common/EnsureFinalized.hpp>
 
namespace Opm {
template <class TraitsT>
class RegularizedBrooksCoreyParams : public BrooksCoreyParams<TraitsT>
{
    typedef ::Opm::BrooksCoreyParams<TraitsT> BrooksCoreyParams;
    typedef ::Opm::BrooksCorey<TraitsT, RegularizedBrooksCoreyParams> BrooksCorey;
    typedef typename TraitsT::Scalar Scalar;
 
public:
    typedef TraitsT Traits;
 
    RegularizedBrooksCoreyParams()
        : BrooksCoreyParams()
        , pcnwLowSw_(0.01)
    {
    }
 
    RegularizedBrooksCoreyParams(Scalar entryPressure, Scalar lambda)
        : BrooksCoreyParams(entryPressure, lambda)
        , pcnwLowSw_(0.01)
    { finalize(); }
 
    void finalize()
    {
        BrooksCoreyParams::finalize();
 
        pcnwLow_ = BrooksCorey::twoPhaseSatPcnw(*this, pcnwLowSw_);
        pcnwSlopeLow_ = dPcnw_dSw_(pcnwLowSw_);
        pcnwHigh_ = BrooksCorey::twoPhaseSatPcnw(*this, 1.0);
        pcnwSlopeHigh_ = dPcnw_dSw_(1.0);
    }
 
    Scalar pcnwLowSw() const
    { EnsureFinalized::check(); return pcnwLowSw_; }
 
    Scalar pcnwLow() const
    { EnsureFinalized::check(); return pcnwLow_; }
 
    Scalar pcnwSlopeLow() const
    { EnsureFinalized::check(); return pcnwSlopeLow_; }
 
    void setPcLowSw(Scalar value)
    { pcnwLowSw_ = value; }
 
    Scalar pcnwHigh() const
    { EnsureFinalized::check(); return pcnwHigh_; }
 
    Scalar pcnwSlopeHigh() const
    { EnsureFinalized::check(); return pcnwSlopeHigh_; }
 
private:
    Scalar dPcnw_dSw_(Scalar Sw) const
    {
        // use finite differences to calculate the derivative w.r.t. Sw of the
        // unregularized curve's capillary pressure.
        const Scalar eps = 1e-7;
        Scalar delta = 0.0;
        Scalar pc1;
        Scalar pc2;
        if (Sw + eps < 1.0) {
            pc2 = BrooksCorey::twoPhaseSatPcnw(*this, Sw + eps);
            delta += eps;
        }
        else
            pc2 = BrooksCorey::twoPhaseSatPcnw(*this, Sw);
 
        if (Sw - eps > 0.0) {
            pc1 = BrooksCorey::twoPhaseSatPcnw(*this, Sw - eps);
            delta += eps;
        }
        else
            pc1 = BrooksCorey::twoPhaseSatPcnw(*this, Sw);
 
        return (pc2 - pc1)/delta;
    }
 
    Scalar pcnwLowSw_;
    Scalar pcnwLow_;
    Scalar pcnwSlopeLow_;
    Scalar pcnwHigh_;
    Scalar pcnwSlopeHigh_;
};
} // namespace Opm
 
#endif