[Richards] implemented chop NewtonSolver

dumux/porousmediumflow/richards/model.hh

@@ -108,7 +108,6 @@
 #include "indices.hh"
 #include "volumevariables.hh"
 #include "vtkoutputfields.hh"
-#include "newtoncontroller.hh"
 #include "localresidual.hh"
 #include "primaryvariableswitch.hh"
 

dumux/porousmediumflow/richards/newtonsolver.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 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
+ * \ingroup RichardsModel
+ * \brief A Richards model newton solver.
+ */
+#ifndef DUMUX_RICHARDS_NEWTON_SOLVER_HH
+#define DUMUX_RICHARDS_NEWTON_SOLVER_HH
+
+#include <dumux/common/properties.hh>
+#include <dumux/nonlinear/newtonsolver.hh>
+
+namespace Dumux {
+/*!
+ * \ingroup RichardsModel
+ * \brief A Richards model specific newton solver.
+ *
+ * This controller 'knows' what a 'physically meaningful' solution is
+ * and can thus do update smarter than the plain Newton solver.
+ *
+ * \todo make this typetag independent by extracting anything model specific from assembler
+ *       or from possible ModelTraits.
+ */
+template <class TypeTag, class Assembler, class LinearSolver>
+class RichardsNewtonSolver : public NewtonSolver<Assembler, LinearSolver>
+{
+    using Scalar = typename Assembler::Scalar;
+    using ParentType = NewtonSolver<Assembler, LinearSolver>;
+    using SolutionVector = typename Assembler::ResidualType;
+
+    using MaterialLaw = typename GET_PROP_TYPE(TypeTag, MaterialLaw);
+    using ElementSolution =  typename GET_PROP_TYPE(TypeTag, ElementSolutionVector);
+    using Indices = typename GET_PROP_TYPE(TypeTag, Indices);
+    enum { pressureIdx = Indices::pressureIdx };
+
+public:
+    using ParentType::ParentType;
+
+private:
+
+    /*!
+     * \brief Update the current solution of the newton method
+     *
+     * \todo TODO: doc me!
+     *
+     * \param uCurrentIter The solution after the current Newton iteration \f$ u^{k+1} \f$
+     * \param uLastIter The solution after the last Newton iteration \f$ u^k \f$
+     * \param deltaU The vector of differences between the last
+     *               iterative solution and the next one \f$ \Delta u^k \f$
+     */
+    void choppedUpdate_(SolutionVector &uCurrentIter,
+                        const SolutionVector &uLastIter,
+                        const SolutionVector &deltaU) final
+    {
+        uCurrentIter = uLastIter;
+        uCurrentIter -= deltaU;
+
+        // do not clamp anything after 5 iterations
+        if (this->numSteps_ <= 4)
+        {
+            // clamp saturation change to at most 20% per iteration
+            const auto& fvGridGeometry = this->assembler().fvGridGeometry();
+            for (const auto& element : elements(fvGridGeometry.gridView()))
+            {
+                auto fvGeometry = localView(fvGridGeometry);
+                fvGeometry.bindElement(element);
+
+                for (auto&& scv : scvs(fvGeometry))
+                {
+                    auto dofIdxGlobal = scv.dofIndex();
+
+                    // calculate the old wetting phase saturation
+                    const auto& spatialParams = this->assembler().problem().spatialParams();
+                    const ElementSolution elemSol(element, uCurrentIter, fvGridGeometry);
+                    const auto& materialLawParams = spatialParams.materialLawParams(element, scv, elemSol);
+                    const Scalar pcMin = MaterialLaw::pc(materialLawParams, 1.0);
+                    const Scalar pw = uLastIter[dofIdxGlobal][pressureIdx];
+                    using std::max;
+                    const Scalar pn = max(this->assembler().problem().nonWettingReferencePressure(), pw + pcMin);
+                    const Scalar pcOld = pn - pw;
+                    const Scalar SwOld = max(0.0, MaterialLaw::sw(materialLawParams, pcOld));
+
+                    // convert into minimum and maximum wetting phase
+                    // pressures
+                    const Scalar pwMin = pn - MaterialLaw::pc(materialLawParams, SwOld - 0.2);
+                    const Scalar pwMax = pn - MaterialLaw::pc(materialLawParams, SwOld + 0.2);
+
+                    // clamp the result
+                    using std::min; using std::max;
+                    uCurrentIter[dofIdxGlobal][pressureIdx] = max(pwMin, min(uCurrentIter[dofIdxGlobal][pressureIdx], pwMax));
+                }
+            }
+        }
+
+        if (this->enableResidualCriterion())
+            this->computeResidualReduction_(uCurrentIter);
+
+        else
+        {
+            // If we get here, the convergence criterion does not require
+            // additional residual evalutions. Thus, the grid variables have
+            // not yet been updated to the new uCurrentIter.
+            this->assembler().updateGridVariables(uCurrentIter);
+        }
+    }
+};
+
+} // end namespace Dumux
+
+#endif

test/porousmediumflow/richards/implicit/test_richardslens_fv.cc

@@ -41,9 +41,7 @@
 #include <dumux/common/defaultusagemessage.hh>
 
 #include <dumux/linear/amgbackend.hh>
-#include <dumux/nonlinear/newtonmethod.hh>
-#include <dumux/nonlinear/newtoncontroller.hh>
-#include <dumux/porousmediumflow/richards/newtoncontroller.hh>
+#include <dumux/porousmediumflow/richards/newtonsolver.hh>
 
 #include <dumux/assembly/fvassembler.hh>
 
@@ -157,10 +155,8 @@ int main(int argc, char** argv) try
     auto linearSolver = std::make_shared<LinearSolver>(leafGridView, fvGridGeometry->dofMapper());
 
     // the non-linear solver
-    using NewtonController = Dumux::RichardsNewtonController<TypeTag>;
-    using NewtonMethod = Dumux::NewtonMethod<NewtonController, Assembler, LinearSolver>;
-    auto newtonController = std::make_shared<NewtonController>(timeLoop);
-    NewtonMethod nonLinearSolver(newtonController, assembler, linearSolver);
+    using NewtonSolver = Dumux::RichardsNewtonSolver<TypeTag, Assembler, LinearSolver>;
+    NewtonSolver nonLinearSolver(assembler, linearSolver, timeLoop);
 
     // time loop
     timeLoop->start(); do
@@ -201,7 +197,7 @@ int main(int argc, char** argv) try
         timeLoop->reportTimeStep();
 
         // set new dt as suggested by newton controller
-        timeLoop->setTimeStepSize(newtonController->suggestTimeStepSize(timeLoop->timeStepSize()));
+        timeLoop->setTimeStepSize(nonLinearSolver.suggestTimeStepSize(timeLoop->timeStepSize()));
 
     } while (!timeLoop->finished());