CreateRelativePermeabilityModel.cpp

Go to the documentation of this file.

 
#include "CreateRelativePermeabilityModel.h"
 
#include <array>
#include <memory>
#include <string>
#include <vector>
 
#include "BaseLib/ConfigTree.h"
#include "BaseLib/Error.h"
#include "MathLib/Curve/CreatePiecewiseLinearCurve.h"
#include "MathLib/InterpolationAlgorithms/PiecewiseLinearInterpolation.h"
#include "NonWettingPhaseBrooksCoreyOilGas.h"
#include "NonWettingPhaseVanGenuchten.h"
#include "RelativePermeability.h"
#include "RelativePermeabilityCurve.h"
#include "WettingPhaseBrooksCoreyOilGas.h"
#include "WettingPhaseVanGenuchten.h"
 
namespace MaterialLib
{
namespace PorousMedium
{
std::unique_ptr<RelativePermeability> createWettingPhaseVanGenuchten(
    BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter("type", "WettingPhaseVanGenuchten");
 
    const auto Sr = config.getConfigParameter<double>("sr");
 
    const auto Smax = config.getConfigParameter<double>("smax");
 
    const auto m = config.getConfigParameter<double>("m");
    if (m < 0. || m > 1.0)
    {
        OGS_FATAL(
            "The exponent parameter of WettingPhaseVanGenuchten relative\n"
            " permeability model, m, must be in an interval of [0, 1]");
    }
    const auto krel_min = config.getConfigParameter<double>("krel_min");
 
    return std::make_unique<WettingPhaseVanGenuchten>(Sr, Smax, m, krel_min);
}
 
std::unique_ptr<RelativePermeability> createNonWettingPhaseVanGenuchten(
    BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter("type", "NonWettingPhaseVanGenuchten");
 
    const auto Sr = config.getConfigParameter<double>("sr");
 
    const auto Smax = config.getConfigParameter<double>("smax");
 
    const auto m = config.getConfigParameter<double>("m");
    if (m < 0. || m > 1.0)
    {
        OGS_FATAL(
            "The exponent parameter of NonWettingPhaseVanGenuchten relative\n"
            " permeability model, m, must be in an interval of [0, 1]");
    }
 
    const auto krel_min = config.getConfigParameter<double>("krel_min");
 
    return std::make_unique<NonWettingPhaseVanGenuchten>(Sr, Smax, m, krel_min);
}
 
std::unique_ptr<RelativePermeability> createWettingPhaseBrooksCoreyOilGas(
    BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter("type", "WettingPhaseBrooksCoreyOilGas");
 
    const auto Sr = config.getConfigParameter<double>("sr");
 
    const auto Smax = config.getConfigParameter<double>("smax");
 
    const auto m = config.getConfigParameter<double>("m");
    if (m < 1.0)  // m >= 1
    {
        OGS_FATAL(
            "The exponent parameter of WettingPhaseBrooksCoreyOilGas\n"
            "relative permeability model, m, must not be smaller than 1");
    }
 
    const auto krel_min = config.getConfigParameter<double>("krel_min");
 
    return std::make_unique<WettingPhaseBrooksCoreyOilGas>(
        Sr, Smax, m, krel_min);
}
 
std::unique_ptr<RelativePermeability> createNonWettingPhaseBrooksCoreyOilGas(
    BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter("type", "NonWettingPhaseBrooksCoreyOilGas");
 
    const auto Sr = config.getConfigParameter<double>("sr");
 
    const auto Smax = config.getConfigParameter<double>("smax");
 
    const auto m = config.getConfigParameter<double>("m");
    if (m < 1.0)  // m >= 1
    {
        OGS_FATAL(
            "The exponent parameter of NonWettingPhaseBrooksCoreyOilGas\n"
            "relative permeability model, m, must not be smaller than 1");
    }
 
    const auto krel_min = config.getConfigParameter<double>("krel_min");
 
    return std::make_unique<NonWettingPhaseBrooksCoreyOilGas>(
        Sr, Smax, m, krel_min);
}
 
std::unique_ptr<RelativePermeability> createRelativePermeabilityModel(
    BaseLib::ConfigTree const& config)
{
    auto const type = config.peekConfigParameter<std::string>("type");
 
    if (type == "WettingPhaseVanGenuchten")
    {
        return createWettingPhaseVanGenuchten(config);
    }
    if (type == "NonWettingPhaseVanGenuchten")
    {
        return createNonWettingPhaseVanGenuchten(config);
    }
    if (type == "WettingPhaseBrooksCoreyOilGas")
    {
        return createWettingPhaseBrooksCoreyOilGas(config);
    }
    if (type == "NonWettingPhaseBrooksCoreyOilGas")
    {
        return createNonWettingPhaseBrooksCoreyOilGas(config);
    }
    if (type == "Curve")
    {
        config.checkConfigParameter("type", "Curve");
 
        auto const& curve_config = config.getConfigSubtree("curve");
 
        auto curve = MathLib::createPiecewiseLinearCurve<
            MathLib ::PiecewiseLinearInterpolation>(curve_config);
        return std::make_unique<RelativePermeabilityCurve>(std::move(curve));
    }
 
    OGS_FATAL(
        "The relative permeability model {:s} is unavailable.\n"
        "The available models are:"
        "\n\tWettingPhaseVanGenuchten,"
        "\n\tNonWettingPhaseVanGenuchten,"
        "\n\tWettingPhaseBrooksCoreyOilGas,"
        "\n\tNonWettingPhaseBrooksCoreyOilGas,",
        "\n\tCurve.\n",
        type.data());
}
 
}  // namespace PorousMedium
}  // namespace MaterialLib