51 static constexpr int Water = BlackoilPhases::Aqua;
52 static constexpr int Oil = BlackoilPhases::Liquid;
53 static constexpr int Gas = BlackoilPhases::Vapour;
54 static constexpr int NUM_PHASES = 3;
55 static constexpr double ALQ_EPSILON = 1e-8;
58 using GLiftSyncGroups = std::set<int>;
59 using Rate = GasLiftGroupInfo::Rate;
64 GradInfo(
double grad_,
double new_oil_rate_,
bool oil_is_limited_,
65 double new_gas_rate_,
bool gas_is_limited_,
66 double new_water_rate_,
bool water_is_limited_,
67 double alq_,
bool alq_is_limited_) :
69 new_oil_rate{new_oil_rate_},
70 oil_is_limited{oil_is_limited_},
71 new_gas_rate{new_gas_rate_},
72 gas_is_limited{gas_is_limited_},
73 new_water_rate{new_water_rate_},
74 water_is_limited{water_is_limited_},
76 alq_is_limited{alq_is_limited_} {}
82 double new_water_rate;
83 bool water_is_limited;
90 const std::string& name()
const {
return well_name_; }
92 std::optional<GradInfo> calcIncOrDecGradient(
double oil_rate,
double gas_rate,
95 const std::string& gr_name_dont_limit,
97 bool debug_output =
true
100 std::unique_ptr<GasLiftWellState> runOptimize(
const int iteration_idx);
109 const Well& ecl_well,
110 const SummaryState& summary_state,
113 const Schedule& schedule,
114 const int report_step_idx,
115 GLiftSyncGroups& sync_groups,
116 const Parallel::Communication& comm,
127 bhp_is_limited{rates.bhp_is_limited}
129 BasicRates(
double oil_,
double gas_,
double water_,
bool bhp_is_limited_) :
133 bhp_is_limited{bhp_is_limited_}
139 bhp_is_limited = rates.bhp_is_limited;
146 double operator[](Rate rate_type)
const {
155 return this->oil + this->water;
157 throw std::runtime_error(
"This should not happen");
161 double oil, gas, water;
167 enum class LimitType {well, group, none};
169 double oil_,
double gas_,
double water_,
170 bool oil_is_limited_,
bool gas_is_limited_,
171 bool water_is_limited_,
bool bhp_is_limited_,
172 std::optional<Rate> oil_limiting_target_,
173 std::optional<Rate> water_limiting_target_
175 BasicRates(oil_, gas_, water_, bhp_is_limited_),
176 oil_is_limited{oil_is_limited_},
177 gas_is_limited{gas_is_limited_},
178 water_is_limited{water_is_limited_},
179 oil_limiting_target{oil_limiting_target_},
180 water_limiting_target{water_limiting_target_}
182 set_initial_limit_type_();
187 bool oil_is_limited_,
bool gas_is_limited_,
188 bool water_is_limited_
191 oil_is_limited{oil_is_limited_},
192 gas_is_limited{gas_is_limited_},
193 water_is_limited{water_is_limited_}
195 set_initial_limit_type_();
198 bool limited()
const {
199 return oil_is_limited || gas_is_limited || water_is_limited;
203 LimitType limit_type;
206 bool water_is_limited;
207 std::optional<Rate> oil_limiting_target;
208 std::optional<Rate> water_limiting_target;
210 void set_initial_limit_type_() {
211 limit_type = limited() ? LimitType::well : LimitType::none;
221 stop_iteration{
false},
231 std::pair<std::optional<double>,
bool> addOrSubtractAlqIncrement(
double alq);
232 double calcEcoGradient(
double oil_rate,
double new_oil_rate,
233 double gas_rate,
double new_gas_rate);
234 bool checkAlqOutsideLimits(
double alq,
double oil_rate);
235 bool checkEcoGradient(
double gradient);
236 bool checkOilRateExceedsTarget(
double oil_rate);
237 bool checkRatesViolated(
const LimitedRates& rates)
const;
238 void debugShowIterationInfo(
double alq);
239 double getBhpWithLimit();
240 void warn_(std::string msg) {parent.displayWarning_(msg);}
242 bool checkGroupALQrateExceeded(
double delta_alq,
const std::string& gr_name_dont_limit =
"")
const;
243 bool checkGroupTotalRateExceeded(
double delta_alq,
double delta_gas_rate)
const;
245 std::pair<std::optional<double>,
bool> addOrSubtractAlqIncrement_(
246 double alq,
bool increase)
const;
247 double calcEcoGradient_(
double oil_rate,
double new_oil_rate,
248 double gas_rate,
double new_gas_rate,
bool increase)
const;
249 bool checkALQequal_(
double alq1,
double alq2)
const;
250 bool checkGroupTargetsViolated(
252 bool checkInitialALQmodified_(
double alq,
double initial_alq)
const;
253 virtual bool checkThpControl_()
const = 0;
254 virtual std::optional<double> computeBhpAtThpLimit_(
double alq,
bool debug_output =
true)
const = 0;
255 std::pair<std::optional<double>,
double> computeConvergedBhpAtThpLimitByMaybeIncreasingALQ_()
const;
256 std::pair<std::optional<BasicRates>,
double> computeInitialWellRates_()
const;
257 std::optional<LimitedRates> computeLimitedWellRatesWithALQ_(
double alq)
const;
258 virtual BasicRates computeWellRates_(
double bhp,
bool bhp_is_limited,
bool debug_output =
true)
const = 0;
259 std::optional<BasicRates> computeWellRatesWithALQ_(
double alq)
const;
260 void debugCheckNegativeGradient_(
double grad,
double alq,
double new_alq,
261 double oil_rate,
double new_oil_rate,
262 double gas_rate,
double new_gas_rate,
263 bool increase)
const;
264 void debugPrintWellStateRates()
const;
265 void debugShowAlqIncreaseDecreaseCounts_();
266 void debugShowBhpAlqTable_();
267 void debugShowLimitingTargets_(
const LimitedRates& rates)
const;
268 void debugShowProducerControlMode()
const;
269 void debugShowStartIteration_(
double alq,
bool increase,
double oil_rate);
270 void debugShowTargets_();
271 void displayDebugMessage_(
const std::string& msg)
const override;
272 void displayWarning_(
const std::string& warning);
273 std::pair<double, bool> getBhpWithLimit_(
double bhp)
const;
274 std::pair<double, bool> getGasRateWithLimit_(
276 std::pair<double, bool> getGasRateWithGroupLimit_(
277 double new_gas_rate,
double gas_rate,
const std::string& gr_name_dont_limit)
const;
278 std::pair<std::optional<LimitedRates>,
double> getInitialRatesWithLimit_()
const;
280 std::tuple<double,double,bool,bool> getLiquidRateWithGroupLimit_(
281 const double new_oil_rate,
const double oil_rate,
282 const double new_water_rate,
const double water_rate,
const std::string& gr_name_dont_limit)
const;
283 std::pair<double, bool> getOilRateWithGroupLimit_(
284 double new_oil_rate,
double oil_rate,
const std::string& gr_name_dont_limit)
const;
285 std::pair<double, bool> getOilRateWithLimit_(
const BasicRates& rates)
const;
286 std::pair<double, std::optional<Rate>> getOilRateWithLimit2_(
288 double getProductionTarget_(Rate rate)
const;
289 double getRate_(Rate rate_type,
const BasicRates& rates)
const;
290 std::pair<double, std::optional<Rate>> getRateWithLimit_(
291 Rate rate_type,
const BasicRates& rates)
const;
292 std::tuple<double, const std::string*, double> getRateWithGroupLimit_(
293 Rate rate_type,
const double new_rate,
const double old_rate,
const std::string& gr_name_dont_limit)
const;
294 std::pair<double, bool> getWaterRateWithGroupLimit_(
295 double new_water_rate,
double water_rate,
const std::string& gr_name_dont_limit)
const;
296 std::pair<double, bool> getWaterRateWithLimit_(
const BasicRates& rates)
const;
297 std::pair<double, std::optional<Rate>> getWaterRateWithLimit2_(
300 bool hasProductionControl_(Rate rate)
const;
301 std::pair<LimitedRates, double> increaseALQtoPositiveOilRate_(
303 std::pair<LimitedRates, double> increaseALQtoMinALQ_(
305 void logSuccess_(
double alq,
306 const int iteration_idx);
307 std::pair<LimitedRates, double> maybeAdjustALQbeforeOptimizeLoop_(
308 const LimitedRates& rates,
double alq,
bool increase)
const;
309 std::pair<LimitedRates, double> reduceALQtoGroupAlqLimits_(
311 std::pair<LimitedRates, double> reduceALQtoGroupTarget(
313 std::pair<LimitedRates, double> reduceALQtoWellTarget_(
315 std::unique_ptr<GasLiftWellState> runOptimize1_();
316 std::unique_ptr<GasLiftWellState> runOptimize2_();
317 std::unique_ptr<GasLiftWellState> runOptimizeLoop_(
bool increase);
318 void setAlqMinRate_(
const GasLiftWell& well);
319 std::unique_ptr<GasLiftWellState> tryIncreaseLiftGas_();
320 std::unique_ptr<GasLiftWellState> tryDecreaseLiftGas_();
321 void updateGroupRates_(
324 double delta_alq)
const;
327 void updateWellStateAlqFixedValue_(
const GasLiftWell& well);
328 bool useFixedAlq_(
const GasLiftWell& well);
329 void debugInfoGroupRatesExceedTarget(
330 Rate rate_type,
const std::string& gr_name,
double rate,
double target)
const;
331 void warnMaxIterationsExceeded_();
333 const Well& ecl_well_;
334 const SummaryState& summary_state_;
337 GLiftSyncGroups& sync_groups_;
338 const WellProductionControls controls_;
355 std::string well_name_;
357 const GasLiftWell* gl_well_;
360 bool debug_limit_increase_decrease_;
361 bool debug_abort_if_decrease_and_oil_is_limited_ =
false;
362 bool debug_abort_if_increase_and_gas_is_limited_ =
false;