SaturationVanGenuchten.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 "MaterialLib/MPL/Property.h"
 
namespace MaterialPropertyLib
{
class Medium;
class Phase;
class Component;
class SaturationVanGenuchten final : public Property
{
public:
    SaturationVanGenuchten(std::string name,
                           double const residual_liquid_saturation,
                           double const residual_gas_saturation,
                           double const pressure_exponent,
                           double const saturation_exponent,
                           double const p_b);
 
    void checkScale() const override
    {
        if (!std::holds_alternative<Medium*>(scale_))
        {
            OGS_FATAL(
                "The property 'SaturationVanGenuchten' 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;
    PropertyDataType d2Value(VariableArray const& variable_array,
                             Variable const variable1, Variable const variable2,
                             ParameterLib::SpatialPosition const& /*pos*/,
                             double const /*t*/,
                             double const /*dt*/) const override;
 
private:
    double const S_L_res_;
    double const S_L_max_;
    double const m_;
    double const n_;
    double const p_b_;
};
}  // namespace MaterialPropertyLib