From c3a40e5b9ef8175842697fd71a0b93b999e12b57 Mon Sep 17 00:00:00 2001
From: Thomas Fischer <thomas.fischer@ufz.de>
Date: Wed, 12 Apr 2017 14:58:13 +0200
Subject: [PATCH] Docu for concentration depenendent density.
---
.../ConcentrationDependent/c_ConcentrationDependent.md | 1 +
.../t_fluid_density_difference_ratio.md | 1 +
.../t_fluid_density_reference_concentration.md | 1 +
.../t_fluid_density_reference_density.md | 1 +
.../Fluid/Density/LinearConcentrationDependentDensity.h | 6 ++++++
5 files changed, 10 insertions(+)
create mode 100644 Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/c_ConcentrationDependent.md
create mode 100644 Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_difference_ratio.md
create mode 100644 Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md
create mode 100644 Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/c_ConcentrationDependent.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/c_ConcentrationDependent.md
new file mode 100644
index 00000000000..f5ce8b16c79
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/c_ConcentrationDependent.md
@@ -0,0 +1 @@
+\copydoc MaterialLib::Fluid::LinearConcentrationDependentDensity
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_difference_ratio.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_difference_ratio.md
new file mode 100644
index 00000000000..202846b20b2
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_difference_ratio.md
@@ -0,0 +1 @@
+\f$ \bar \alpha\f$ is the fluid density difference ratio
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md
new file mode 100644
index 00000000000..e200f1d8ff7
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_concentration.md
@@ -0,0 +1 @@
+\f$ C_{\text{ref}}\f$ is the reference concentration
diff --git a/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md
new file mode 100644
index 00000000000..37ddf686c4b
--- /dev/null
+++ b/Documentation/ProjectFile/material/fluid/density/ConcentrationDependent/t_fluid_density_reference_density.md
@@ -0,0 +1 @@
+\f$ \varrho_{\text{ref}}\f$ is the reference density
diff --git a/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h b/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h
index 9926ef7bc62..1754c912ecc 100644
--- a/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h
+++ b/MaterialLib/Fluid/Density/LinearConcentrationDependentDensity.h
@@ -20,6 +20,12 @@ namespace MaterialLib
namespace Fluid
{
/// Linear concentration dependent density model.
+/// \f[ \varrho = \varrho_{\text{ref}}
+/// (1 + \bar \alpha (C - C_{\text{ref}})) \f]
+/// where
+/// - \f$ \varrho_{\text{ref}}\f$ is the reference density
+/// - \f$ \bar \alpha\f$ is the fluid density difference ratio
+/// - \f$ C_{\text{ref}}\f$ is the reference concentration
class LinearConcentrationDependentDensity final : public FluidProperty
{
public:
--
GitLab