Skip to content
Snippets Groups Projects
Verified Commit 09dbde2b authored by Dmitri Naumov's avatar Dmitri Naumov Committed by Lars Bilke
Browse files

[MPL/Exp] Move all of docu into header file.

Move individual text snippets in single place.
Use \copydoc elsewhere for project tags.
parent 20a00783
No related branches found
No related tags found
No related merge requests found
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
\f$f\f$ is a factor included in the exponent of the exponential relationship.
\copydoc MaterialPropertyLib::ExponentData::factor
A numeric value for the reference condition \f$x_{\textrm{ref}}\f$.
\copydoc MaterialPropertyLib::ExponentData::reference_condition
The variable type the exponential relationship depends on.
The independent variable name the exponential relationship depends on.
......@@ -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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment