RelPermBrooksCorey.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 "BaseLib/ConfigTree-fwd.h"
#include "MaterialLib/MPL/Property.h"
 
namespace MaterialPropertyLib
{
class Medium;
class Phase;
class Component;
class RelPermBrooksCorey final : public Property
{
private:
    const double residual_liquid_saturation_;
    const double residual_gas_saturation_;
    const double min_relative_permeability_;
    const double exponent_;
 
public:
    RelPermBrooksCorey(std::string name,
                       const double /*residual_liquid_saturation*/,
                       const double /*residual_gas_saturation*/,
                       const double /*min_relative_permeability_liquid_*/,
                       const double /*exponent*/
    );
 
    void checkScale() const override
    {
        if (!std::holds_alternative<Medium*>(scale_))
        {
            OGS_FATAL(
                "The property 'RelPermBrooksCorey' 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;
};
 
}  // namespace MaterialPropertyLib