Limit well rates to honor group rates

If a well is under a group that is limited by a target, it should use as little gaslift as possible.
The reduction algorithm will reduce the gaslift of the well as long as the groups potential is above the groups target.

opm/simulators/wells/GasLiftSingleWellGeneric.cpp

@@ -43,10 +43,11 @@ GasLiftSingleWellGeneric::GasLiftSingleWellGeneric(
     const GroupState& group_state,
     const Well& ecl_well,
     const SummaryState& summary_state,
-    GasLiftGroupInfo &group_info,
+    GasLiftGroupInfo& group_info,
+    const PhaseUsage& phase_usage,
     const Schedule& schedule,
     const int report_step_idx,
-    GLiftSyncGroups &sync_groups,
+    GLiftSyncGroups& sync_groups,
     bool glift_debug
 ) :
     GasLiftCommon(well_state, deferred_logger, glift_debug)
@@ -54,6 +55,7 @@ GasLiftSingleWellGeneric::GasLiftSingleWellGeneric(
     , ecl_well_{ecl_well}
     , summary_state_{summary_state}
     , group_info_{group_info}
+    , phase_usage_{phase_usage}
     , sync_groups_{sync_groups}
     , controls_{ecl_well_.productionControls(summary_state_)}
     , num_phases_{well_state_.numPhases()}
@@ -738,8 +740,16 @@ getRateWithGroupLimit_(
             double gr_rate_temp =
                 this->group_info_.getRate(rate_type, group_name_temp);
             if (gr_rate_temp > gr_target_temp) {
-                warnGroupInfoGroupRatesExceedTarget(
-                    rate_type, group_name_temp, gr_rate_temp, gr_target_temp);
+                if (this->debug) {
+                    debugInfoGroupRatesExceedTarget(
+                        rate_type, group_name_temp, gr_rate_temp, gr_target_temp);
+                }
+                group_name = &group_name_temp;
+                efficiency = efficiency_temp;
+                limited_rate = old_rate;
+                gr_target = gr_target_temp;
+                new_gr_rate = gr_rate_temp;
+                break;
             }
             double new_gr_rate_temp = gr_rate_temp + efficiency_temp * delta_rate;
             if (new_gr_rate_temp > gr_target_temp) {
@@ -782,7 +792,9 @@ getInitialRatesWithLimit_() const
             displayDebugMessage_(
                              "Maybe limiting initial rates before optimize loop..");
         }
-        limited_rates = getLimitedRatesFromRates_(*rates);
+        auto temp_rates = getLimitedRatesFromRates_(*rates);
+        BasicRates old_rates = getWellStateRates_();
+        limited_rates = updateRatesToGroupLimits_(old_rates, temp_rates);
     }
     return limited_rates;
 }
@@ -802,6 +814,35 @@ getLimitedRatesFromRates_(const BasicRates& rates) const
         oil_limiting_target, water_limiting_target};
 }
 
+GasLiftSingleWellGeneric::BasicRates
+GasLiftSingleWellGeneric::
+getWellStateRates_() const
+{
+    const int well_index = this->well_state_.index(this->well_name_).value();
+    const auto& pu = this->phase_usage_;
+    const auto& ws= this->well_state_.well(well_index);
+    const auto& wrate = ws.well_potentials;
+
+    const auto oil_rate = pu.phase_used[Oil]
+        ? wrate[pu.phase_pos[Oil]]
+        : 0.0;
+
+    const auto gas_rate = pu.phase_used[Gas]
+        ? wrate[pu.phase_pos[Gas]]
+        : 0.0;
+
+    const auto water_rate = pu.phase_used[Water]
+        ? wrate[pu.phase_pos[Water]]
+        : 0.0;
+    if (this->debug) {
+        const std::string msg = fmt::format("Initial surface rates: oil : {}, "
+            "gas : {}, water : {}", oil_rate, gas_rate, water_rate);
+        displayDebugMessage_(msg);
+    }
+    return BasicRates{oil_rate, water_rate, gas_rate, /*bhp_is_limited=*/false};
+}
+
+
 bool
 GasLiftSingleWellGeneric::
 hasProductionControl_(Rate rate) const
@@ -1247,7 +1288,7 @@ updateGroupRates_(
 GasLiftSingleWellGeneric::LimitedRates
 GasLiftSingleWellGeneric::
 updateRatesToGroupLimits_(
-    const LimitedRates& old_rates, const LimitedRates& rates) const
+    const BasicRates& old_rates, const LimitedRates& rates) const
 {
     LimitedRates new_rates = rates;
     auto [new_oil_rate, oil_is_limited] = getOilRateWithGroupLimit_(
@@ -1340,14 +1381,13 @@ useFixedAlq_(const GasLiftOpt::Well& well)
 
 void
 GasLiftSingleWellGeneric::
-warnGroupInfoGroupRatesExceedTarget(
+debugInfoGroupRatesExceedTarget(
     Rate rate_type, const std::string& gr_name, double rate, double target) const
 {
-    double fraction = 100.0*std::fabs(rate-target)/target;
-    const std::string msg = fmt::format("Warning: {} rate for group {} exceeds target: "
-        "rate = {}, target = {}, relative overrun = {}%",
+    const std::string msg = fmt::format("{} rate for group {} exceeds target: "
+        "rate = {}, target = {}, the old rate is kept.",
         GasLiftGroupInfo::rateToString(rate_type),
-        gr_name, rate, target, fraction);
+        gr_name, rate, target);
     displayDebugMessage_(msg);
 }