[testing] sequential running for flow

CMakeLists.txt

@@ -283,6 +283,25 @@ opm_add_test(flow_blackoil_dunecpr
   DEPENDS opmsimulators
   LIBRARIES opmsimulators)
 
+opm_add_test(flow_blackoil_dunecpr_noflex
+  ONLY_COMPILE
+  DEFAULT_ENABLE_IF ${FLOW_VARIANTS_DEFAULT_ENABLE_IF}
+  SOURCES flow/flow_blackoil_dunecpr_noflex.cpp
+  $<TARGET_OBJECTS:moduleVersion>
+  EXE_NAME flow_blackoil_dunecpr_noflex
+  DEPENDS "opmsimulators"
+  LIBRARIES "opmsimulators")
+
+opm_add_test(flow_blackoil_dunecpr_seq
+  ONLY_COMPILE
+  DEFAULT_ENABLE_IF ${FLOW_VARIANTS_DEFAULT_ENABLE_IF}
+  SOURCES flow/flow_blackoil_dunecpr_seq.cpp
+  $<TARGET_OBJECTS:moduleVersion>
+  EXE_NAME flow_blackoil_dunecpr_seq
+  DEPENDS "opmsimulators"
+  LIBRARIES "opmsimulators")
+
+
 opm_add_test(flow_onephase
   ONLY_COMPILE
   DEFAULT_ENABLE_IF ${FLOW_VARIANTS_DEFAULT_ENABLE_IF}

compareECLFiles.cmake

@@ -196,6 +196,14 @@ add_test_compareECLFiles(CASENAME spe1
                          ABS_TOL ${abs_tol}
                          REL_TOL ${coarse_rel_tol})
 
+add_test_compareECLFiles(CASENAME spe12_seq
+                         FILENAME SPE1CASE2
+                         SIMULATOR flow_blackoil_dunecpr_seq
+                         ABS_TOL ${abs_tol}
+                         REL_TOL ${rel_tol}
+                         DIR spe1
+                         TEST_ARGS --full-time-step-initially=true --enable-adaptive-time-stepping=false   --simulation-type=seq  --enable-storage-cache=false)
+
 add_test_compareECLFiles(CASENAME spe1_2p
                          FILENAME SPE1CASE2_2P
                          SIMULATOR flow

ebos/ebos_plain.cc

@@ -35,7 +35,7 @@ namespace Opm::Properties {
 
 namespace TTag {
 struct EbosPlainTypeTag {
-    using InheritsFrom = std::tuple<EclBaseProblem, BlackOilModel>;
+    using InheritsFrom = std::tuple<EclBaseProblem, BlackOilModel, FlowModelParameters>;
 };
 }
 

ebos/eclblackoilnewtonmethod.hh

@@ -0,0 +1,325 @@
+// -*- mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
+// vi: set et ts=4 sw=4 sts=4:
+/*
+  This file is part of the Open Porous Media project (OPM).
+
+  OPM 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.
+
+  OPM 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 OPM.  If not, see <http://www.gnu.org/licenses/>.
+
+  Consult the COPYING file in the top-level source directory of this
+  module for the precise wording of the license and the list of
+  copyright holders.
+*/
+/*!
+ * \file
+ *
+ * \copydoc Opm::BlackOilNewtonMethod
+ */
+#ifndef EWOMS_ECL_BLACK_OIL_NEWTON_METHOD_HH
+#define EWOMS_ECL_BLACK_OIL_NEWTON_METHOD_HH
+
+#include <opm/models/blackoil/blackoilnewtonmethod.hh>
+
+namespace Opm {
+
+/*!
+ * \ingroup BlackOilModel
+ *
+ * \brief A newton solver which is specific to the black oil model.
+ */
+template <class TypeTag>
+class EclBlackOilNewtonMethod : public GetPropType<TypeTag, Properties::DiscNewtonMethod>
+{
+    using ParentType = GetPropType<TypeTag, Properties::DiscNewtonMethod>;
+    using Simulator = GetPropType<TypeTag, Properties::Simulator>;
+    using SolutionVector = GetPropType<TypeTag, Properties::SolutionVector>;
+    using GlobalEqVector = GetPropType<TypeTag, Properties::GlobalEqVector>;
+    using PrimaryVariables = GetPropType<TypeTag, Properties::PrimaryVariables>;
+    using EqVector = GetPropType<TypeTag, Properties::EqVector>;
+    using Indices = GetPropType<TypeTag, Properties::Indices>;
+    using Scalar = GetPropType<TypeTag, Properties::Scalar>;
+    using Linearizer = GetPropType<TypeTag, Properties::Linearizer>;
+
+    static const unsigned numEq = getPropValue<TypeTag, Properties::NumEq>();
+
+public:
+    EclBlackOilNewtonMethod(Simulator& simulator) : ParentType(simulator)
+    {
+        priVarOscilationThreshold_ = EWOMS_GET_PARAM(TypeTag, Scalar, PriVarOscilationThreshold);
+        dpMaxRel_ = EWOMS_GET_PARAM(TypeTag, Scalar, DpMaxRel);
+        dsMax_ = EWOMS_GET_PARAM(TypeTag, Scalar, DsMax);
+        projectSaturations_ = EWOMS_GET_PARAM(TypeTag, bool, ProjectSaturations);
+    }
+
+    /*!
+     * \copydoc NewtonMethod::finishInit()
+     */
+    void finishInit()
+    {
+        ParentType::finishInit();
+
+        wasSwitched_.resize(this->model().numTotalDof());
+        std::fill(wasSwitched_.begin(), wasSwitched_.end(), false);
+    }
+
+    /*!
+     * \brief Register all run-time parameters for the immiscible model.
+     */
+    static void registerParameters()
+    {
+        ParentType::registerParameters();
+
+        EWOMS_REGISTER_PARAM(TypeTag, Scalar, DpMaxRel, "Maximum relative change of pressure in a single iteration");
+        EWOMS_REGISTER_PARAM(TypeTag, Scalar, DsMax, "Maximum absolute change of any saturation in a single iteration");
+        EWOMS_REGISTER_PARAM(TypeTag, Scalar, PriVarOscilationThreshold,
+                             "The threshold value for the primary variable switching conditions after its meaning has switched to hinder oscilations");
+        EWOMS_REGISTER_PARAM(TypeTag,bool, ProjectSaturations, "Option for doing saturation projection");
+    }
+
+    /*!
+     * \brief Returns the number of degrees of freedom for which the
+     *        interpretation has changed for the most recent iteration.
+     */
+    unsigned numPriVarsSwitched() const
+    { return numPriVarsSwitched_; }
+
+protected:
+    friend NewtonMethod<TypeTag>;
+    friend ParentType;
+
+    /*!
+     * \copydoc FvBaseNewtonMethod::beginIteration_
+     */
+    void beginIteration_()
+    {
+        numPriVarsSwitched_ = 0;
+        ParentType::beginIteration_();
+    }
+
+    /*!
+     * \copydoc FvBaseNewtonMethod::endIteration_
+     */
+    void endIteration_(SolutionVector& uCurrentIter,
+                       const SolutionVector& uLastIter)
+    {
+#if HAVE_MPI
+        // in the MPI enabled case we need to add up the number of DOF
+        // for which the interpretation changed over all processes.
+        int localSwitched = numPriVarsSwitched_;
+        MPI_Allreduce(&localSwitched,
+                      &numPriVarsSwitched_,
+                      /*num=*/1,
+                      MPI_INT,
+                      MPI_SUM,
+                      MPI_COMM_WORLD);
+#endif // HAVE_MPI
+
+        this->simulator_.model().newtonMethod().endIterMsg()
+            << ", num switched=" << numPriVarsSwitched_;
+
+        ParentType::endIteration_(uCurrentIter, uLastIter);
+    }
+
+public:
+    void update_(SolutionVector& nextSolution,
+                 const SolutionVector& currentSolution,
+                 const GlobalEqVector& solutionUpdate,
+                 const GlobalEqVector& currentResidual)
+    {
+        const auto& comm = this->simulator_.gridView().comm();
+
+        int succeeded;
+        try {
+            ParentType::update_(nextSolution,
+                                currentSolution,
+                                solutionUpdate,
+                                currentResidual);
+            succeeded = 1;
+        }
+        catch (...) {
+            std::cout << "Newton update threw an exception on rank "
+                      << comm.rank() << "\n";
+            succeeded = 0;
+        }
+        succeeded = comm.min(succeeded);
+
+        if (!succeeded)
+            throw Opm::NumericalIssue("A process did not succeed in adapting the primary variables");
+
+        numPriVarsSwitched_ = comm.sum(numPriVarsSwitched_);
+    }
+
+protected:
+    /*!
+     * \copydoc FvBaseNewtonMethod::updatePrimaryVariables_
+     */
+    void updatePrimaryVariables_(unsigned globalDofIdx,
+                                 PrimaryVariables& nextValue,
+                                 const PrimaryVariables& currentValue,
+                                 const EqVector& update,
+                                 const EqVector& currentResidual)
+    {
+        static constexpr bool enableSolvent = Indices::solventSaturationIdx >= 0;
+        static constexpr bool enablePolymer = Indices::polymerConcentrationIdx >= 0;
+        static constexpr bool enablePolymerWeight = Indices::polymerMoleWeightIdx >= 0;
+        static constexpr bool enableEnergy = Indices::temperatureIdx >= 0;
+        static constexpr bool enableFoam = Indices::foamConcentrationIdx >= 0;
+        static constexpr bool enableBrine = Indices::saltConcentrationIdx >= 0;
+
+        currentValue.checkDefined();
+        Opm::Valgrind::CheckDefined(update);
+        Opm::Valgrind::CheckDefined(currentResidual);
+
+        // saturation delta for each phase
+        Scalar deltaSw = 0.0;
+        Scalar deltaSo = 0.0;
+        Scalar deltaSg = 0.0;
+        Scalar deltaSs = 0.0;
+
+        if (Indices::waterEnabled) {
+            deltaSw = update[Indices::waterSaturationIdx];
+            deltaSo = -deltaSw;
+        }
+
+        if (Indices::gasEnabled && currentValue.primaryVarsMeaning() == PrimaryVariables::Sw_po_Sg) {
+            deltaSg = update[Indices::compositionSwitchIdx];
+            deltaSo -= deltaSg;
+        }
+
+        if (enableSolvent) {
+            deltaSs = update[Indices::solventSaturationIdx];
+            deltaSo -= deltaSs;
+        }
+
+        // maximum saturation delta
+        Scalar maxSatDelta = std::max(std::abs(deltaSg), std::abs(deltaSo));
+        maxSatDelta = std::max(maxSatDelta, std::abs(deltaSw));
+        maxSatDelta = std::max(maxSatDelta, std::abs(deltaSs));
+
+        // scaling factor for saturation deltas to make sure that none of them exceeds
+        // the specified threshold value.
+        Scalar satAlpha = 1.0;
+        if (maxSatDelta > dsMax_)
+            satAlpha = dsMax_/maxSatDelta;
+
+        for (int pvIdx = 0; pvIdx < int(numEq); ++pvIdx) {
+            // calculate the update of the current primary variable. For the black-oil
+            // model we limit the pressure delta relative to the pressure's current
+            // absolute value (Default: 30%) and saturation deltas to an absolute change
+            // (Default: 20%). Further, we ensure that the R factors, solvent
+            // "saturation" and polymer concentration do not become negative after the
+            // update.
+            Scalar delta = update[pvIdx];
+
+            // limit pressure delta
+            if (pvIdx == Indices::pressureSwitchIdx) {
+                LinearizationType linearizationType = this->model().linearizer().getLinearizationType();
+                if (linearizationType.type == Opm::LinearizationType::seqtransport) {
+                    // TODO: set max update of ST
+                    delta =  Opm::signum(delta) * std::min(std::abs(delta), 0.1);
+                } else {
+                    if (std::abs(delta) > dpMaxRel_*currentValue[pvIdx])
+                        delta = Opm::signum(delta)*dpMaxRel_*currentValue[pvIdx];
+                }
+            }
+            // water saturation delta
+            else if (pvIdx == Indices::waterSaturationIdx)
+                delta *= satAlpha;
+            else if (pvIdx == Indices::compositionSwitchIdx) {
+                // the switching primary variable for composition is tricky because the
+                // "reasonable" value ranges it exhibits vary widely depending on its
+                // interpretation since it can represent Sg, Rs or Rv. For now, we only
+                // limit saturation deltas and ensure that the R factors do not become
+                // negative.
+                if (currentValue.primaryVarsMeaning() == PrimaryVariables::Sw_po_Sg)
+                    delta *= satAlpha;
+                else {
+                    if (delta > currentValue[Indices::compositionSwitchIdx])
+                        delta = currentValue[Indices::compositionSwitchIdx];
+                }
+            }
+            else if (enableSolvent && pvIdx == Indices::solventSaturationIdx)
+                // solvent saturation updates are also subject to the Appleyard chop
+                delta *= satAlpha;
+            else if (enablePolymerWeight && pvIdx == Indices::polymerMoleWeightIdx) {
+                const double sign = delta >= 0. ? 1. : -1.;
+                // maximum change of polymer molecular weight, the unit is MDa.
+                // applying this limit to stabilize the simulation. The value itself is still experimental.
+                const double maxMolarWeightChange = 100.0;
+                delta = sign * std::min(std::abs(delta), maxMolarWeightChange);
+                delta *= satAlpha;
+            }
+
+            // do the actual update
+            nextValue[pvIdx] = currentValue[pvIdx] - delta;
+
+            // keep the solvent saturation between 0 and 1
+            if (enableSolvent && pvIdx == Indices::solventSaturationIdx)
+                nextValue[pvIdx] = std::min(std::max(nextValue[pvIdx], 0.0), 1.0);
+
+            // keep the polymer concentration above 0
+            if (enablePolymer && pvIdx == Indices::polymerConcentrationIdx)
+                nextValue[pvIdx] = std::max(nextValue[pvIdx], 0.0);
+
+            if (enablePolymerWeight && pvIdx == Indices::polymerMoleWeightIdx) {
+                nextValue[pvIdx] = std::max(nextValue[pvIdx], 0.0);
+                const double polymerConcentration = nextValue[Indices::polymerConcentrationIdx];
+                if (polymerConcentration < 1.e-10)
+                    nextValue[pvIdx] = 0.0;
+            }
+
+            // keep the foam concentration above 0
+            if (enableFoam && pvIdx == Indices::foamConcentrationIdx)
+                nextValue[pvIdx] = std::max(nextValue[pvIdx], 0.0);
+
+            // keep the salt concentration above 0
+            if (enableBrine && pvIdx == Indices::saltConcentrationIdx)
+                nextValue[pvIdx] = std::max(nextValue[pvIdx], 0.0);
+
+            // keep the temperature above 100 and below 1000 Kelvin
+            if (enableEnergy && pvIdx == Indices::temperatureIdx)
+                nextValue[pvIdx] = std::max(std::min(nextValue[pvIdx], 1000.0), 100.0);
+        }
+
+        // switch the new primary variables to something which is physically meaningful.
+        // use a threshold value after a switch to make it harder to switch back
+        // immediately.
+        if (wasSwitched_[globalDofIdx])
+            wasSwitched_[globalDofIdx] = nextValue.adaptPrimaryVariables(this->problem(), globalDofIdx, priVarOscilationThreshold_);
+        else
+            wasSwitched_[globalDofIdx] = nextValue.adaptPrimaryVariables(this->problem(), globalDofIdx);
+
+        if (wasSwitched_[globalDofIdx])
+            ++ numPriVarsSwitched_;
+        if(projectSaturations_){
+            nextValue.chopAndNormalizeSaturations();
+        }
+
+        nextValue.checkDefined();
+    }
+
+private:
+    int numPriVarsSwitched_;
+
+    Scalar priVarOscilationThreshold_;
+    Scalar dpMaxRel_;
+    Scalar dsMax_;
+    bool projectSaturations_;
+
+    // keep track of cells where the primary variable meaning has changed
+    // to detect and hinder oscillations
+    std::vector<bool> wasSwitched_;
+};
+} // namespace Opm
+
+#endif