Add friction laws manning + nikuradse

Add the frictions laws including the CMake stuff and the doxygen
documentation. In the next step the comments have to be completed and
the friction laws musst be tested.

dumux/material/fluidmatrixinteractions/CMakeLists.txt

@@ -3,6 +3,7 @@ add_subdirectory(1pia)
 add_subdirectory(2p)
 add_subdirectory(2pia)
 add_subdirectory(3p)
+add_subdirectory(frictionlaws)
 add_subdirectory(mp)
 
 install(FILES

dumux/material/fluidmatrixinteractions/frictionlaws/CMakeLists.txt

+install(FILES
+manning.hh
+nikuradse.hh
+DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}/dumux/material/fluidmatrixinteractions/frictionslaws)

dumux/material/fluidmatrixinteractions/frictionlaws/manning.hh

+// -*- 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 3 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
+ * \ingroup Fluidmatrixinteractions
+ * \brief Implementation of the friction law after Manning.
+ *
+ * The LET mobility model is used to limit the friction for small water depths.
+ */
+#ifndef DUMUX_FRICTIONLAW_MANNING_HH
+#define DUMUX_FRICTIONLAW_MANNING_HH
+
+#include <algorithm>
+#include <cmath>
+
+namespace Dumux {
+/*!
+ * \ingroup Fluidmatrixinteractions
+ * \brief Implementation of the friction law after Manning.
+ *
+ * The LET mobility model is used to limit the friction for small water depths.
+ */
+
+template <typename RF>
+class FrictionLawManning
+{
+public:
+    /*!
+     * \brief  The friction law after Manning.
+     * \param volVars volume variables
+     */
+
+    template<class VolumeVariables>
+    RF computeUstarH(const VolumeVariables& volVars, RF ks)
+    {
+        using std::pow;
+        using std::min;
+        using std::max
+        RF ustar_h = 0.0;
+        RF rough_h = pow(25.68/(1.0/ks),6.0);
+
+        // Limit the friction for small water depths with the LET model.
+        // ???Proberply timo will complain about the names???
+        const RF letL = 0.0;
+        const RF letT = 2.0;
+        const RF letE = 1.0;
+        RF mobility = 1.0;
+        RF krw = 1.0;
+        RF sw = 0.0;
+        auto minUpperH = rough_h * 2.0;
+        sw = min(volVars::getH * (1.0/minUpperH),1.0);
+        sw = max(0.0,sw);
+        mobility = (krw * pow(sw,letL))/(pow(sw,letL) + letE * pow(1.0-sw,letT));
+        rough_h = rough_h * (1.0 - mobility);
+
+        auto cfric = pow((volVars::getH + rough_h),1.0/6.0) * 1.0/(ks);
+        ustar_h = volVars::getGravity / pow(cfric,2.0);
+        return ustar_h;
+    }
+};
+
+} // end namespace Dumux
+
+#endif // DUMUX_FRICTIONLAW_MANNING_HH

dumux/material/fluidmatrixinteractions/frictionlaws/nikuradse.hh

+// -*- 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 3 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
+ * \ingroup Fluidmatrixinteractions
+ * \brief Implementation of the friction law after Nikuradse.
+ *
+ * The LET mobility model is used to limit the friction for small water depths.
+ */
+#ifndef DUMUX_FRICTIONLAW_NIKURADSE_HH
+#define DUMUX_FRICTIONLAW_NIKURADSE_HH
+
+#include <algorithm>
+#include <cmath>
+
+namespace Dumux {
+/*!
+ * \ingroup Fluidmatrixinteractions
+ * \brief Implementation of the friction law after Nikuradse.
+ *
+ * The LET mobility model is used to limit the friction for small water depths.
+ */
+
+template <typename RF, class VolumeVariables>
+class FrictionLawNikuradse
+{
+public:
+    /*!
+     * \brief Compute the friction ustar_h.
+     *
+     * \param volVars volume variables.
+     * \param ks the Strickler friction value.
+     */
+
+    RF computeUstarH(const VolumeVariables& volVars, RF ks)
+    {
+        using std::pow;
+        using std::log;
+
+        RF ustar_h = 0.0;
+        RF rough_h = ks;
+
+        rough_h = limitRoughH(rough_h, volVars);
+        ustar_h = pow(0.41,2.0)/pow(log((12*(volVars::getH + rough_h))/ks),2.0);
+        return ustar_h;
+    }
+
+    /*!
+     * \brief Limit the friction for small water depth.
+     *
+     * The friction is represented by the roughness height rough_h.
+     * For the limiting the LET model is used.
+     *
+     * \param rough_h roughness height of the representive structure (e.g. largest grain size).
+     * \param volVars volume variables.
+     */
+    RF limitRoughH(RF rough_h, const VolumeVariables volVars)
+    {
+        using std::pow;
+        using std::min;
+        using std::max;
+
+        const RF letL = 0.0;
+        const RF letT = 2.0;
+        const RF letE = 1.0;
+        RF mobility = 1.0;
+        RF krw = 1.0;
+        RF sw = 0.0;
+
+        auto minUpperH = rough_h * 2.0;
+        sw = min(volVars::getH * (1.0/minUpperH),1.0);
+        sw = max(0.0,sw);
+        mobility = (krw * pow(sw,letL))/(pow(sw,letL) + letE * pow(1.0-sw,letT));
+        return rough_h * (1.0 - mobility);
+    }
+
+};
+
+} // end namespace Dumux
+
+#endif // DUMUX_FRICTIONLAW_NIKURADSE_HH