parkervangen3pparams.hh

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:
/*****************************************************************************
 *   See the file COPYING for full copying permissions.                      *
 *                                                                           *
 *   This program 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.                                     *
 *                                                                           *
 *   This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.   *
 *****************************************************************************/
#ifndef PARKERVANGEN_PARAMS_3P_HH
#define PARKERVANGEN_PARAMS_3P_HH
 
#include <dune/common/fvector.hh>
#include <iostream>
 
namespace Dumux {
 
template<class ScalarT>
class ParkerVanGen3PParams
{
public:
    using Scalar = ScalarT;
 
    ParkerVanGen3PParams()
    {betaGw_ = betaNw_ = betaGn_ = 1.0;}
 
    ParkerVanGen3PParams(Scalar vgAlpha, Scalar vgn, Scalar KdNAPL, Scalar rhoBulk,
                         Dune::FieldVector<Scalar, 4> residualSaturation, Scalar betaNw = 1.0,
                         Scalar betaGn = 1.0, Scalar betaGw = 1.0, bool regardSnr=false)
    {
        setVgAlpha(vgAlpha);
        setVgn(vgn);
        setSwr(residualSaturation[0]);
        setSnr(residualSaturation[1]);
        setSgr(residualSaturation[2]);
        setKrRegardsSnr(regardSnr);
        setKdNAPL(KdNAPL);
        setBetaNw(betaNw);
        setBetaGn(betaGn);
        setBetaGw(betaGw);
        setRhoBulk(rhoBulk);
    }
 
    Scalar vgAlpha() const
    { return vgAlpha_; }
 
    void setVgAlpha(Scalar v)
    { vgAlpha_ = v; }
 
    Scalar vgm() const
    { return vgm_; }
 
    void setVgm(Scalar m)
    { vgm_ = m; vgn_ = 1/(1 - vgm_); }
 
    Scalar vgn() const
    { return vgn_; }
 
    void setVgn(Scalar n)
    { vgn_ = n; vgm_ = 1 - 1/vgn_; }
 
    Scalar satResidual(int phaseIdx) const
    {
        switch (phaseIdx)
        {
        case 0:
            return swr_;
        case 1:
            return snr_;
        case 2:
            DUNE_THROW(Dune::NotImplemented, "sgr for three phases not required and therefore not implemented");
        }
        DUNE_THROW(Dune::InvalidStateException, "Invalid phase index " << phaseIdx);
    }
 
    void setResiduals(Dune::FieldVector<Scalar, 3> residualSaturation)
    {
        setSwr(residualSaturation[0]);
        setSnr(residualSaturation[1]);
        setSgr(residualSaturation[2]);
    }
 
 
    Scalar swr() const
    { return swr_; }
 
    void setSwr(Scalar input)
    { swr_ = input; }
 
    Scalar snr() const
    { return snr_; }
 
    void setSnr(Scalar input)
    { snr_ = input; }
 
    Scalar sgr() const
    {
        return sgr_;
    }
 
    void setSgr(Scalar input)
    {
         sgr_ = input;
    }
 
    Scalar swrx() const
    {
         std::cerr << "swrx for three phases not implemented anymore. Equals swr" << std::endl;
         return swr_;
    }
 
    void setSwrx(Scalar v)
    {
         std::cerr << "swrx for three phases not implemented anymore. Equals swr" << std::endl;
    }
    void setBetaNw(Scalar input)
    { betaNw_ = input; }
 
    void setBetaGn(Scalar input)
    { betaGn_ = input; }
 
    void setBetaGw(Scalar input)
    { betaGw_ = input; }
 
    Scalar betaNw() const
    { return betaNw_; }
 
    Scalar betaGn() const
    { return betaGn_; }
 
    Scalar betaGw() const
    { return betaGw_; }
 
    void setKrRegardsSnr(bool input)
    { krRegardsSnr_ = input; }
 
    bool krRegardsSnr() const
    { return krRegardsSnr_; }
 
 
    Scalar rhoBulk() const
    { return rhoBulk_; }
 
    void setRhoBulk(Scalar input)
    { rhoBulk_ = input; }
 
    Scalar KdNAPL() const
    { return KdNAPL_; }
 
    void setKdNAPL(Scalar input)
    { KdNAPL_ = input; }
 
 
private:
    Scalar vgAlpha_;
    Scalar vgm_;
    Scalar vgn_;
    Scalar swr_;
    Scalar snr_;
    Scalar sgr_;
 
    Scalar KdNAPL_;
    Scalar rhoBulk_;
 
    Scalar betaNw_;
    Scalar betaGn_;
    Scalar betaGw_;
 
    bool krRegardsSnr_ ;
};
} // namespace Dumux
 
#endif