From 14088e7ef7d69f37c2537e8b509ee649a5437f1f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dennis=20Gl=C3=A4ser?= <dennis.glaeser@iws.uni-stuttgart.de>
Date: Thu, 26 Jul 2018 14:36:56 +0200
Subject: [PATCH] [components][brine] add docu
---
dumux/material/components/brine.hh | 4 +++-
1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/dumux/material/components/brine.hh b/dumux/material/components/brine.hh
index 2fd76e8b11..29807c1d5f 100644
--- a/dumux/material/components/brine.hh
+++ b/dumux/material/components/brine.hh
@@ -43,6 +43,7 @@ namespace Components {
*
* \tparam Scalar The type used for scalar values
* \tparam H2O Static polymorphism: the Brine class can access all properties of the H2O class
+ * \note This is an implementation of brine as a pseudo-component with a constant salinity.
*/
template <class Scalar,
class H2O_Tabulated = Components::TabulatedComponent<Components::H2O<Scalar>>>
@@ -53,7 +54,8 @@ class Brine
{
public:
using H2O = Components::TabulatedComponent<Dumux::Components::H2O<Scalar>>;
- //HACK: If salinity is a pseudo-component, a constat value is used
+
+ // The constant salinity
static Scalar constantSalinity;
//! The ideal gas constant \f$\mathrm{[J/mol/K]}\f$
--
GitLab