RelPermNonWettingPhaseVanGenuchtenMualem.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <limits>
 
#include "BaseLib/ConfigTree-fwd.h"
#include "MaterialLib/MPL/Property.h"
 
namespace MaterialPropertyLib
{
class Medium;

class RelPermNonWettingPhaseVanGenuchtenMualem final : public Property
{
public:
    RelPermNonWettingPhaseVanGenuchtenMualem(std::string name,
                                             const double S_L_r,
                                             const double S_n_r,
                                             const double m,
                                             const double krel_min,
                                             const double a);
 
    void checkScale() const override
    {
        if (!std::holds_alternative<Medium*>(scale_))
        {
            OGS_FATAL(
                "The property 'RelPermNonWettingPhaseVanGenuchtenMualem' is "
                "implemented on the 'media' scale only.");
        }
    }

    PropertyDataType value(VariableArray const& variable_array,
                           ParameterLib::SpatialPosition const& pos,
                           double const t, double const dt) const override;

    PropertyDataType dValue(VariableArray const& variable_array,
                            Variable const variable,
                            ParameterLib::SpatialPosition const& pos,
                            double const t, double const dt) const override;

    double computeSaturationForMinimumRelativePermeability() const;
 
private:
    const double S_L_r_;     
    const double S_L_max_;   
    const double m_;         
    const double krel_min_;  
    const double
        S_L_for_krel_min_;  
    const double a_;
};
}  // namespace MaterialPropertyLib