Merge pull request #6424 from lechevaa/HybridNewton_flag

Hybrid newton flag

Author: daavid00

CMakeLists_files.cmake

@@ -934,6 +934,7 @@ list (APPEND PUBLIC_HEADER_FILES
   opm/simulators/flow/GenericThresholdPressure_impl.hpp
   opm/simulators/flow/GenericTracerModel.hpp
   opm/simulators/flow/GenericTracerModel_impl.hpp
+  opm/simulators/flow/HybridNewton.hpp
   opm/simulators/flow/InterRegFlows.hpp
   opm/simulators/flow/KeywordValidation.hpp
   opm/simulators/flow/LogOutputHelper.hpp

opm/models/blackoil/blackoilenergymodules.hh

@@ -264,7 +264,7 @@ public:
                                   const FluidState& fluidState)
     {
         if constexpr (enableEnergy) {
-            priVars[temperatureIdx] = fluidState.temperature(/*phaseIdx=*/0);
+            priVars[temperatureIdx] = getValue(fluidState.temperature(/*phaseIdx=*/0));
         }
     }
 

opm/simulators/flow/FlowProblem.hpp

@@ -349,7 +349,7 @@ class FlowProblem : public GetPropType<TypeTag, Properties::BaseProblem>
     /*!
      * \brief Called by the simulator before each time integration.
      */
-    void beginTimeStep()
+    virtual void beginTimeStep()
     {
         OPM_TIMEBLOCK(beginTimeStep);
         const int episodeIdx = this->episodeIndex();
@@ -376,7 +376,6 @@ class FlowProblem : public GetPropType<TypeTag, Properties::BaseProblem>
         wellModel_.beginTimeStep();
         aquiferModel_.beginTimeStep();
         tracerModel_.beginTimeStep();
-
     }
 
     /*!

opm/simulators/flow/FlowProblemBlackoil.hpp

@@ -52,6 +52,8 @@
 #include <opm/simulators/flow/MixingRateControls.hpp>
 #include <opm/simulators/flow/OutputBlackoilModule.hpp>
 #include <opm/simulators/flow/VtkTracerModule.hpp>
+#include <opm/simulators/flow/HybridNewton.hpp> 
+#include <opm/simulators/flow/HybridNewtonConfig.hpp> 
 
 #include <opm/simulators/utils/satfunc/SatfuncConsistencyCheckManager.hpp>
 
@@ -148,6 +150,7 @@ class FlowProblemBlackoil : public FlowProblem<TypeTag>
     using DiffusionModule = BlackOilDiffusionModule<TypeTag, enableDiffusion>;
     using ConvectiveMixingModule = BlackOilConvectiveMixingModule<TypeTag, enableConvectiveMixing>;
     using ModuleParams = typename BlackOilLocalResidualTPFA<TypeTag>::ModuleParams;
+    using HybridNewton = BlackOilHybridNewton<TypeTag>;
 
     using InitialFluidState = typename EquilInitializer<TypeTag>::ScalarFluidState;
     using EclWriterType = EclWriter<TypeTag, OutputBlackOilModule<TypeTag> >;
@@ -188,6 +191,7 @@ class FlowProblemBlackoil : public FlowProblem<TypeTag>
                          simulator.vanguard().summaryState(),
                          this->wellModel_,
                          simulator.vanguard().grid().comm())
+        , hybridNewton_(simulator)
     {
         this->model().addOutputModule(std::make_unique<VtkTracerModule<TypeTag>>(simulator));
 
@@ -264,6 +268,15 @@ class FlowProblemBlackoil : public FlowProblem<TypeTag>
                                              this->moduleParams_.convectiveMixingModuleParam);
     }
 
+    /*!
+     * \brief Called by the simulator before each time integration.
+     */
+    void beginTimeStep() override
+    {
+        FlowProblemType::beginTimeStep();
+        hybridNewton_.tryApplyHybridNewton();
+    }
+
     /*!
      * \copydoc FvBaseProblem::finishInit
      */
@@ -1695,6 +1708,8 @@ class FlowProblemBlackoil : public FlowProblem<TypeTag>
 
     ModuleParams moduleParams_;
 
+    HybridNewton hybridNewton_;
+
 private:
     /// Whether or not the current epsiode will end at the end of the
     /// current time step.

opm/simulators/flow/FlowProblemParameters.cpp

@@ -68,6 +68,12 @@ void registerFlowProblemParameters()
 
     Parameters::Register<Parameters::NumSatfuncConsistencySamplePoints>
         ("Maximum number of reported failures for each individual saturation function consistency check");
+    
+    Parameters::Register<Parameters::HyNeConfigFile>
+        ("Use config files for Hybrid Newton");
+
+    Parameters::Register<Parameters::UseHyNe>
+        ("Wheter or not to use Hybrid Newton");
 
     // By default, stop it after the universe will probably have stopped
     // to exist. (the ECL problem will finish the simulation explicitly

opm/simulators/flow/FlowProblemParameters.hpp

@@ -56,6 +56,11 @@ struct OutputMode { static constexpr auto value = "all"; };
 // between writing restart files
 struct RestartWritingInterval { static constexpr int value = 0xffffff; }; // disable
 
+// Path to the config file containing all Hybrid Newton parameters
+struct HyNeConfigFile { static constexpr auto value = "hybridNewtonConfig.json"; };
+// Wheter or not to use Hybrid Newton nonlinear preconditioning
+struct UseHyNe { static constexpr bool value = false; }; 
+
 } // namespace Opm::Parameters
 
 namespace Opm {