Commit 63a40f5f authored by Katharina Heck's avatar Katharina Heck
Browse files

[cleanup] biomin readme and comments

parent 23ee4776
# 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
......
......@@ -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
......
......@@ -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
......@@ -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
......
......@@ -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
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment