SaturationWeightedThermalConductivity.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/Error.h"
#include "MaterialLib/MPL/Property.h"
 
namespace ParameterLib
{
struct CoordinateSystem;
template <typename T>
struct Parameter;
}  // namespace ParameterLib
 
namespace MaterialPropertyLib
{
class Medium;
 
enum class MeanType
{
    ARITHMETIC_LINEAR,
    ARITHMETIC_SQUAREROOT,
    GEOMETRIC
};

template <MeanType MeantType, int GlobalDimension>
class SaturationWeightedThermalConductivity final : public Property
{
public:
    SaturationWeightedThermalConductivity(
        std::string name,
        ParameterLib::Parameter<double> const& dry_thermal_conductivity,
        ParameterLib::Parameter<double> const& wet_thermal_conductivity);
 
    void checkScale() const override
    {
        if (!std::holds_alternative<Medium*>(scale_))
        {
            OGS_FATAL(
                "The property 'SaturationWeightedThermalConductivity' 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;
 
private:
    ParameterLib::Parameter<double> const& dry_thermal_conductivity_;
    ParameterLib::Parameter<double> const& wet_thermal_conductivity_;
};
 
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_LINEAR,
    1>;
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_SQUAREROOT,
    1>;
extern template class SaturationWeightedThermalConductivity<MeanType::GEOMETRIC,
                                                            1>;
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_LINEAR,
    2>;
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_SQUAREROOT,
    2>;
extern template class SaturationWeightedThermalConductivity<MeanType::GEOMETRIC,
                                                            2>;
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_LINEAR,
    3>;
extern template class SaturationWeightedThermalConductivity<
    MeanType::ARITHMETIC_SQUAREROOT,
    3>;
extern template class SaturationWeightedThermalConductivity<MeanType::GEOMETRIC,
                                                            3>;
 
}  // namespace MaterialPropertyLib