OGS
SaturationExponential.h
Go to the documentation of this file.
1
13#pragma once
14
16
17namespace MaterialPropertyLib
18{
38class SaturationExponential final : public Property
39{
40private:
41 const double
43 const double
45 const double p_cap_max_;
47 const double exponent_;
48
49public:
50 SaturationExponential(std::string name,
51 const double residual_liquid_saturation,
52 const double residual_gas_saturation,
53 const double p_cap_max, const double exponent);
54
55 void checkScale() const override
56 {
57 if (!std::holds_alternative<Medium*>(scale_))
58 {
60 "The property 'SaturationExponential' is implemented on the "
61 "'media' scale only.");
62 }
63 }
64
65 PropertyDataType value(VariableArray const& variable_array,
66 ParameterLib::SpatialPosition const& /*pos*/,
67 double const /*t*/,
68 double const /*dt*/) const override;
69 PropertyDataType dValue(VariableArray const& variable_array,
70 Variable const variable,
71 ParameterLib::SpatialPosition const& /*pos*/,
72 double const /*t*/,
73 double const /*dt*/) const override;
74 PropertyDataType d2Value(VariableArray const& variable_array,
75 Variable const /*variable1*/,
76 Variable const /*variable2*/,
77 ParameterLib::SpatialPosition const& /*pos*/,
78 double const /*t*/,
79 double const /*dt*/) const override;
80};
81} // namespace MaterialPropertyLib
#define OGS_FATAL(...)
Definition Error.h:26
virtual PropertyDataType value() const
Definition Property.cpp:76
std::variant< Medium *, Phase *, Component * > scale_
Definition Property.h:297
A simplistic soil characteristics function.
PropertyDataType dValue(VariableArray const &variable_array, Variable const variable, ParameterLib::SpatialPosition const &, double const, double const) const override
const double residual_gas_saturation_
Residual saturation of the liquid phase.
const double exponent_
Exponent to govern the shape of the curve.
SaturationExponential(std::string name, const double residual_liquid_saturation, const double residual_gas_saturation, const double p_cap_max, const double exponent)
const double residual_liquid_saturation_
Residual saturation of the gas phase.
PropertyDataType d2Value(VariableArray const &variable_array, Variable const, Variable const, ParameterLib::SpatialPosition const &, double const, double const) const override
Default implementation: 2nd derivative of any constant property is zero.
std::variant< double, Eigen::Matrix< double, 2, 1 >, Eigen::Matrix< double, 3, 1 >, Eigen::Matrix< double, 2, 2 >, Eigen::Matrix< double, 3, 3 >, Eigen::Matrix< double, 4, 1 >, Eigen::Matrix< double, 6, 1 >, Eigen::MatrixXd > PropertyDataType
Definition Property.h:31