Skip to content
Snippets Groups Projects
Commit 07ca1742 authored by wenqing's avatar wenqing
Browse files

[Mat] Corrected some documentations

parent 4784ea4d
No related branches found
No related tags found
No related merge requests found
...@@ -28,7 +28,11 @@ namespace Fluid ...@@ -28,7 +28,11 @@ namespace Fluid
class LinearTemperatureDependentDensity final : public FluidProperty class LinearTemperatureDependentDensity final : public FluidProperty
{ {
public: public:
/// \param parameters An array contains the five parameters. /** \param parameters An array contains the three parameters:
* [0] $f\rho_0$f
* [1] $fT_0$f
* [2] $f\beta$f
*/
explicit LinearTemperatureDependentDensity(std::array<double,3>& parameters) explicit LinearTemperatureDependentDensity(std::array<double,3>& parameters)
: _rho0(parameters[0]),_temperature0(parameters[1]),_beta(parameters[2]) : _rho0(parameters[0]),_temperature0(parameters[1]),_beta(parameters[2])
{ {
......
...@@ -52,7 +52,13 @@ namespace Fluid ...@@ -52,7 +52,13 @@ namespace Fluid
class LiquidDensity final : public FluidProperty class LiquidDensity final : public FluidProperty
{ {
public: public:
/// \param parameters An array contains the five parameters. /** \param parameters An array contains the five parameters:
* [0] $f \beta $f
* [1] $f \rho_0 $f
* [2] $f T_0 $f
* [3] $f p_0 $f
* [4] $f E_0 $f
*/
explicit LiquidDensity(std::array<double,5>& parameters) explicit LiquidDensity(std::array<double,5>& parameters)
: :
_beta(parameters[0]), _beta(parameters[0]),
......
...@@ -24,12 +24,12 @@ namespace MaterialLib ...@@ -24,12 +24,12 @@ namespace MaterialLib
{ {
namespace Fluid namespace Fluid
{ {
/* /*!
config ConfigTree object which contains the input data \param config ConfigTree object which contains the input data
including <type>fluid</type> and it has including <type>fluid</type> and it has
a tag of <density> a tag of <density>
*/ */
std::unique_ptr<FluidProperty> createLiquidDensity(BaseLib::ConfigTree const& config) static std::unique_ptr<FluidProperty> createLiquidDensity(BaseLib::ConfigTree const& config)
{ {
std::array<double, 5> parameters = std::array<double, 5> parameters =
{ {
...@@ -47,12 +47,12 @@ std::unique_ptr<FluidProperty> createLiquidDensity(BaseLib::ConfigTree const& co ...@@ -47,12 +47,12 @@ std::unique_ptr<FluidProperty> createLiquidDensity(BaseLib::ConfigTree const& co
return std::unique_ptr<FluidProperty>(new LiquidDensity(parameters)); return std::unique_ptr<FluidProperty>(new LiquidDensity(parameters));
} }
/* /*!
config ConfigTree object which contains the input data \param config ConfigTree object which contains the input data
including <type>fluid</type> and it has including <type>fluid</type> and it has
a tag of <density> a tag of <density>
*/ */
std::unique_ptr<FluidProperty> createLinearTemperatureDependentDensity static std::unique_ptr<FluidProperty> createLinearTemperatureDependentDensity
(BaseLib::ConfigTree const& config) (BaseLib::ConfigTree const& config)
{ {
std::array<double, 3> parameters = std::array<double, 3> parameters =
......
...@@ -26,11 +26,11 @@ enum class PropertyVariableType ...@@ -26,11 +26,11 @@ enum class PropertyVariableType
T = 0,///< temperature. T = 0,///< temperature.
pl = 1,///< pressure of the liquid phase (1st phase for some cases). pl = 1,///< pressure of the liquid phase (1st phase for some cases).
pg = 2,///< pressure of the gas phase (2nd phase for some cases). pg = 2,///< pressure of the gas phase (2nd phase for some cases).
vars_num = 3 ///< Number of property variables. number_of_variables = 3 ///< Number of property variables.
}; };
const unsigned PropertyVariableNumber const unsigned PropertyVariableNumber
= static_cast<unsigned> (PropertyVariableType::vars_num); = static_cast<unsigned> (PropertyVariableType::number_of_variables);
/// Base class of fluid density properties /// Base class of fluid density properties
class FluidProperty class FluidProperty
...@@ -55,7 +55,7 @@ public: ...@@ -55,7 +55,7 @@ public:
/// The first argument is an array of variables, and the order of the array /// The first argument is an array of variables, and the order of the array
/// elements is given in enum class PropertyVariableType. /// elements is given in enum class PropertyVariableType.
/// The second argument is the variable type indicating which partial derivative /// The second argument is the variable type indicating which partial derivative
/// to be get. /// to be calculated.
virtual double getdValue(const ArrayType& /* var_vals*/, virtual double getdValue(const ArrayType& /* var_vals*/,
const PropertyVariableType /* var */) const = 0; const PropertyVariableType /* var */) const = 0;
}; };
......
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