added: WellGroupControls

this holds the code for well group controls.
move getGroupInjectionControl into the new class

CMakeLists_files.cmake

@@ -104,6 +104,7 @@ list (APPEND MAIN_SOURCE_FILES
   opm/simulators/wells/VFPProdProperties.cpp
   opm/simulators/wells/VFPInjProperties.cpp
   opm/simulators/wells/WellConvergence.cpp
+  opm/simulators/wells/WellGroupControls.cpp
   opm/simulators/wells/WellGroupHelpers.cpp
   opm/simulators/wells/WellHelpers.cpp
   opm/simulators/wells/WellInterfaceEval.cpp
@@ -385,6 +386,7 @@ list (APPEND PUBLIC_HEADER_FILES
   opm/simulators/wells/VFPProperties.hpp
   opm/simulators/wells/WellConnectionAuxiliaryModule.hpp
   opm/simulators/wells/WellConvergence.hpp
+  opm/simulators/wells/WellGroupControls.hpp
   opm/simulators/wells/WellGroupHelpers.hpp
   opm/simulators/wells/WellHelpers.hpp
   opm/simulators/wells/WellInterface.hpp

opm/simulators/wells/WellGroupControls.cpp

@@ -0,0 +1,209 @@
+/*
+  Copyright 2017 SINTEF Digital, Mathematics and Cybernetics.
+  Copyright 2017 Statoil ASA.
+  Copyright 2018 IRIS
+
+  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 <opm/simulators/wells/WellGroupControls.hpp>
+
+#include <opm/input/eclipse/EclipseState/Runspec.hpp>
+#include <opm/input/eclipse/Schedule/Schedule.hpp>
+#include <opm/input/eclipse/Schedule/Group/Group.hpp>
+#include <opm/input/eclipse/Schedule/ScheduleTypes.hpp>
+
+#include <opm/material/densead/Evaluation.hpp>
+
+#include <opm/simulators/wells/GroupState.hpp>
+#include <opm/simulators/wells/TargetCalculator.hpp>
+#include <opm/simulators/wells/WellGroupHelpers.hpp>
+#include <opm/simulators/wells/WellInterfaceGeneric.hpp>
+
+#include <cassert>
+
+namespace Opm
+{
+
+template<class EvalWell>
+void WellGroupControls::
+getGroupInjectionControl(const Group& group,
+                         const WellState& well_state,
+                         const GroupState& group_state,
+                         const Schedule& schedule,
+                         const SummaryState& summaryState,
+                         const InjectorType& injectorType,
+                         const EvalWell& bhp,
+                         const EvalWell& injection_rate,
+                         const RateConvFunc& rateConverter,
+                         double efficiencyFactor,
+                         EvalWell& control_eq,
+                         DeferredLogger& deferred_logger) const
+{
+    // Setting some defaults to silence warnings below.
+    // Will be overwritten in the switch statement.
+    Phase injectionPhase = Phase::WATER;
+    switch (injectorType) {
+    case InjectorType::WATER:
+    {
+        injectionPhase = Phase::WATER;
+        break;
+    }
+    case InjectorType::OIL:
+    {
+        injectionPhase = Phase::OIL;
+        break;
+    }
+    case InjectorType::GAS:
+    {
+        injectionPhase = Phase::GAS;
+        break;
+    }
+    default:
+        // Should not be here.
+        assert(false);
+    }
+
+    auto currentGroupControl = group_state.injection_control(group.name(), injectionPhase);
+    if (currentGroupControl == Group::InjectionCMode::FLD ||
+        currentGroupControl == Group::InjectionCMode::NONE) {
+        if (!group.injectionGroupControlAvailable(injectionPhase)) {
+            // We cannot go any further up the hierarchy. This could
+            // be the FIELD group, or any group for which this has
+            // been set in GCONINJE or GCONPROD. If we are here
+            // anyway, it is likely that the deck set inconsistent
+            // requirements, such as GRUP control mode on a well with
+            // no appropriate controls defined on any of its
+            // containing groups. We will therefore use the wells' bhp
+            // limit equation as a fallback.
+            const auto& controls = well_.wellEcl().injectionControls(summaryState);
+            control_eq = bhp - controls.bhp_limit;
+            return;
+        } else {
+            // Inject share of parents control
+            const auto& parent = schedule.getGroup(group.parent(), well_.currentStep());
+            efficiencyFactor *= group.getGroupEfficiencyFactor();
+            getGroupInjectionControl(parent, well_state,
+                                     group_state, schedule,
+                                     summaryState, injectorType,
+                                     bhp, injection_rate,
+                                     rateConverter,
+                                     efficiencyFactor,
+                                     control_eq,
+                                     deferred_logger);
+            return;
+        }
+    }
+
+    const auto& well = well_.wellEcl();
+    const auto pu = well_.phaseUsage();
+
+    if (!group.isInjectionGroup()) {
+        // use bhp as control eq and let the updateControl code find a valid control
+        const auto& controls = well.injectionControls(summaryState);
+        control_eq = bhp - controls.bhp_limit;
+        return;
+    }
+
+    // If we are here, we are at the topmost group to be visited in the recursion.
+    // This is the group containing the control we will check against.
+
+    // Make conversion factors for RESV <-> surface rates.
+    std::vector<double> resv_coeff(pu.num_phases, 1.0);
+    rateConverter(0, well_.pvtRegionIdx(), resv_coeff); // FIPNUM region 0 here, should use FIPNUM from WELSPECS.
+
+    double sales_target = 0;
+    if (schedule[well_.currentStep()].gconsale().has(group.name())) {
+        const auto& gconsale = schedule[well_.currentStep()].gconsale().get(group.name(), summaryState);
+        sales_target = gconsale.sales_target;
+    }
+    WellGroupHelpers::InjectionTargetCalculator tcalc(currentGroupControl, pu,
+                                                      resv_coeff, group.name(),
+                                                      sales_target, group_state,
+                                                      injectionPhase,
+                                                      group.has_gpmaint_control(injectionPhase, currentGroupControl),
+                                                      deferred_logger);
+    WellGroupHelpers::FractionCalculator fcalc(schedule, well_state,
+                                               group_state, well_.currentStep(),
+                                               well_.guideRate(),
+                                               tcalc.guideTargetMode(),
+                                               pu, false, injectionPhase);
+
+    auto localFraction = [&](const std::string& child) {
+        return fcalc.localFraction(child, child);
+    };
+
+    auto localReduction = [&](const std::string& group_name) {
+        const std::vector<double>& groupTargetReductions = group_state.injection_reduction_rates(group_name);
+        return tcalc.calcModeRateFromRates(groupTargetReductions);
+    };
+
+    const double orig_target = tcalc.groupTarget(group.injectionControls(injectionPhase,
+                                                                         summaryState),
+                                                deferred_logger);
+    const auto chain = WellGroupHelpers::groupChainTopBot(well_.name(), group.name(),
+                                                          schedule, well_.currentStep());
+    // Because 'name' is the last of the elements, and not an ancestor, we subtract one below.
+    const size_t num_ancestors = chain.size() - 1;
+    double target = orig_target;
+    for (size_t ii = 0; ii < num_ancestors; ++ii) {
+        if ((ii == 0) || well_.guideRate()->has(chain[ii], injectionPhase)) {
+            // Apply local reductions only at the control level
+            // (top) and for levels where we have a specified
+            // group guide rate.
+            target -= localReduction(chain[ii]);
+        }
+        target *= localFraction(chain[ii+1]);
+    }
+    // Avoid negative target rates coming from too large local reductions.
+    const double target_rate = std::max(0.0, target / efficiencyFactor);
+    const auto current_rate = injection_rate;
+
+    control_eq = current_rate - target_rate;
+}
+
+#define INSTANCE(...) \
+template void WellGroupControls:: \
+getGroupInjectionControl<__VA_ARGS__>(const Group&, \
+                                      const WellState&, \
+                                      const GroupState&, \
+                                      const Schedule&, \
+                                      const SummaryState&, \
+                                      const InjectorType&, \
+                                      const __VA_ARGS__& bhp, \
+                                      const __VA_ARGS__& injection_rate, \
+                                      const RateConvFunc& rateConverter, \
+                                      double efficiencyFactor, \
+                                      __VA_ARGS__& control_eq, \
+                                      DeferredLogger& deferred_logger) const;
+
+INSTANCE(DenseAd::Evaluation<double,3,0u>)
+INSTANCE(DenseAd::Evaluation<double,4,0u>)
+INSTANCE(DenseAd::Evaluation<double,5,0u>)
+INSTANCE(DenseAd::Evaluation<double,6,0u>)
+INSTANCE(DenseAd::Evaluation<double,7,0u>)
+INSTANCE(DenseAd::Evaluation<double,8,0u>)
+INSTANCE(DenseAd::Evaluation<double,9,0u>)
+INSTANCE(DenseAd::Evaluation<double,-1,4u>)
+INSTANCE(DenseAd::Evaluation<double,-1,5u>)
+INSTANCE(DenseAd::Evaluation<double,-1,6u>)
+INSTANCE(DenseAd::Evaluation<double,-1,7u>)
+INSTANCE(DenseAd::Evaluation<double,-1,8u>)
+INSTANCE(DenseAd::Evaluation<double,-1,9u>)
+INSTANCE(DenseAd::Evaluation<double,-1,10u>)
+
+} // namespace Opm

opm/simulators/wells/WellGroupControls.hpp

@@ -0,0 +1,71 @@
+/*
+  Copyright 2017 SINTEF Digital, Mathematics and Cybernetics.
+  Copyright 2017 Statoil ASA.
+  Copyright 2017 IRIS
+  Copyright 2019 Norce
+
+  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 OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED
+#define OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED
+
+#include <functional>
+#include <vector>
+
+namespace Opm
+{
+
+class DeferredLogger;
+class Group;
+class GroupState;
+enum class InjectorType;
+using RegionId = int;
+class Schedule;
+class SummaryState;
+class WellInterfaceGeneric;
+class WellState;
+
+//! \brief Class for computing well group controls.
+class WellGroupControls {
+public:
+    //! \brief Constructor sets reference to well.
+    WellGroupControls(const WellInterfaceGeneric& well) : well_(well) {}
+
+    using RateConvFunc = std::function<void(const RegionId, const int, std::vector<double>&)>;
+
+    template<class EvalWell>
+    void getGroupInjectionControl(const Group& group,
+                                  const WellState& well_state,
+                                  const GroupState& group_state,
+                                  const Schedule& schedule,
+                                  const SummaryState& summaryState,
+                                  const InjectorType& injectorType,
+                                  const EvalWell& bhp,
+                                  const EvalWell& injection_rate,
+                                  const RateConvFunc& rateConverter,
+                                  double efficiencyFactor,
+                                  EvalWell& control_eq,
+                                  DeferredLogger& deferred_logger) const;
+
+private:
+    const WellInterfaceGeneric& well_; //!< Reference to well interface
+};
+
+}
+
+#endif // OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED

opm/simulators/wells/WellInterfaceEval.cpp

@@ -30,9 +30,8 @@
 #include <opm/simulators/utils/DeferredLoggingErrorHelpers.hpp>
 #include <opm/simulators/wells/GroupState.hpp>
 #include <opm/simulators/wells/RateConverter.hpp>
-#include <opm/simulators/wells/TargetCalculator.hpp>
 #include <opm/simulators/wells/VFPProperties.hpp>
-#include <opm/simulators/wells/WellGroupHelpers.hpp>
+#include <opm/simulators/wells/WellGroupControls.hpp>
 #include <opm/simulators/wells/WellHelpers.hpp>
 #include <opm/simulators/wells/WellInterfaceFluidSystem.hpp>
 #include <opm/simulators/wells/WellState.hpp>
@@ -50,125 +49,6 @@ WellInterfaceEval(const WellInterfaceFluidSystem<FluidSystem>& baseif)
     : baseif_(baseif)
 {}
 
-template<class FluidSystem>
-template<class EvalWell>
-void
-WellInterfaceEval<FluidSystem>::
-getGroupInjectionControl(const Group& group,
-                         const WellState& well_state,
-                         const GroupState& group_state,
-                         const Schedule& schedule,
-                         const SummaryState& summaryState,
-                         const InjectorType& injectorType,
-                         const EvalWell& bhp,
-                         const EvalWell& injection_rate,
-                         EvalWell& control_eq,
-                         double efficiencyFactor,
-                         DeferredLogger& deferred_logger) const
-{
-    // Setting some defaults to silence warnings below.
-    // Will be overwritten in the switch statement.
-    Phase injectionPhase = Phase::WATER;
-    switch (injectorType) {
-    case InjectorType::WATER:
-    {
-        injectionPhase = Phase::WATER;
-        break;
-    }
-    case InjectorType::OIL:
-    {
-        injectionPhase = Phase::OIL;
-        break;
-    }
-    case InjectorType::GAS:
-    {
-        injectionPhase = Phase::GAS;
-        break;
-    }
-    default:
-        // Should not be here.
-        assert(false);
-    }
-
-    auto currentGroupControl = group_state.injection_control(group.name(), injectionPhase);
-    if (currentGroupControl == Group::InjectionCMode::FLD ||
-        currentGroupControl == Group::InjectionCMode::NONE) {
-        if (!group.injectionGroupControlAvailable(injectionPhase)) {
-            // We cannot go any further up the hierarchy. This could
-            // be the FIELD group, or any group for which this has
-            // been set in GCONINJE or GCONPROD. If we are here
-            // anyway, it is likely that the deck set inconsistent
-            // requirements, such as GRUP control mode on a well with
-            // no appropriate controls defined on any of its
-            // containing groups. We will therefore use the wells' bhp
-            // limit equation as a fallback.
-            const auto& controls = baseif_.wellEcl().injectionControls(summaryState);
-            control_eq = bhp - controls.bhp_limit;
-            return;
-        } else {
-            // Inject share of parents control
-            const auto& parent = schedule.getGroup( group.parent(), baseif_.currentStep());
-            efficiencyFactor *= group.getGroupEfficiencyFactor();
-            getGroupInjectionControl(parent, well_state, group_state, schedule, summaryState, injectorType, bhp, injection_rate, control_eq, efficiencyFactor, deferred_logger);
-            return;
-        }
-    }
-
-    const auto& well = baseif_.wellEcl();
-    const auto pu = baseif_.phaseUsage();
-
-    if (!group.isInjectionGroup()) {
-        // use bhp as control eq and let the updateControl code find a valid control
-        const auto& controls = well.injectionControls(summaryState);
-        control_eq = bhp - controls.bhp_limit;
-        return;
-    }
-
-    // If we are here, we are at the topmost group to be visited in the recursion.
-    // This is the group containing the control we will check against.
-
-    // Make conversion factors for RESV <-> surface rates.
-    std::vector<double> resv_coeff(pu.num_phases, 1.0);
-    baseif_.rateConverter().calcInjCoeff(0, baseif_.pvtRegionIdx(), resv_coeff); // FIPNUM region 0 here, should use FIPNUM from WELSPECS.
-
-    double sales_target = 0;
-    if (schedule[baseif_.currentStep()].gconsale().has(group.name())) {
-        const auto& gconsale = schedule[baseif_.currentStep()].gconsale().get(group.name(), summaryState);
-        sales_target = gconsale.sales_target;
-    }
-    WellGroupHelpers::InjectionTargetCalculator tcalc(currentGroupControl, pu, resv_coeff, group.name(), sales_target, group_state, injectionPhase, group.has_gpmaint_control(injectionPhase, currentGroupControl), deferred_logger);
-    WellGroupHelpers::FractionCalculator fcalc(schedule, well_state, group_state, baseif_.currentStep(), baseif_.guideRate(), tcalc.guideTargetMode(), pu, false, injectionPhase);
-
-    auto localFraction = [&](const std::string& child) {
-        return fcalc.localFraction(child, child);
-    };
-
-    auto localReduction = [&](const std::string& group_name) {
-        const std::vector<double>& groupTargetReductions = group_state.injection_reduction_rates(group_name);
-        return tcalc.calcModeRateFromRates(groupTargetReductions);
-    };
-
-    const double orig_target = tcalc.groupTarget(group.injectionControls(injectionPhase, summaryState), deferred_logger);
-    const auto chain = WellGroupHelpers::groupChainTopBot(baseif_.name(), group.name(), schedule, baseif_.currentStep());
-    // Because 'name' is the last of the elements, and not an ancestor, we subtract one below.
-    const size_t num_ancestors = chain.size() - 1;
-    double target = orig_target;
-    for (size_t ii = 0; ii < num_ancestors; ++ii) {
-        if ((ii == 0) || baseif_.guideRate()->has(chain[ii], injectionPhase)) {
-            // Apply local reductions only at the control level
-            // (top) and for levels where we have a specified
-            // group guide rate.
-            target -= localReduction(chain[ii]);
-        }
-        target *= localFraction(chain[ii+1]);
-    }
-    // Avoid negative target rates coming from too large local reductions.
-    const double target_rate = std::max(0.0, target / efficiencyFactor);
-    const auto current_rate = injection_rate;
-
-    control_eq = current_rate - target_rate;
-}
-
 template<class FluidSystem>
 template<class EvalWell>
 void
@@ -438,17 +318,22 @@ assembleControlEqInj_(const WellState& well_state,
     case Well::InjectorCMode::GRUP: {
         assert(baseif_.wellEcl().isAvailableForGroupControl());
         const auto& group = schedule.getGroup(baseif_.wellEcl().groupName(), baseif_.currentStep());
-        this->getGroupInjectionControl(group,
+        auto rCoeff = [this](const RegionId id, const int region, std::vector<double>& coeff)
-                                       well_state,
+        {
-                                       group_state,
+            baseif_.rateConverter().calcInjCoeff(id, region, coeff);
-                                       schedule,
+        };
-                                       summaryState,
+        WellGroupControls(baseif_).getGroupInjectionControl(group,
-                                       injectorType,
+                                                            well_state,
-                                       bhp,
+                                                            group_state,
-                                       injection_rate,
+                                                            schedule,
-                                       control_eq,
+                                                            summaryState,
-                                       efficiencyFactor,
+                                                            injectorType,
-                                       deferred_logger);
+                                                            bhp,
+                                                            injection_rate,
+                                                            rCoeff,
+                                                            efficiencyFactor,
+                                                            control_eq,
+                                                            deferred_logger);
         break;
     }
     case Well::InjectorCMode::CMODE_UNDEFINED: {

opm/simulators/wells/WellInterfaceEval.hpp

@@ -56,20 +56,6 @@ public:
                                  const SummaryState& summaryState,
                                  const double rho,
                                  DeferredLogger& deferred_logger) const;
-    template<class EvalWell>
-    void getGroupInjectionControl(const Group& group,
-                                  const WellState& well_state,
-                                  const GroupState& group_state,
-                                  const Schedule& schedule,
-                                  const SummaryState& summaryState,
-                                  const InjectorType& injectorType,
-                                  const EvalWell& bhp,
-                                  const EvalWell& injection_rate,
-                                  EvalWell& control_eq,
-                                  double efficiencyFactor,
-                                  DeferredLogger& deferred_logger) const;
-
-
     template<class EvalWell>
     void getGroupProductionControl(const Group& group,
                                    const WellState& well_state,