From 09dbde2b28b56d87b86c6419e4abfe62651d71aa Mon Sep 17 00:00:00 2001
From: Dmitri Naumov <github@naumov.de>
Date: Tue, 16 Jun 2020 21:17:05 +0200
Subject: [PATCH] [MPL/Exp] Move all of docu into header file.
Move individual text snippets in single place.
Use \copydoc elsewhere for project tags.
---
.../property/Exponential/c_Exponential.md | 8 +-----
.../property/Exponential/exponent/t_factor.md | 2 +-
.../exponent/t_reference_condition.md | 2 +-
.../Exponential/exponent/t_variable_name.md | 2 +-
MaterialLib/MPL/Properties/Exponential.h | 27 +++++++++++++------
5 files changed, 23 insertions(+), 18 deletions(-)
diff --git a/Documentation/ProjectFile/properties/property/Exponential/c_Exponential.md b/Documentation/ProjectFile/properties/property/Exponential/c_Exponential.md
index 4a437f4d947..509ce518349 100644
--- a/Documentation/ProjectFile/properties/property/Exponential/c_Exponential.md
+++ b/Documentation/ProjectFile/properties/property/Exponential/c_Exponential.md
@@ -1,7 +1 @@
-Definition of a exponential property:
-\f$y(x) = y_{\textrm{offset}} + y_{\textrm{ref}} \exp(m (x - x_{\textrm{ref}}))\f$
-where
- - \f$y_{\textrm{ref}}\f$ is a reference value, for instance reference viscosity
- - \f$m\f$ is a factor influencing the exponent of the exponential relationship
- - \f$x_{\textrm{ref}}\f$ is a reference condition, for instance reference
- temperature
+\copydoc MaterialPropertyLib::Exponential
diff --git a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_factor.md b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_factor.md
index 5d84454ec47..253e9241bfa 100644
--- a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_factor.md
+++ b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_factor.md
@@ -1 +1 @@
-\f$f\f$ is a factor included in the exponent of the exponential relationship.
+\copydoc MaterialPropertyLib::ExponentData::factor
diff --git a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_reference_condition.md b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_reference_condition.md
index d2ce5c3ff3d..dfca0f86371 100644
--- a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_reference_condition.md
+++ b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_reference_condition.md
@@ -1 +1 @@
-A numeric value for the reference condition \f$x_{\textrm{ref}}\f$.
+\copydoc MaterialPropertyLib::ExponentData::reference_condition
diff --git a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_variable_name.md b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_variable_name.md
index f865903e1da..96f349b9e46 100644
--- a/Documentation/ProjectFile/properties/property/Exponential/exponent/t_variable_name.md
+++ b/Documentation/ProjectFile/properties/property/Exponential/exponent/t_variable_name.md
@@ -1 +1 @@
-The variable type the exponential relationship depends on.
+The independent variable name the exponential relationship depends on.
diff --git a/MaterialLib/MPL/Properties/Exponential.h b/MaterialLib/MPL/Properties/Exponential.h
index 6c8148b7cfa..15213ca5d4a 100644
--- a/MaterialLib/MPL/Properties/Exponential.h
+++ b/MaterialLib/MPL/Properties/Exponential.h
@@ -17,15 +17,26 @@ namespace MaterialPropertyLib
struct ExponentData
{
Variable type;
- VariableType reference_condition;
- VariableType factor;
+ VariableType
+ reference_condition; ///< a reference condition value of independent
+ ///< variable, for instance reference temperature.
+ VariableType factor; ///< a dimensionless exponent.
};
-/// The exponential property class. This property calculates the exponential
-/// relationship \f$ \alpha(\beta) = \alpha_{\mathrm{offset}} +
-/// \alpha_{\mathrm{ref}} \cdot \exp (-s (\beta - \beta_{\mathrm{ref}})\f$.
-/// The current implementation accepts only the double datatype defined in
-/// PropertyDataType.
+/// An exponential property.
+///
+/// This property calculates the exponential relationship \f$ \alpha(\beta) =
+/// \alpha_{\mathrm{offset}} + \alpha_{\mathrm{ref}} \cdot \exp (m (\beta -
+/// \beta_{\mathrm{ref}})\f$, where:
+/// - \f$\alpha_{\mathrm{ref}}\f$ is a reference value, for instance reference
+/// viscosity,
+/// - \f$\alpha_{\mathrm{offset}}\f$ is additive offset in units of the
+/// property,
+/// - \f$m\f$ is a dimensionless exponent,
+/// - \f$\beta_{\mathrm{ref}}\f$ is a reference condition value of independent
+/// variable, for instance reference temperature.
+///
+/// The current implementation accepts only the scalar independent variables.
class Exponential final : public Property
{
public:
@@ -58,6 +69,6 @@ public:
private:
ExponentData const exponent_data_;
- double const offset_; //< additive offset in units of the property.
+ double const offset_; ///< additive offset in units of the property.
};
} // namespace MaterialPropertyLib
--
GitLab