RegularizedVanGenuchtenParams.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:
/*
  Copyright (C) 2012-2013 by Andreas Lauser
  Copyright (C) 2010 by Philipp Nuske

  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/>.
*/
#ifndef OPM_REGULARIZED_VAN_GENUCHTEN_PARAMS_HPP
#define OPM_REGULARIZED_VAN_GENUCHTEN_PARAMS_HPP

#include "VanGenuchten.hpp"
#include "VanGenuchtenParams.hpp"

#include <opm/material/common/Spline.hpp>

#include <cassert>

namespace Opm {
template<class TraitsT>
class RegularizedVanGenuchtenParams : public VanGenuchtenParams<TraitsT>
{
    typedef typename TraitsT::Scalar Scalar;
    typedef VanGenuchtenParams<TraitsT> Parent;
    typedef Opm::VanGenuchten<TraitsT> VanGenuchten;

public:
    typedef TraitsT Traits;

    RegularizedVanGenuchtenParams()
        : pcnwLowSw_(0.01)
        , pcnwHighSw_(0.99)
    {}

    RegularizedVanGenuchtenParams(Scalar vgAlpha, Scalar vgN)
        : Parent(vgAlpha, vgN)
        , pcnwLowSw_(0.01)
        , pcnwHighSw_(0.99)
    {
        finalize();
    }

    void finalize()
    {
        Parent::finalize();

        pcnwLow_ = VanGenuchten::twoPhaseSatPcnw(*this, pcnwLowSw_);
        pcnwSlopeLow_ = dPcnw_dSw_(pcnwLowSw_);
        pcnwHigh_ = VanGenuchten::twoPhaseSatPcnw(*this, pcnwHighSw_);
        pcnwSlopeHigh_ = 2*(0.0 - pcnwHigh_)/(1.0 - pcnwHighSw_);

        Scalar mThreshold = dPcnw_dSw_(pcnwHighSw_);

        pcnwHighSpline_.set(pcnwHighSw_, 1.0, // x0, x1
                            pcnwHigh_, 0, // y0, y1
                            mThreshold, pcnwSlopeHigh_); // m0, m1

#ifndef NDEBUG
        finalized_ = true;
#endif
    }

    Scalar pcnwLowSw() const
    { assertFinalized_(); return pcnwLowSw_; }

    Scalar pcnwLow() const
    { assertFinalized_(); return pcnwLow_; }

    Scalar pcnwSlopeLow() const
    { assertFinalized_(); return pcnwSlopeLow_; }

    void setPCLowSw(Scalar value)
    { pcnwLowSw_ = value; }

    Scalar pcnwHighSw() const
    { assertFinalized_(); return pcnwHighSw_; }

    Scalar pcnwHigh() const
    { assertFinalized_(); return pcnwHigh_; }

    const Spline<Scalar> &pcnwHighSpline() const
    { assertFinalized_(); return pcnwHighSpline_; }

    Scalar pcnwSlopeHigh() const
    { assertFinalized_(); return pcnwSlopeHigh_; }

    void setPCHighSw(Scalar value)
    { pcnwHighSw_ = value; }

private:
#ifndef NDEBUG
    void assertFinalized_() const
    { assert(finalized_); }

    bool finalized_;
#else
    void assertFinalized_() const
    { }
#endif

    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 pc1 = VanGenuchten::twoPhaseSatPcnw(*this, Sw - eps);
        Scalar pc2 = VanGenuchten::twoPhaseSatPcnw(*this, Sw + eps);
        return (pc2 - pc1)/(2*eps);
    }

    Scalar pcnwLowSw_;
    Scalar pcnwHighSw_;

    Scalar pcnwLow_;
    Scalar pcnwHigh_;

    Scalar pcnwSlopeLow_;
    Scalar pcnwSlopeHigh_;

    Spline<Scalar> pcnwHighSpline_;
};
} // namespace Opm

#endif