From 63a40f5f0b14ebb29dea8006a17ce0db7c8c391e Mon Sep 17 00:00:00 2001
From: Katharina Heck <katharina.heck@iws.uni-stuttgart.de>
Date: Tue, 17 Jul 2018 14:33:14 +0200
Subject: [PATCH] [cleanup] biomin readme and comments
---
exercises/exercise-biomineralization/README.md | 2 +-
.../chemistry/simplebiominreactions.hh | 6 ++----
exercises/exercise-biomineralization/components/biofilm.hh | 6 +++---
exercises/exercise-biomineralization/fluidsystems/biomin.hh | 5 ++---
.../solidsystems/biominsolidphase.hh | 2 +-
5 files changed, 9 insertions(+), 12 deletions(-)
diff --git a/exercises/exercise-biomineralization/README.md b/exercises/exercise-biomineralization/README.md
index 1cb9bc4a..84eab853 100644
--- a/exercises/exercise-biomineralization/README.md
+++ b/exercises/exercise-biomineralization/README.md
@@ -1,6 +1,6 @@
# Exercise Biomineralization
-The aim of this exercise is to get a first glimpse with the _DuMuX_ way of implementing mineralization and reaction processes. In the scope of this exercise, the setting of boundary conditions is revisited and a new reaction term is implemented.
+The aim of this exercise is to get a first glimpse at the _DuMuX_ way of implementing mineralization and reaction processes. In the scope of this exercise, the setting of boundary conditions is revisited and a new reaction term is implemented.
## Problem set-up
diff --git a/exercises/exercise-biomineralization/chemistry/simplebiominreactions.hh b/exercises/exercise-biomineralization/chemistry/simplebiominreactions.hh
index 46804662..fff7201a 100644
--- a/exercises/exercise-biomineralization/chemistry/simplebiominreactions.hh
+++ b/exercises/exercise-biomineralization/chemistry/simplebiominreactions.hh
@@ -19,8 +19,7 @@
/*!
* \file
* \ingroup Chemistry
- * \brief The source and sink terms due to reactions are calculated in this class. The chemical functions and derivations are implemented in the private part of
- * class.
+ * \brief The source and sink terms due to reactions are calculated in this class.
*/
#ifndef DUMUX_BIOMIN_REACTIONS_HH
#define DUMUX_BIOMIN_REACTIONS_HH
@@ -29,8 +28,7 @@ namespace Dumux {
/*!
* \ingroup Chemistry
- * \brief The source and sink terms due to reactions are calculated in this class. The chemical functions and derivations are implemented in the private part of
- * class.
+ * \brief The source and sink terms due to reactions are calculated in this class.
*/
template <class TypeTag>
class SimpleBiominReactions
diff --git a/exercises/exercise-biomineralization/components/biofilm.hh b/exercises/exercise-biomineralization/components/biofilm.hh
index 07a7f367..c3348a09 100644
--- a/exercises/exercise-biomineralization/components/biofilm.hh
+++ b/exercises/exercise-biomineralization/components/biofilm.hh
@@ -19,7 +19,7 @@
/*!
* \file
* \ingroup Components
- * \brief A class for the biofilm solid phase properties.
+ * \brief A class for the biofilm solid component properties.
*/
#ifndef DUMUX_BIOFILM_HH
#define DUMUX_BIOFILM_HH
@@ -32,7 +32,7 @@ namespace Components {
/*!
* \ingroup Components
- * \brief A class for the biofilm solid phase properties.
+ * \brief A class for the biofilm solid component properties.
*/
template <class Scalar>
class Biofilm
@@ -74,4 +74,4 @@ public:
} // end namespace Components
} // end namespace Dumux
-#endif
\ No newline at end of file
+#endif
diff --git a/exercises/exercise-biomineralization/fluidsystems/biomin.hh b/exercises/exercise-biomineralization/fluidsystems/biomin.hh
index 35320d8e..6f4be1e8 100644
--- a/exercises/exercise-biomineralization/fluidsystems/biomin.hh
+++ b/exercises/exercise-biomineralization/fluidsystems/biomin.hh
@@ -41,13 +41,12 @@
namespace Dumux {
namespace FluidSystems {
-
+
/*!
* \ingroup Fluidsystems
* \brief A compositional fluid with brine and carbon dioxide as
* components in both, the liquid and the gas (supercritical) phase,
- * additional biomineralisation components and the solid phases
- * biofilm and calcite.
+ * additional biomineralisation components (Ca and Urea) in the liquid phase
*
* This class provides acess to the Bio fluid system when no property system is used.
* For Dumux users, using BioMinFluid<TypeTag> and the documentation therein is
diff --git a/exercises/exercise-biomineralization/solidsystems/biominsolidphase.hh b/exercises/exercise-biomineralization/solidsystems/biominsolidphase.hh
index 7f28853e..b7456766 100644
--- a/exercises/exercise-biomineralization/solidsystems/biominsolidphase.hh
+++ b/exercises/exercise-biomineralization/solidsystems/biominsolidphase.hh
@@ -36,7 +36,7 @@ namespace SolidSystems {
/*!
* \ingroup SolidSystems
- * \brief A solid phase consisting of a single inert solid component
+ * \brief A solid phase consisting of a single inert solid component and two reactive solid components
* \note a solid is considered inert if it can't dissolve in a liquid and
* and can't increase its mass by precipitation from a fluid phase.
* \note inert components have to come after all non-inert components
--
GitLab