Ensure DIFFUSE is supported.

This is only instantiated for two-phase gas/oil and for 3-phase blackoil.
Runtime safeguards have been added to avoid the mistake of running with
a simulator combination that silently ignores DIFFUSE.

CMakeLists.txt

@@ -422,8 +422,10 @@ add_dependencies(moduleVersion opmsimulators)
 set(FLOW_MODELS blackoil brine energy extbo foam gasoil gaswater
                 oilwater oilwater_brine gaswater_brine oilwater_polymer
                 oilwater_polymer_injectivity micp polymer solvent
-                gasoil_energy brine_saltprecipitation gaswater_saltprec_vapwat brine_precsalt_vapwat)
+                gasoil_energy brine_saltprecipitation
-set(FLOW_VARIANT_MODELS brine_energy onephase onephase_energy blackoil_tpfa)
+                gaswater_saltprec_vapwat brine_precsalt_vapwat
+                blackoil_tpfa gasoildiffuse)
+set(FLOW_VARIANT_MODELS brine_energy onephase onephase_energy)
 
 set(FLOW_TGTS)
 foreach(OBJ ${COMMON_MODELS} ${FLOW_MODELS} ${FLOW_VARIANT_MODELS})

flow/flow_ebos_gasoildiffuse.cpp

@@ -0,0 +1,85 @@
+/*
+  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 3 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/>.
+*/
+#include "config.h"
+
+#include <flow/flow_ebos_gasoil.hpp>
+
+#include <opm/material/common/ResetLocale.hpp>
+#include <opm/models/blackoil/blackoiltwophaseindices.hh>
+
+#include <opm/grid/CpGrid.hpp>
+#include <opm/simulators/flow/SimulatorFullyImplicitBlackoilEbos.hpp>
+#include <opm/simulators/flow/Main.hpp>
+
+namespace Opm {
+namespace Properties {
+namespace TTag {
+struct EclFlowGasOilDiffuseProblem {
+    using InheritsFrom = std::tuple<EclFlowProblem>;
+};
+}
+
+
+template<class TypeTag>
+struct EnableDiffusion<TypeTag, TTag::EclFlowGasOilDiffuseProblem> { static constexpr bool value = true; };
+
+//! The indices required by the model
+template<class TypeTag>
+struct Indices<TypeTag, TTag::EclFlowGasOilDiffuseProblem>
+{
+private:
+    // it is unfortunately not possible to simply use 'TypeTag' here because this leads
+    // to cyclic definitions of some properties. if this happens the compiler error
+    // messages unfortunately are *really* confusing and not really helpful.
+    using BaseTypeTag = TTag::EclFlowProblem;
+    using FluidSystem = GetPropType<BaseTypeTag, Properties::FluidSystem>;
+
+public:
+  typedef BlackOilTwoPhaseIndices<getPropValue<TypeTag, Properties::EnableSolvent>(),
+                                  getPropValue<TypeTag, Properties::EnableExtbo>(),
+                                  getPropValue<TypeTag, Properties::EnablePolymer>(),
+                                  getPropValue<TypeTag, Properties::EnableEnergy>(),
+                                  getPropValue<TypeTag, Properties::EnableFoam>(),
+                                  getPropValue<TypeTag, Properties::EnableBrine>(),
+                                  /*PVOffset=*/0,
+                                  /*disabledCompIdx=*/FluidSystem::waterCompIdx,
+                                  getPropValue<TypeTag, Properties::EnableMICP>()> type;
+};
+}}
+
+namespace Opm {
+
+// ----------------- Main program -----------------
+int flowEbosGasOilDiffuseMain(int argc, char** argv, bool outputCout, bool outputFiles)
+{
+    // we always want to use the default locale, and thus spare us the trouble
+    // with incorrect locale settings.
+    resetLocale();
+
+    FlowMainEbos<Properties::TTag::EclFlowGasOilDiffuseProblem>
+        mainfunc {argc, argv, outputCout, outputFiles} ;
+    return mainfunc.execute();
+}
+
+int flowEbosGasOilDiffuseMainStandalone(int argc, char** argv)
+{
+    using TypeTag = Properties::TTag::EclFlowGasOilDiffuseProblem;
+    auto mainObject = Opm::Main(argc, argv);
+    return mainObject.runStatic<TypeTag>();
+}
+
+}

flow/flow_ebos_gasoildiffuse.hpp

@@ -0,0 +1,30 @@
+/*
+  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 3 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/>.
+*/
+#ifndef FLOW_EBOS_GASOILDIFFUSE_HPP
+#define FLOW_EBOS_GASOILDIFFUSE_HPP
+
+namespace Opm {
+
+//! \brief Main function used in flow binary.
+int flowEbosGasOilDiffuseMain(int argc, char** argv, bool outputCout, bool outputFiles);
+
+//! \brief Main function used in flow_gasoil binary.
+int flowEbosGasOilDiffuseMainStandalone(int argc, char** argv);
+
+}
+
+#endif // FLOW_EBOS_GASOILDIFFUSE_HPP

flow/flow_gasoildiffuse.cpp

@@ -0,0 +1,24 @@
+/*
+  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 3 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/>.
+*/
+#include "config.h"
+#include <flow/flow_ebos_gasoildiffuse.hpp>
+
+
+int main(int argc, char** argv)
+{
+    return Opm::flowEbosGasOilDiffuseMainStandalone(argc, argv);
+}

opm/simulators/flow/Main.hpp

@@ -26,6 +26,7 @@
 #include <flow/flow_ebos_blackoil_tpfa.hpp>
 
 #include <flow/flow_ebos_gasoil.hpp>
+#include <flow/flow_ebos_gasoildiffuse.hpp>
 #include <flow/flow_ebos_gasoil_energy.hpp>
 #include <flow/flow_ebos_oilwater.hpp>
 #include <flow/flow_ebos_gaswater.hpp>
@@ -281,6 +282,7 @@ private:
         //
         // TODO: make sure that no illegal combinations like thermal and
         //       twophase are requested.
+        const bool thermal = eclipseState_->getSimulationConfig().isThermal();
 
         // Single-phase case
         if (rspec.micp()) {
@@ -288,17 +290,17 @@ private:
         }
 
         // water-only case
-        else if(phases.size() == 1 && phases.active(Phase::WATER) && !eclipseState_->getSimulationConfig().isThermal()) {
+        else if(phases.size() == 1 && phases.active(Phase::WATER) && !thermal) {
             return this->runWaterOnly(phases);
         }
 
         // water-only case with energy
-        else if(phases.size() == 2 && phases.active(Phase::WATER) && eclipseState_->getSimulationConfig().isThermal()) {
+        else if(phases.size() == 2 && phases.active(Phase::WATER) && thermal) {
             return this->runWaterOnlyEnergy(phases);
         }
 
         // Twophase cases
-        else if (phases.size() == 2 && !eclipseState_->getSimulationConfig().isThermal()) {
+        else if (phases.size() == 2 && !thermal) {
             return this->runTwoPhase(phases);
         }
 
@@ -328,7 +330,7 @@ private:
         }
 
         // Energy case
-        else if (eclipseState_->getSimulationConfig().isThermal()) {
+        else if (thermal) {
             return this->runThermal(phases);
         }
 
@@ -592,18 +594,36 @@ private:
 
     int runTwoPhase(const Phases& phases)
     {
+        const bool diffusive = eclipseState_->getSimulationConfig().isDiffusive();
+
         // oil-gas
         if (phases.active( Phase::OIL ) && phases.active( Phase::GAS )) {
-            return flowEbosGasOilMain(argc_, argv_, outputCout_, outputFiles_);
+            if (diffusive) {
+                return flowEbosGasOilDiffuseMain(argc_, argv_, outputCout_, outputFiles_);
+            } else {
+                return flowEbosGasOilMain(argc_, argv_, outputCout_, outputFiles_);
+            }
         }
 
         // oil-water
         else if ( phases.active( Phase::OIL ) && phases.active( Phase::WATER ) ) {
+            if (diffusive) {
+                if (outputCout_) {
+                    std::cerr << "The DIFFUSE option is not available for the two-phase water/oil model." << std::endl;
+                }
+                return EXIT_FAILURE;
+            }
             return flowEbosOilWaterMain(argc_, argv_, outputCout_, outputFiles_);
         }
 
         // gas-water
         else if ( phases.active( Phase::GAS ) && phases.active( Phase::WATER ) ) {
+            if (diffusive) {
+                if (outputCout_) {
+                    std::cerr << "The DIFFUSE option is not available for the two-phase gas/water model." << std::endl;
+                }
+                return EXIT_FAILURE;
+            }
             return flowEbosGasWaterMain(argc_, argv_, outputCout_, outputFiles_);
         }
         else {
@@ -736,7 +756,14 @@ private:
 
     int runBlackOil()
     {
-        return flowEbosBlackoilTpfaMain(argc_, argv_, outputCout_, outputFiles_);
+        const bool diffusive = eclipseState_->getSimulationConfig().isDiffusive();
+        if (diffusive) {
+            // Use the traditional linearizer, as the TpfaLinearizer does not
+            // support the diffusion module yet.
+            return flowEbosBlackoilMain(argc_, argv_, outputCout_, outputFiles_);
+        } else {
+            return flowEbosBlackoilTpfaMain(argc_, argv_, outputCout_, outputFiles_);
+        }
     }
 
     int argc_{0};