materiallaw.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 DUMUX_MATERIAL_FLUIDMATRIX_TWOP_MATERIAL_LAW_HH
#define DUMUX_MATERIAL_FLUIDMATRIX_TWOP_MATERIAL_LAW_HH
 
#include <dumux/common/parameters.hh>
#include <dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh>
#include <dumux/material/fluidmatrixinteractions/2p/efftoabsdefaultpolicy.hh>
#include <dumux/material/fluidmatrixinteractions/2p/noregularization.hh>
 
namespace Dumux::FluidMatrix {

template<class ScalarType,
         class BaseLaw,
         class Regularization = NoRegularization,
         class EffToAbsPolicy = TwoPEffToAbsDefaultPolicy>
class TwoPMaterialLaw : public Adapter<TwoPMaterialLaw<ScalarType, BaseLaw, Regularization, EffToAbsPolicy>, PcKrSw>
{
public:
 
    using Scalar = ScalarType;
 
    using BasicParams = typename BaseLaw::template Params<Scalar>;
    using EffToAbsParams = typename EffToAbsPolicy::template Params<Scalar>;
    using RegularizationParams = typename Regularization::template Params<Scalar>;
 
    using EffToAbs = EffToAbsPolicy;

    static constexpr int numFluidPhases()
    { return 2; }

    static constexpr bool isRegularized()
    { return !std::is_same<Regularization, NoRegularization>::value; }

    TwoPMaterialLaw() = delete;

    explicit TwoPMaterialLaw(const std::string& paramGroup)
    : basicParams_(makeBasicParams(paramGroup))
    , effToAbsParams_(makeEffToAbsParams(paramGroup))
    {
        if constexpr (isRegularized())
            regularization_.init(this, paramGroup);
    }

    TwoPMaterialLaw(const BasicParams& baseParams,
                    const EffToAbsParams& effToAbsParams = {},
                    const RegularizationParams& regParams = {})
    : basicParams_(baseParams)
    , effToAbsParams_(effToAbsParams)
    {
        if constexpr (isRegularized())
            regularization_.init(this, baseParams, effToAbsParams, regParams);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar pc(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.pc(swe);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::pc(swe, basicParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar dpc_dsw(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dpc_dswe(swe);
            if (regularized)
                return regularized.value()*EffToAbs::dswe_dsw(effToAbsParams_);
        }
 
        return BaseLaw::dpc_dswe(swe, basicParams_)*EffToAbs::dswe_dsw(effToAbsParams_);
    }

    Scalar endPointPc() const
    {
        return BaseLaw::endPointPc(basicParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar sw(const Scalar pc) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.swe(pc);
            if (regularized)
                return EffToAbs::sweToSw(regularized.value(), effToAbsParams_);
        }
 
        return EffToAbs::sweToSw(BaseLaw::swe(pc, basicParams_), effToAbsParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar dsw_dpc(const Scalar pc) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dswe_dpc(pc);
            if (regularized)
                return regularized.value()*EffToAbs::dsw_dswe(effToAbsParams_);
        }
 
        return BaseLaw::dswe_dpc(pc, basicParams_)*EffToAbs::dsw_dswe(effToAbsParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar krw(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.krw(swe);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::krw(swe, basicParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar dkrw_dsw(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dkrw_dswe(swe);
            if (regularized)
                return regularized.value()*EffToAbs::dswe_dsw(effToAbsParams_);
        }
 
        return BaseLaw::dkrw_dswe(swe, basicParams_)*EffToAbs::dswe_dsw(effToAbsParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar krn(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.krn(swe);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::krn(swe, basicParams_);
    }

    template<bool enableRegularization = isRegularized()>
    Scalar dkrn_dsw(const Scalar sw) const
    {
        const auto swe = EffToAbs::swToSwe(sw, effToAbsParams_);
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dkrn_dswe(swe);
            if (regularized)
                return regularized.value()*EffToAbs::dswe_dsw(effToAbsParams_);
        }
 
        return BaseLaw::dkrn_dswe(swe, basicParams_)*EffToAbs::dswe_dsw(effToAbsParams_);
    }

    bool operator== (const TwoPMaterialLaw& o) const
    {
        return basicParams_ == o.basicParams_
               && effToAbsParams_ == o.effToAbsParams_
               && regularization_ == o.regularization_;
    }

    static BasicParams makeBasicParams(const std::string& paramGroup)
    {
        return BaseLaw::template makeParams<Scalar>(paramGroup);
    }

    const BasicParams& basicParams() const
    { return basicParams_; }

    static EffToAbsParams makeEffToAbsParams(const std::string& paramGroup)
    {
        return EffToAbs::template makeParams<Scalar>(paramGroup);
    }

    const EffToAbsParams& effToAbsParams() const
    { return effToAbsParams_; }
 
private:
    BasicParams basicParams_;
    EffToAbsParams effToAbsParams_;
    Regularization regularization_;
};
 
} // end namespace Dumux::FluidMatrix
 
#endif