From 8442eca396ddc5cc75604619635b7e08df8c58e3 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Tue, 2 Feb 2016 14:10:37 +0100
Subject: [PATCH] [material][mpnc][todos] Treat todos with no directly
 associated message

---
 .../binarycoefficients/air_mesitylene.hh      |  9 +++---
 .../material/binarycoefficients/air_xylene.hh |  9 +++---
 .../binarycoefficients/h2o_mesitylene.hh      |  4 +--
 .../material/binarycoefficients/h2o_xylene.hh |  4 +--
 .../mp/mplinearmaterial.hh                    | 28 -------------------
 .../implicit/energy/localresidualkinetic.hh   | 18 ++++++------
 .../mpnc/implicit/mass/localresidual.hh       |  2 --
 7 files changed, 20 insertions(+), 54 deletions(-)

diff --git a/dumux/material/binarycoefficients/air_mesitylene.hh b/dumux/material/binarycoefficients/air_mesitylene.hh
index bf6f2898b6..16aa8b903a 100644
--- a/dumux/material/binarycoefficients/air_mesitylene.hh
+++ b/dumux/material/binarycoefficients/air_mesitylene.hh
@@ -93,16 +93,15 @@ public:
     }
 
     /*!
-     * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular mesitylene in liquid water.
+     * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for air and mesitylene in liquid water.
      * \param temperature temperature in \f$\mathrm{[K]}\f$
      * \param pressure pressure in \f$\mathrm{[Pa]}\f$
-     *
-     * \todo
      */
     template <class Scalar>
     static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
-    { DUNE_THROW(Dune::NotImplemented,
-                 "Binary liquid diffusion coefficients of air and mesitylene");
+    {
+        DUNE_THROW(Dune::NotImplemented,
+                   "Binary liquid diffusion coefficients of air and mesitylene");
     }
 };
 
diff --git a/dumux/material/binarycoefficients/air_xylene.hh b/dumux/material/binarycoefficients/air_xylene.hh
index a59d66d668..3fdf2b4ca4 100644
--- a/dumux/material/binarycoefficients/air_xylene.hh
+++ b/dumux/material/binarycoefficients/air_xylene.hh
@@ -93,16 +93,15 @@ public:
     }
 
     /*!
-     * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for molecular xylene in liquid water.
+     * \brief Diffusion coefficient \f$\mathrm{[m^2/s]}\f$ for air and xylene in liquid water.
      * \param temperature temperature in \f$\mathrm{[K]}\f$
      * \param pressure pressure in \f$\mathrm{[Pa]}\f$
-     *
-     * \todo
      */
     template <class Scalar>
     static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
-    { DUNE_THROW(Dune::NotImplemented,
-                 "Binary liquid diffusion coefficients of air and xylene");
+    {
+        DUNE_THROW(Dune::NotImplemented,
+                   "Binary liquid diffusion coefficients of air and xylene");
     }
 };
 
diff --git a/dumux/material/binarycoefficients/h2o_mesitylene.hh b/dumux/material/binarycoefficients/h2o_mesitylene.hh
index 54dd75e010..ebf042d35a 100644
--- a/dumux/material/binarycoefficients/h2o_mesitylene.hh
+++ b/dumux/material/binarycoefficients/h2o_mesitylene.hh
@@ -104,12 +104,12 @@ public:
      * \param temperature the temperature \f$\mathrm{[K]}\f$
      * \param pressure the pressure \f$\mathrm{[Pa]}\f$
      *
-     * \todo
+     * \todo This is just a rough guess. Needs improvement and proper reference!
      */
     template <class Scalar>
     static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
     {
-        return 1.e-9;  // This is just an order of magnitude. Please improve it!
+        return 1.e-9;
     }
 };
 
diff --git a/dumux/material/binarycoefficients/h2o_xylene.hh b/dumux/material/binarycoefficients/h2o_xylene.hh
index f02fa606be..00f4048d26 100644
--- a/dumux/material/binarycoefficients/h2o_xylene.hh
+++ b/dumux/material/binarycoefficients/h2o_xylene.hh
@@ -106,12 +106,12 @@ public:
      * \param temperature the temperature \f$\mathrm{[K]}\f$
      * \param pressure the pressure \f$\mathrm{[Pa]}\f$
      *
-     * \todo
+     * \todo Returns just an order of magnitude. Please improve it!
      */
     template <class Scalar>
     static Scalar liquidDiffCoeff(Scalar temperature, Scalar pressure)
     {
-        return 1.e-9;  // This is just an order of magnitude. Please improve it!
+        return 1.e-9;
     }
 };
 
diff --git a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
index c4a89e24d2..a71b95f1c7 100644
--- a/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
+++ b/dumux/material/fluidmatrixinteractions/mp/mplinearmaterial.hh
@@ -76,34 +76,6 @@ public:
         }
     }
 
-#if 0
-#warning TODO
-    /*!
-     * \brief The saturation-capillary pressure curve.
-     *
-     * This is the inverse of the capillary pressure-saturation curve:
-     * \f[
-     S_w = 1 - \frac{p_C - p_{C,entry}}{p_{C,max} - p_{C,entry}}
-     \f]
-     *
-     * \param pc Capillary pressure \f$\p_C\f$ in \f$\mathrm{[Pa}\f$
-     * \return The effective saturaion of the wetting phase \f$\overline{S}_w\f$
-     */
-    template <class SatContainerT, class FluidState>
-    static void saturations(SatContainerT &saturations,
-                            const Params &params,
-                            const FluidState &state)
-    {
-        for (int i = 0; i < numPhases; ++i) {
-            saturations[i] =
-                (pc[i] - params.pcMaxSat(i))
-                /
-                (params.pcMinSat(i) - params.pcMaxSat(i));
-        }
-    }
-
-#endif
-
     /*!
      * \brief The relative permeability of all phases.
      * \param values Container for the return values
diff --git a/dumux/porousmediumflow/mpnc/implicit/energy/localresidualkinetic.hh b/dumux/porousmediumflow/mpnc/implicit/energy/localresidualkinetic.hh
index 2081a0b428..437a506612 100644
--- a/dumux/porousmediumflow/mpnc/implicit/energy/localresidualkinetic.hh
+++ b/dumux/porousmediumflow/mpnc/implicit/energy/localresidualkinetic.hh
@@ -204,11 +204,10 @@ public:
         const VolumeVariables & up = elemVolVars[upIdx];
         const VolumeVariables & dn = elemVolVars[dnIdx];
 
-        /* todo
-         * CAUTION: this is not exactly correct: does diffusion carry the upstream phase enthalpy?
-         * To be more precise this should be the components enthalpy.
-         * In the same vein: Counter current diffusion is not accounted for here.
-         */
+
+        // CAUTION: this is not exactly correct: does diffusion carry the upstream phase enthalpy?
+        // To be more precise this should be the components enthalpy.
+        // In the same vein: Counter current diffusion is not accounted for here.
         const Scalar transportedThingUp =  up.enthalpy(phaseIdx) ;
         const Scalar transportedThingDn =  dn.enthalpy(phaseIdx) ;
 
@@ -247,7 +246,7 @@ public:
 
         const Scalar ilambda        = iVolVar.thermalConductivity(phaseIdx);
         const Scalar klambda        = kVolVar.thermalConductivity(phaseIdx);
-        // todo which average?
+
         // Using a harmonic average is justified by its properties: if one phase does not conduct energy, there is no transfer
         const Scalar barLambda      = Dumux::harmonicMean(ilambda, klambda) ;
 
@@ -292,7 +291,6 @@ public:
         const  Scalar lambdaNonWetting  = volVars.thermalConductivity(nPhaseIdx);
         const  Scalar lambdaSolid       = volVars.thermalConductivity(sPhaseIdx);
 
-        // todo which average?
         // Using a harmonic average is justified by its properties: if one phase does not conduct energy, there is no transfer
         const Scalar lambdaWN      = Dumux::harmonicMean(lambdaWetting, lambdaNonWetting);
         const Scalar lambdaWS      = Dumux::harmonicMean(lambdaWetting, lambdaSolid);
@@ -571,9 +569,9 @@ public:
         const VolumeVariables & up = elemVolVars[upIdx];
         const VolumeVariables & dn = elemVolVars[dnIdx];
 
-        /* todo
-         * CAUTION: this is not exactly correct: does diffusion carry the upstream phase enthalpy? To be more precise this should be the components enthalpy. In the same vein: Counter current diffusion is not accounted for here.
-         */
+        // CAUTION: this is not exactly correct: does diffusion carry the upstream phase enthalpy?
+        // To be more precise this should be the components enthalpy.
+        // In the same vein: Counter current diffusion is not accounted for here.
         const Scalar transportedThingUp =  up.enthalpy(phaseIdx) ;
         const Scalar transportedThingDn =  dn.enthalpy(phaseIdx) ;
 
diff --git a/dumux/porousmediumflow/mpnc/implicit/mass/localresidual.hh b/dumux/porousmediumflow/mpnc/implicit/mass/localresidual.hh
index 7ad8af1e1b..455c5a7dd2 100644
--- a/dumux/porousmediumflow/mpnc/implicit/mass/localresidual.hh
+++ b/dumux/porousmediumflow/mpnc/implicit/mass/localresidual.hh
@@ -343,8 +343,6 @@ public:
 //        std::cout<< "KPN Mass: flux: " << flux << endl;
 
 
-        // \todo
-        //
         // The computeflux() of the Energy module needs a
         // component-wise flux (for the diffusive enthalpy transport)
         // It makes some sense calling energy from here, because energy
-- 
GitLab