singleshapelocalrules.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_PNM_2P_SINGLE_SHAPE_LOCAL_RULES_HH
#define DUMUX_PNM_2P_SINGLE_SHAPE_LOCAL_RULES_HH
 
#include <dumux/common/parameters.hh>
#include <dumux/porenetwork/common/poreproperties.hh>
#include <dumux/material/fluidmatrixinteractions/2p/noregularization.hh>
#include <dumux/material/fluidmatrixinteractions/fluidmatrixinteraction.hh>
 
namespace Dumux::PoreNetwork::FluidMatrix {
 
template<class ScalarType,
         class BaseLaw,
         class Regularization = Dumux::FluidMatrix::NoRegularization>
class SingleShapeTwoPLocalRules : public Dumux::FluidMatrix::Adapter<SingleShapeTwoPLocalRules<ScalarType, BaseLaw, Regularization>, Dumux::FluidMatrix::PcKrSw>
{
public:
 
    using Scalar = ScalarType;
 
    using BasicParams = typename BaseLaw::template Params<Scalar>;
    using RegularizationParams = typename Regularization::template Params<Scalar>;
 
    static constexpr bool supportsMultipleGeometries()
    { return false; }
 
    template<class SpatialParams, class Element, class SubControlVolume, class ElemSol>
    void updateParams(const SpatialParams& spatialParams,
                      const Element& element,
                      const SubControlVolume& scv,
                      const ElemSol& elemSol)
    {
        basicParams_.update(spatialParams, element, scv, elemSol);
        regularization_.updateParams(spatialParams, element, scv, elemSol);
    }
 
    static constexpr int numFluidPhases()
    { return 2; }
 
    static constexpr bool isRegularized()
    { return !std::is_same<Regularization, Dumux::FluidMatrix::NoRegularization>::value; }
 
    SingleShapeTwoPLocalRules(const BasicParams& baseParams = {},
                              const RegularizationParams& regParams = {},
                              const std::string& paramGroup = "")
    : basicParams_(baseParams)
 
    {
        if constexpr (isRegularized())
            regularization_.init(this, regParams, paramGroup);
    }
 
    template<bool enableRegularization = isRegularized()>
    Scalar pc(const Scalar sw) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.pc(sw);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::pc(sw, basicParams_);
    }
 
    template<bool enableRegularization = isRegularized()>
    Scalar dpc_dsw(const Scalar sw) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dpc_dsw(sw);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::dpc_dsw(sw, basicParams_);
    }
 
    template<bool enableRegularization = isRegularized()>
    Scalar sw(const Scalar pc) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.sw(pc);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::sw(pc, basicParams_);
    }
 
    template<bool enableRegularization = isRegularized()>
    Scalar dsw_dpc(const Scalar pc) const
    {
        if constexpr (enableRegularization)
        {
            const auto regularized = regularization_.dsw_dpc(pc);
            if (regularized)
                return regularized.value();
        }
 
        return BaseLaw::dsw_dpc(pc, basicParams_);
    }
 
    template<bool enableRegularization = isRegularized()>
    Scalar krw(const Scalar sw) const
    { return 1.0; }
 
    template<bool enableRegularization = isRegularized()>
    Scalar dkrw_dsw(const Scalar sw) const
    { return 0; }
 
    template<bool enableRegularization = isRegularized()>
    Scalar krn(const Scalar sw) const
    { return 1.0; }
 
    template<bool enableRegularization = isRegularized()>
    Scalar dkrn_dsw(const Scalar sw) const
    { return 0.0; }
 
    bool operator== (const SingleShapeTwoPLocalRules& o) const
    {
        return basicParams_ == o.basicParams_
               && regularization_ == o.regularization_;
    }
 
    const BasicParams& basicParams() const
    { return basicParams_; }
 
 
private:
    BasicParams basicParams_;
    Regularization regularization_;
};
 
} // end namespace Dumux::PoreNetwork::FluidMatrix
 
#endif