From c8b13c302ecc78caf3a21914e6edeaba43b0e688 Mon Sep 17 00:00:00 2001
From: Thomas Fetzer <thomas.fetzer@iws.uni-stuttgart.de>
Date: Mon, 23 Mar 2015 16:47:26 +0000
Subject: [PATCH] [comments]

adapted templates in diffusivityconstanttau.hh, which wasn't used
anyway.
added rhoSolid to the thermalconductivitylaws.
updated some comments and GNU licence.



git-svn-id: svn://svn.iws.uni-stuttgart.de/DUMUX/dumux/trunk@14430 2fb0f335-1f38-0410-981e-8018bf24f1b0
---
 dumux/io/plotoverline2d.hh                    | 21 ++++++++++++++++++-
 .../2p/regularizedbrookscoreyparams.hh        | 10 ++++-----
 .../2p/regularizedvangenuchtenparams.hh       | 16 ++++++--------
 .../thermalconductivitysimplefluidlumping.hh  |  3 ++-
 .../2p/thermalconductivitysomerton.hh         |  7 ++++---
 .../diffusivityconstanttau.hh                 | 19 +++++++----------
 .../diffusivitymillingtonquirk.hh             | 11 +++++-----
 7 files changed, 48 insertions(+), 39 deletions(-)

diff --git a/dumux/io/plotoverline2d.hh b/dumux/io/plotoverline2d.hh
index 7744622dd4..4d3bfcc9d3 100644
--- a/dumux/io/plotoverline2d.hh
+++ b/dumux/io/plotoverline2d.hh
@@ -1,7 +1,26 @@
+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*****************************************************************************
+ *   See the file COPYING for full copying permissions.                      *
+ *                                                                           *
+ *   This program is free software: you can redistribute it and/or modify    *
+ *   it under the terms of the GNU General Public License as published by    *
+ *   the Free Software Foundation, either version 2 of the License, or       *
+ *   (at your option) any later version.                                     *
+ *                                                                           *
+ *   This program is distributed in the hope that it will be useful,         *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
+ *   GNU General Public License for more details.                            *
+ *                                                                           *
+ *   You should have received a copy of the GNU General Public License       *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>.   *
+ *****************************************************************************/
 /*!
  * \file
  * \brief Plot variables over a line specified by two arguments.
- *          These output files are meant for visualization with another program (matlab, gnuplot...)
+ *        These output files are meant for visualization with another
+ *        program (matlab, gnuplot...)
  *
  */
 #ifndef DUMUX_PLOTOVERLINE_2D_HH
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
index f65cab8e45..25fc16eacb 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedbrookscoreyparams.hh
@@ -62,16 +62,14 @@ public:
      */
     Scalar thresholdSw() const
     {
-        // Some problems are very sensitive to this value
-        // (e.g. makeing it smaller might result in negative
-        // pressures), if you change it here, you will almost
-        // certainly break someone's code!
+        // Most problems are very sensitive to this value
+        // (e.g. making it smaller might result in negative
+        // pressures)
         //
         // If you want to use a different regularization threshold,
         // overload this class and supply the new class as second
         // template parameter for the RegularizedVanGenuchten law!
-        return /* PLEASE DO _NOT_ */ 1e-2; /* CHANGE THIS VALUE. READ
-                                            * COMMENT ABOVE! */
+        return 1e-2;
     }
 
 };
diff --git a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
index eb46c41245..7fcc3a6523 100644
--- a/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/regularizedvangenuchtenparams.hh
@@ -62,16 +62,14 @@ public:
      */
     Scalar pcLowSw() const
     {
-        // Some problems are very sensitive to this value
+        // Most problems are very sensitive to this value
         // (e.g. making it smaller might result in negative
-        // pressures), if you change it here, you will almost
-        // certainly break someone's code!
+        // pressures)
         //
         // If you want to use a different regularization threshold,
         // overload this class and supply the new class as second
         // template parameter for the RegularizedVanGenuchten law!
-        return /* PLEASE DO _NOT_ */ 1e-2; /* CHANGE THIS VALUE. READ
-                                            * COMMENT ABOVE! */
+        return 1e-2;
     }
 
     /*!
@@ -83,16 +81,14 @@ public:
      */
     Scalar pcHighSw() const
     {
-        // Some problems are very sensitive to this value
+        // Most problems are very sensitive to this value
         // (e.g. making it smaller might result in negative
-        // pressures), if you change it here, you will almost
-        // certainly break someone's code!
+        // pressures)
         //
         // If you want to use a different regularization threshold,
         // overload this class and supply the new class as second
         // template parameter for the RegularizedVanGenuchten law!
-        return /* PLEASE DO _NOT_ */ 99e-2; /* CHANGE THIS VALUE. READ
-                                             * COMMENT ABOVE! */
+        return 99e-2;
     }
 
     /*!
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
index 31697293bf..9165e1eec2 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysimplefluidlumping.hh
@@ -85,7 +85,8 @@ public:
                                                const Scalar lambdaW,
                                                const Scalar lambdaN,
                                                const Scalar lambdaSolid,
-                                               const Scalar porosity)
+                                               const Scalar porosity,
+                                               const Scalar rhoSolid = 0.0 /*unused*/)
     {
         assert(numEnergyEquations != 3) ;
 
diff --git a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
index c14eaf5909..e5227b44b8 100644
--- a/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
+++ b/dumux/material/fluidmatrixinteractions/2p/thermalconductivitysomerton.hh
@@ -29,7 +29,7 @@
 namespace Dumux
 {
 
-struct SimpleTwoPIndices
+struct SomertonIndices
 {
     static const int wPhaseIdx = 0;
     static const int nPhaseIdx = 1;
@@ -62,7 +62,7 @@ struct SimpleTwoPIndices
  \f]
  *
  */
-template<class Scalar, class Indices = SimpleTwoPIndices>
+template<class Scalar, class Indices = SomertonIndices>
 class ThermalConductivitySomerton
 {
 public:
@@ -114,7 +114,8 @@ public:
                                                const Scalar lambdaW,
                                                const Scalar lambdaN,
                                                const Scalar lambdaSolid,
-                                               const Scalar porosity)
+                                               const Scalar porosity,
+                                               const Scalar rhoSolid = 0.0 /*unused*/)
     {
         const Scalar satW = std::max<Scalar>(0.0, sw);
         // geometric mean
diff --git a/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh b/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
index 9f17f71d90..bc4eebd7a5 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivityconstanttau.hh
@@ -25,7 +25,7 @@
 #define DIFFUSIVITY_CONSTANT_TAU_HH
 
 #include <dumux/common/parameters.hh>
-#include <algorithm>
+#include <dumux/common/basicproperties.hh>
 
 namespace Dumux
 {
@@ -34,29 +34,24 @@ namespace Dumux
  *
  * \brief Relation for the saturation-dependent effective diffusion coefficient
  *
- *
  * The material law is:
  * \f[
- \lambda_\text{eff} = \phi * S_w * \tau * D
- \f]
- *
- * with
- * \f[
- \tau = \frac{1}{\phi^2} * \left(\phi S_w\right)^{7/3}
- \f]
+ *  D_\text{eff,pm} = \phi * S_w * \tau * D
+ * \f]
  *
+ * with a constant tau.
  */
-template<class TypeTag, class Scalar>
+template<class Scalar>
 class DiffusivityConstantTau
 {
 public:
     /*!
-     * \brief Returns the effective diffusion coefficient \f$[m/s]\f$ based on a constant tortuosity value
+     * \brief Returns the effective diffusion coefficient \f$[m^2/s]\f$ based
+     *        on a constant tortuosity value
      *
      * \param porosity The porosity
      * \param saturation The saturation of the phase
      * \param diffCoeff The diffusion coefficient of the phase
-     *
      */
     static Scalar effectiveDiffusivity(const Scalar porosity,
                                                const Scalar saturation,
diff --git a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
index 0289bdd5b1..dbdbeb3477 100644
--- a/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
+++ b/dumux/material/fluidmatrixinteractions/diffusivitymillingtonquirk.hh
@@ -36,13 +36,13 @@ namespace Dumux
  *
  * The material law is:
  * \f[
- \lambda_\text{eff} = \phi * S_w * \tau * D
- \f]
+ *  D_\text{eff,pm} = \phi * S_w * \tau * D
+ * \f]
  *
  * with
  * \f[
- \tau = \frac{1}{\phi^2} * \left(\phi S_w\right)^{7/3}
- \f]
+ *  \tau = \frac{1}{\phi^2} * \left(\phi S_w\right)^{7/3}
+ * \f]
  *
  */
 template<class Scalar>
@@ -50,12 +50,11 @@ class DiffusivityMillingtonQuirk
 {
 public:
     /*!
-     * \brief Returns the effective diffusion coefficient \f$[m/s]\f$ after Millington Quirk.
+     * \brief Returns the effective diffusion coefficient \f$[m^2/s]\f$ after Millington Quirk.
      *
      * \param porosity The porosity
      * \param saturation The saturation of the phase
      * \param diffCoeff The diffusion coefficient of the phase
-     *
      */
     static Scalar effectiveDiffusivity(const Scalar porosity,
                                                const Scalar saturation,
-- 
GitLab