CreateRelPermNonWettingPhaseVanGenuchtenMualem.cpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#include "CreateRelPermNonWettingPhaseVanGenuchtenMualem.h"
 
#include "BaseLib/ConfigTree.h"
#include "MaterialLib/MPL/Property.h"
#include "RelPermNonWettingPhaseVanGenuchtenMualem.h"
 
namespace MaterialPropertyLib
{
std::unique_ptr<Property> createRelPermNonWettingPhaseVanGenuchtenMualem(
    BaseLib::ConfigTree const& config)
{
    config.checkConfigParameter(
        "type", "RelativePermeabilityNonWettingPhaseVanGenuchtenMualem");
    DBUG("Create RelPermNonWettingPhaseVanGenuchtenMualem medium property");
 
    // Second access for storage.
    auto property_name = config.peekConfigParameter<std::string>("name");
 
    auto const residual_liquid_saturation =
        config.getConfigParameter<double>("residual_liquid_saturation");
    auto const residual_gas_saturation =
        config.getConfigParameter<double>("residual_gas_saturation");
 
    auto const exponent =
        config.getConfigParameter<double>("exponent");
 
    auto const min_relative_permeability =
        config.getConfigParameter<double>("min_relative_permeability");
    double const a =
        config.getConfigParameter<double>("enhancement_factor", 1.0);
 
    if (min_relative_permeability <= 0.0 || min_relative_permeability > 1.0)
    {
        OGS_FATAL(
            "The value for min_relative_permeability of "
            "RelativePermeabilityNonWettingPhaseVanGenuchtenMualem is {:g}, "
            "which falls outside of the range of (0, 1]",
            min_relative_permeability);
    }
    if (a < 0 || !std::isfinite(a))
    {
        OGS_FATAL(
            "The value of the enhancement_factor for the nonwetting relative "
            "permeability must be non-negative and finite."
            "The value is {:g}, which is out of bounds.",
            a);
    }
 
    return std::make_unique<RelPermNonWettingPhaseVanGenuchtenMualem>(
        property_name, residual_liquid_saturation, residual_gas_saturation,
        exponent, min_relative_permeability, a);
}
}  // namespace MaterialPropertyLib