From e1e8f021fc555e1473c26e7ef5ee28d7b62636b8 Mon Sep 17 00:00:00 2001
From: Philipp Nuske <philipp.nuske@mailbox.org>
Date: Thu, 23 Feb 2012 12:44:38 +0000
Subject: [PATCH] proof reading of implicit model descriptions
git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@7889 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
dumux/boxmodels/2p/2pmodel.hh | 2 +-
dumux/boxmodels/2p2c/2p2cmodel.hh | 6 +++---
dumux/boxmodels/2p2cni/2p2cnimodel.hh | 2 +-
dumux/boxmodels/2pni/2pnimodel.hh | 2 +-
dumux/boxmodels/3p3c/3p3cmodel.hh | 14 +++++++-------
dumux/boxmodels/3p3cni/3p3cnimodel.hh | 12 ++++++------
dumux/boxmodels/mpnc/mpncmodel.hh | 4 ++--
7 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/dumux/boxmodels/2p/2pmodel.hh b/dumux/boxmodels/2p/2pmodel.hh
index 94b157a6f3..d134ce0def 100644
--- a/dumux/boxmodels/2p/2pmodel.hh
+++ b/dumux/boxmodels/2p/2pmodel.hh
@@ -59,7 +59,7 @@ namespace Dumux
\right\} - q_\alpha = 0 \;,
\f]
*
- * This equations are by a fully-coupled vertex centered finite volume
+ * These equations are discretized by a fully-coupled vertex centered finite volume
* (box) scheme as spatial and the implicit Euler method as time
* discretization.
*
diff --git a/dumux/boxmodels/2p2c/2p2cmodel.hh b/dumux/boxmodels/2p2c/2p2cmodel.hh
index ebd74dd92a..0d8c176d75 100644
--- a/dumux/boxmodels/2p2c/2p2cmodel.hh
+++ b/dumux/boxmodels/2p2c/2p2cmodel.hh
@@ -48,7 +48,7 @@ namespace Dumux
*
* By inserting this into the equations for the conservation of the
* components, one gets one transport equation for each component
- * \f{eqnarray}
+ * \f{eqnarray*}
&& \phi \frac{\partial (\sum_\alpha \varrho_\alpha X_\alpha^\kappa S_\alpha )}
{\partial t}
- \sum_\alpha \text{div} \left\{ \varrho_\alpha X_\alpha^\kappa
@@ -80,9 +80,9 @@ namespace Dumux
* <li> Both phases are present: The saturation is used (either \f$S_n\f$ or \f$S_w\f$, dependent on the chosen <tt>Formulation</tt>),
* as long as \f$ 0 < S_\alpha < 1\f$</li>.
* <li> Only wetting phase is present: The mass fraction of, e.g., air in the wetting phase \f$X^a_w\f$ is used,
- * as long as the maximum mass fraction is not exceeded (\f$X^a_w<X^a_{w,max}\f$)</li>
+ * as long as the maximum mass fraction is not exceeded \f$(X^a_w<X^a_{w,max})\f$</li>
* <li> Only non-wetting phase is present: The mass fraction of, e.g., water in the non-wetting phase, \f$X^w_n\f$, is used,
- * as long as the maximum mass fraction is not exceeded (\f$X^w_n<X^w_{n,max}\f$)</li>
+ * as long as the maximum mass fraction is not exceeded \f$(X^w_n<X^w_{n,max})\f$</li>
* </ul>
*/
diff --git a/dumux/boxmodels/2p2cni/2p2cnimodel.hh b/dumux/boxmodels/2p2cni/2p2cnimodel.hh
index ad8891db35..73d281a1f9 100644
--- a/dumux/boxmodels/2p2cni/2p2cnimodel.hh
+++ b/dumux/boxmodels/2p2cni/2p2cnimodel.hh
@@ -75,7 +75,7 @@ namespace Dumux {
* If both phases are present the primary variables are, like in the nonisothermal two-phase model, either \f$p_w\f$, \f$S_n\f$ and
* temperature or \f$p_n\f$, \f$S_w\f$ and temperature. The formulation which ought to be used can be
* specified by setting the <tt>Formulation</tt> property to either
- * <tt>TwoPTwoIndices::pWsN</tt> or <tt>TwoPTwoCIndices::pNsW</tt>. By
+ * <tt>TwoPTwoCIndices::pWsN</tt> or <tt>TwoPTwoCIndices::pNsW</tt>. By
* default, the model uses \f$p_w\f$ and \f$S_n\f$.
* In case that only one phase (nonwetting or wetting phase) is present the second primary
* variable represents a mass fraction. The correct assignment of the second
diff --git a/dumux/boxmodels/2pni/2pnimodel.hh b/dumux/boxmodels/2pni/2pnimodel.hh
index 2b9733d626..51651e724a 100644
--- a/dumux/boxmodels/2pni/2pnimodel.hh
+++ b/dumux/boxmodels/2pni/2pnimodel.hh
@@ -56,7 +56,7 @@ namespace Dumux {
* matrix and the fluids:
\f{align*}{
- \frac{\partial \phi \sum_alpha \varrho_\alpha u_\alpha S_\alpha}{\partial t}
+ \frac{\partial \phi \sum_\alpha \varrho_\alpha u_\alpha S_\alpha}{\partial t}
& +
\left( 1 - \phi \right) \frac{\partial (\varrho_s c_s T)}{\partial t}
-
diff --git a/dumux/boxmodels/3p3c/3p3cmodel.hh b/dumux/boxmodels/3p3c/3p3cmodel.hh
index 3ba9de566f..211495aebd 100644
--- a/dumux/boxmodels/3p3c/3p3cmodel.hh
+++ b/dumux/boxmodels/3p3c/3p3cmodel.hh
@@ -56,7 +56,7 @@ namespace Dumux
*
* By inserting this into the equations for the conservation of the
* components, one transport equation for each component is obtained as
- * \f{eqnarray}
+ * \f{eqnarray*}
&& \phi \frac{\partial (\sum_\alpha \varrho_{\text{mol}, \alpha} x_\alpha^\kappa
S_\alpha )}{\partial t}
- \sum\limits_\alpha \text{div} \left\{ \frac{k_{r\alpha}}{\mu_\alpha}
@@ -86,12 +86,12 @@ namespace Dumux
* An adaptive primary variable switch is included. The phase state is stored for all nodes
* of the system. The following cases can be distinguished:
* <ul>
- * <li> All three phases are present: Primary variables are two saturations (\f$S_w\f$ and \f$S_n\f$, and a pressure, in this case \f$p_g\f$. </li>
- * <li> Only the water phase is present: Primary variables are now the mole fractions of air and contaminant in the water phase (\f$x_w^a\f$ and \f$x_w^c\f$), as well as the gas pressure, which is, of course, in a case where only the water phase is present, just the same as the water pressure. </li>
- * <li> Gas and NAPL phases are present: Primary variables (\f$S_n\f$, \f$x_g^w\f$, \f$p_g\f$). </li>
- * <li> Water and NAPL phases are present: Primary variables (\f$S_n\f$, \f$x_w^a\f$, \f$p_g\f$). </li>
- * <li> Only gas phase is present: Primary variables (\f$x_g^w\f$, \f$x_g^c\f$, \f$p_g\f$). </li>
- * <li> Water and gas phases are present: Primary variables (\f$S_w\f$, \f$x_w^g\f$, \f$p_g\f$). </li>
+ * <li> All three phases are present: Primary variables are two saturations \f$(S_w\f$ and \f$S_n)\f$, and a pressure, in this case \f$p_g\f$. </li>
+ * <li> Only the water phase is present: Primary variables are now the mole fractions of air and contaminant in the water phase \f$(x_w^a\f$ and \f$x_w^c)\f$, as well as the gas pressure, which is, of course, in a case where only the water phase is present, just the same as the water pressure. </li>
+ * <li> Gas and NAPL phases are present: Primary variables \f$(S_n\f$, \f$x_g^w\f$, \f$p_g)\f$. </li>
+ * <li> Water and NAPL phases are present: Primary variables \f$(S_n\f$, \f$x_w^a\f$, \f$p_g)\f$. </li>
+ * <li> Only gas phase is present: Primary variables \f$(x_g^w\f$, \f$x_g^c\f$, \f$p_g)\f$. </li>
+ * <li> Water and gas phases are present: Primary variables \f$(S_w\f$, \f$x_w^g\f$, \f$p_g)\f$. </li>
* </ul>
*/
template<class TypeTag>
diff --git a/dumux/boxmodels/3p3cni/3p3cnimodel.hh b/dumux/boxmodels/3p3cni/3p3cnimodel.hh
index d5a701dda5..f47661dd16 100644
--- a/dumux/boxmodels/3p3cni/3p3cnimodel.hh
+++ b/dumux/boxmodels/3p3cni/3p3cnimodel.hh
@@ -94,12 +94,12 @@ namespace Dumux {
* An adaptive primary variable switch is included. The phase state is stored for all nodes
* of the system. The following cases can be distinguished:
* <ul>
- * <li> All three phases are present: Primary variables are two saturations (\f$S_w\f$ and \f$S_n\f$, a pressure, in this case \f$p_g\f$, and the temperature \f$T\f$. </li>
- * <li> Only the water phase is present: Primary variables are now the mole fractions of air and contaminant in the water phase (\f$x_w^a\f$ and \f$x_w^c\f$), as well as temperature and the gas pressure, which is, of course, in a case where only the water phase is present, just the same as the water pressure. </li>
- * <li> Gas and NAPL phases are present: Primary variables (\f$S_n\f$, \f$x_g^w\f$, \f$p_g\f$, \f$T\f$). </li>
- * <li> Water and NAPL phases are present: Primary variables (\f$S_n\f$, \f$x_w^a\f$, \f$p_g\f$, \f$T\f$). </li>
- * <li> Only gas phase is present: Primary variables (\f$x_g^w\f$, \f$x_g^c\f$, \f$p_g\f$, \f$T\f$). </li>
- * <li> Water and gas phases are present: Primary variables (\f$S_w\f$, \f$x_w^g\f$, \f$p_g\f$, \f$T\f$). </li>
+ * <li> All three phases are present: Primary variables are two saturations \f$(S_w\f$ and \f$S_n)\f$, a pressure, in this case \f$p_g\f$, and the temperature \f$T\f$. </li>
+ * <li> Only the water phase is present: Primary variables are now the mole fractions of air and contaminant in the water phase \f$(x_w^a\f$ and \f$x_w^c)\f$, as well as temperature and the gas pressure, which is, of course, in a case where only the water phase is present, just the same as the water pressure. </li>
+ * <li> Gas and NAPL phases are present: Primary variables \f$(S_n\f$, \f$x_g^w\f$, \f$p_g\f$, \f$T)\f$. </li>
+ * <li> Water and NAPL phases are present: Primary variables \f$(S_n\f$, \f$x_w^a\f$, \f$p_g\f$, \f$T)\f$. </li>
+ * <li> Only gas phase is present: Primary variables \f$(x_g^w\f$, \f$x_g^c\f$, \f$p_g\f$, \f$T)\f$. </li>
+ * <li> Water and gas phases are present: Primary variables \f$(S_w\f$, \f$x_w^g\f$, \f$p_g\f$, \f$T)\f$. </li>
* </ul>
*
*/
diff --git a/dumux/boxmodels/mpnc/mpncmodel.hh b/dumux/boxmodels/mpnc/mpncmodel.hh
index d23b0f628c..745683c400 100644
--- a/dumux/boxmodels/mpnc/mpncmodel.hh
+++ b/dumux/boxmodels/mpnc/mpncmodel.hh
@@ -61,7 +61,7 @@ namespace Dumux
\left\{
\frac{\varrho_\alpha}{\overline M_\alpha} x_\alpha^\kappa
\frac{k_{r\alpha}}{\mu_\alpha} \boldsymbol{K}
- \mathbf{grad}\left( p_\alpha - \varrho_{\alpha} g\right)
+ \text{grad}\left( p_\alpha - \varrho_{\alpha} g\right)
\right\}
\right)
= q^\kappa
@@ -82,7 +82,7 @@ namespace Dumux
* \f[ \forall \alpha: \sum_\kappa x_\alpha^\kappa = 1 \implies S_\alpha \geq 0 \f]
*
* Since at any given spatial location, a phase is always either
- * present or not present, the one of the strict equalities on the
+ * present or not present, one of the strict equalities on the
* right hand side is always true, i.e.
* \f[ \forall \alpha: S_\alpha \left( \sum_\kappa x_\alpha^\kappa - 1 \right) = 0 \f]
* always holds.
--
GitLab