From 11ae7f29a5bb92197892bcbcd755996b6d79bff8 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Thu, 21 Feb 2019 08:02:09 +0100
Subject: [PATCH] [Mat/MPL] Rename enum for consistency.
---
MaterialLib/MPL/Component.h | 12 ++++++------
MaterialLib/MPL/CreateProperty.cpp | 2 +-
MaterialLib/MPL/Medium.h | 12 ++++++------
MaterialLib/MPL/Properties/LinearProperty.cpp | 6 +++---
MaterialLib/MPL/Properties/LinearProperty.h | 8 ++++----
MaterialLib/MPL/Property.cpp | 6 +++---
MaterialLib/MPL/Property.h | 18 +++++++++---------
MaterialLib/MPL/VariableType.cpp | 18 +++++++++---------
MaterialLib/MPL/VariableType.h | 14 +++++++-------
9 files changed, 48 insertions(+), 48 deletions(-)
diff --git a/MaterialLib/MPL/Component.h b/MaterialLib/MPL/Component.h
index 98c264760d2..972dfbce089 100644
--- a/MaterialLib/MPL/Component.h
+++ b/MaterialLib/MPL/Component.h
@@ -51,19 +51,19 @@ public:
template <typename T>
T dValue(PropertyType const p,
VariableArray const& variable_array,
- Variables const variables) const
+ Variable const variable) const
{
- return property(p).template dValue<T>(variable_array, variables);
+ return property(p).template dValue<T>(variable_array, variable);
}
template <typename T>
T d2Value(PropertyType const p,
VariableArray const& variable_array,
- Variables const variables1,
- Variables const variables2) const
+ Variable const variable1,
+ Variable const variable2) const
{
- return property(p).template d2Value<T>(variable_array, variables1,
- variables2);
+ return property(p).template d2Value<T>(variable_array, variable1,
+ variable2);
}
std::string name() const;
diff --git a/MaterialLib/MPL/CreateProperty.cpp b/MaterialLib/MPL/CreateProperty.cpp
index a8f7ee4f1e7..0bffdcaf5ed 100644
--- a/MaterialLib/MPL/CreateProperty.cpp
+++ b/MaterialLib/MPL/CreateProperty.cpp
@@ -121,7 +121,7 @@ std::unique_ptr<MaterialPropertyLib::Property> createProperty(
//! \ogs_file_param{properties__property__LinearProperty__independent_variable__slope}
independent_variable_config.getConfigParameter<double>("slope");
- MaterialPropertyLib::Variables ivt =
+ MaterialPropertyLib::Variable ivt =
MaterialPropertyLib::convertStringToVariable(variable_name);
MaterialPropertyLib::IndependentVariable const iv{
diff --git a/MaterialLib/MPL/Medium.h b/MaterialLib/MPL/Medium.h
index 49c5eeec8e0..1bd7dad7a7f 100644
--- a/MaterialLib/MPL/Medium.h
+++ b/MaterialLib/MPL/Medium.h
@@ -62,19 +62,19 @@ public:
template <typename T>
T dValue(PropertyType const p,
VariableArray const& variable_array,
- Variables const variables) const
+ Variable const variable) const
{
- return property(p).template dValue<T>(variable_array, variables);
+ return property(p).template dValue<T>(variable_array, variable);
}
template <typename T>
T d2Value(PropertyType const p,
VariableArray const& variable_array,
- Variables const variables1,
- Variables const variables2) const
+ Variable const variable1,
+ Variable const variable2) const
{
- return property(p).template d2Value<T>(variable_array, variables1,
- variables2);
+ return property(p).template d2Value<T>(variable_array, variable1,
+ variable2);
}
private:
diff --git a/MaterialLib/MPL/Properties/LinearProperty.cpp b/MaterialLib/MPL/Properties/LinearProperty.cpp
index a50d4aab9b9..f1d70959ef6 100644
--- a/MaterialLib/MPL/Properties/LinearProperty.cpp
+++ b/MaterialLib/MPL/Properties/LinearProperty.cpp
@@ -30,7 +30,7 @@ PropertyDataType LinearProperty::value(
}
PropertyDataType LinearProperty::dValue(VariableArray const& /*variable_array*/,
- Variables const primary_variable) const
+ Variable const primary_variable) const
{
return _independent_variable.type == primary_variable
? _independent_variable.slope
@@ -39,8 +39,8 @@ PropertyDataType LinearProperty::dValue(VariableArray const& /*variable_array*/,
PropertyDataType LinearProperty::d2Value(
VariableArray const& /*variable_array*/,
- Variables const /*pv1*/,
- Variables const /*pv2*/) const
+ Variable const /*pv1*/,
+ Variable const /*pv2*/) const
{
return decltype(_value){};
}
diff --git a/MaterialLib/MPL/Properties/LinearProperty.h b/MaterialLib/MPL/Properties/LinearProperty.h
index e2985dd736d..7ba5ebe49d3 100644
--- a/MaterialLib/MPL/Properties/LinearProperty.h
+++ b/MaterialLib/MPL/Properties/LinearProperty.h
@@ -18,7 +18,7 @@ namespace MaterialPropertyLib
struct IndependentVariable
{
- Variables type;
+ Variable type;
VariableType reference_condition; // scalar or vector
VariableType slope; // scalar or matrix
};
@@ -40,12 +40,12 @@ public:
/// This method will compute the derivative of a property with respect to
/// the given primary variable.
PropertyDataType dValue(VariableArray const& variable_array,
- Variables const primary_variable) const override;
+ Variable const primary_variable) const override;
/// This method will compute the second derivative of a
/// property with respect to the given primary variables pv1 and pv2.
PropertyDataType d2Value(VariableArray const& variable_array,
- Variables const pv1,
- Variables const pv2) const override;
+ Variable const pv1,
+ Variable const pv2) const override;
private:
IndependentVariable const _independent_variable;
diff --git a/MaterialLib/MPL/Property.cpp b/MaterialLib/MPL/Property.cpp
index 53c0e46c072..10fca184d67 100644
--- a/MaterialLib/MPL/Property.cpp
+++ b/MaterialLib/MPL/Property.cpp
@@ -32,15 +32,15 @@ PropertyDataType Property::value(VariableArray const& /*variable_array*/) const
/// The default implementation of this method only returns the
/// property value derivative without altering it.
PropertyDataType Property::dValue(VariableArray const& /*variable_array*/,
- Variables const /*variables*/) const
+ Variable const /*variable*/) const
{
return _dvalue;
}
/// Default implementation: 2nd derivative of any constant property is zero.
PropertyDataType Property::d2Value(VariableArray const& /*variable_array*/,
- Variables const /*variables*/,
- Variables const /*variables*/) const
+ Variable const /*variable*/,
+ Variable const /*variable*/) const
{
return 0.0;
}
diff --git a/MaterialLib/MPL/Property.h b/MaterialLib/MPL/Property.h
index cc8f9c45f61..a086887db94 100644
--- a/MaterialLib/MPL/Property.h
+++ b/MaterialLib/MPL/Property.h
@@ -55,14 +55,14 @@ public:
/// variables that are passed as arguments.
virtual PropertyDataType value(VariableArray const& variable_array) const;
/// This virtual method will compute the derivative of a property
- /// with respect to the given variables pv.
+ /// with respect to the given variable pv.
virtual PropertyDataType dValue(VariableArray const& variable_array,
- Variables const variables) const;
+ Variable const variable) const;
/// This virtual method will compute the second derivative of a
/// property with respect to the given variables pv1 and pv2.
virtual PropertyDataType d2Value(VariableArray const& variable_array,
- Variables const variables1,
- Variables const variables2) const;
+ Variable const variable1,
+ Variable const variable2) const;
template <typename T>
T value() const
@@ -76,16 +76,16 @@ public:
}
template <typename T>
T dValue(VariableArray const& variable_array,
- Variables const variables) const
+ Variable const variable) const
{
- return boost::get<T>(dValue(variable_array, variables));
+ return boost::get<T>(dValue(variable_array, variable));
}
template <typename T>
T d2Value(VariableArray const& variable_array,
- Variables const& variables1,
- Variables const& variables2) const
+ Variable const& variable1,
+ Variable const& variable2) const
{
- return boost::get<T>(d2Value(variable_array, variables1, variables2));
+ return boost::get<T>(d2Value(variable_array, variable1, variable2));
}
protected:
diff --git a/MaterialLib/MPL/VariableType.cpp b/MaterialLib/MPL/VariableType.cpp
index a287735de5e..9c3df233edc 100644
--- a/MaterialLib/MPL/VariableType.cpp
+++ b/MaterialLib/MPL/VariableType.cpp
@@ -15,41 +15,41 @@
namespace MaterialPropertyLib
{
-Variables convertStringToVariable(std::string const& input)
+Variable convertStringToVariable(std::string const& input)
{
if (boost::iequals(input, "phase_pressure"))
{
- return Variables::phase_pressure;
+ return Variable::phase_pressure;
}
if (boost::iequals(input, "capillary_pressure"))
{
- return Variables::capillary_pressure;
+ return Variable::capillary_pressure;
}
if (boost::iequals(input, "gas_density"))
{
- return Variables::gas_density;
+ return Variable::gas_density;
}
if (boost::iequals(input, "liquid_density"))
{
- return Variables::liquid_density;
+ return Variable::liquid_density;
}
if (boost::iequals(input, "temperature"))
{
- return Variables::temperature;
+ return Variable::temperature;
}
if (boost::iequals(input, "liquid_saturation"))
{
- return Variables::liquid_saturation;
+ return Variable::liquid_saturation;
}
if (boost::iequals(input, "u"))
{
- return Variables::u;
+ return Variable::u;
}
OGS_FATAL(
"The variable name '%s' does not correspond to any known variable",
input.c_str());
- return Variables::number_of_variables; // to avoid the 'no return' warning
+ return Variable::number_of_variables; // to avoid the 'no return' warning
}
} // namespace MaterialPropertyLib
diff --git a/MaterialLib/MPL/VariableType.h b/MaterialLib/MPL/VariableType.h
index e7a55756701..15cd7b2ea89 100644
--- a/MaterialLib/MPL/VariableType.h
+++ b/MaterialLib/MPL/VariableType.h
@@ -34,10 +34,10 @@ using SymmTensor = std::array<double, 6>;
/// tensor components.
using Tensor = std::array<double, 9>;
-/// Variables is simply a list of all commonly used variables that are used to
-/// determine the size of the VariableArray. If the variable of your choice is
-/// missing, simply add it somewhere at the list, but above the last entry.
-enum Variables : int
+/// Enum Variable is simply a list of all commonly used variables that are used
+/// to determine the size of the VariableArray. If the variable of your choice
+/// is missing, simply add it somewhere at the list, but above the last entry.
+enum Variable : int
{
phase_pressure,
capillary_pressure,
@@ -54,9 +54,9 @@ enum Variables : int
using VariableType = boost::variant<double, Vector>;
/// The VariableArray is a std::array of fixed size. Its size is determined by
-/// the Variables enumerator list. Data type of that array is defined by the
+/// the Variable enumerator list. Data type of that array is defined by the
/// VariableType definition.
-using VariableArray = std::array<VariableType, Variables::number_of_variables>;
+using VariableArray = std::array<VariableType, Variable::number_of_variables>;
/// This method returns a value of type double from the variables array
inline double getScalar(VariableType pv)
@@ -64,5 +64,5 @@ inline double getScalar(VariableType pv)
return boost::get<double>(pv);
}
-Variables convertStringToVariable(std::string const& input);
+Variable convertStringToVariable(std::string const& input);
} // namespace MaterialPropertyLib
--
GitLab