GasLiftGroupInfo.hpp
Go to the documentation of this file.
1/*
2 Copyright 2021 Equinor ASA.
3
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18*/
19
20#ifndef OPM_GASLIFT_GROUP_INFO_HEADER_INCLUDED
21#define OPM_GASLIFT_GROUP_INFO_HEADER_INCLUDED
22
24
25#include <map>
26#include <optional>
27#include <string>
28#include <tuple>
29#include <vector>
30
31namespace Opm {
32
33class DeferredLogger;
34class GasLiftOpt;
35class Group;
36template<class Scalar> class GroupState;
37template<typename IndexTraits> class PhaseUsageInfo;
38class Schedule;
39class SummaryState;
40class Well;
41template<typename Scalar, typename IndexTraits> class WellState;
42
43
44template<typename Scalar, typename IndexTraits>
45class GasLiftGroupInfo : public GasLiftCommon<Scalar, IndexTraits>
46{
47protected:
48 class GroupRates;
49 // NOTE: In the Well2GroupMap below, in the std::vector value we store
50 // pairs of group names and efficiency factors. The efficiency factors
51 // are the product of the wells efficiency factor and all the efficiency
52 // factors of the child groups of the group all the way down
53 // to the well group.
55 std::map<std::string, std::vector<std::pair<std::string, Scalar>>>;
57 std::map<std::string, GroupRates>;
58 using GroupIdxMap = std::map<std::string, int>;
59 using Communication = Dune::Communication<Dune::MPIHelper::MPICommunicator>;
60
61public:
62 enum class Rate {oil, gas, water, liquid};
63
64 using GLiftEclWells = std::map<std::string,std::pair<const Well *,int>>;
66 const Schedule& schedule,
67 const SummaryState& summary_state,
68 const int report_step_idx,
69 const int iteration_idx,
70 DeferredLogger& deferred_logger,
72 const GroupState<Scalar>& group_state,
73 const Parallel::Communication& comm,
74 bool glift_debug);
75
76 std::vector<std::pair<std::string,Scalar>>&
77 getWellGroups(const std::string& well_name);
78
79 Scalar alqRate(const std::string& group_name);
80 Scalar gasRate(const std::string& group_name) const;
81 Scalar gasPotential(const std::string& group_name) const;
82 Scalar waterPotential(const std::string& group_name) const;
83 Scalar oilPotential(const std::string& group_name) const;
84 int getGroupIdx(const std::string& group_name);
85 Scalar getRate(Rate rate_type, const std::string& group_name) const;
86 Scalar getPotential(Rate rate_type, const std::string& group_name) const;
87 std::tuple<Scalar,Scalar,Scalar,Scalar> getRates(const int group_idx) const;
88 std::optional<Scalar> gasTarget(const std::string& group_name) const;
89 std::optional<Scalar> getTarget(Rate rate_type, const std::string& group_name) const;
90 const std::string& groupIdxToName(int group_idx) const;
91 bool hasAnyTarget(const std::string& group_name) const;
92 bool hasWell(const std::string& well_name);
93 void initialize();
94 std::optional<Scalar> liquidTarget(const std::string& group_name) const;
95 std::optional<Scalar> maxAlq(const std::string& group_name);
96 std::optional<Scalar> maxTotalGasRate(const std::string& group_name);
97 Scalar oilRate(const std::string& group_name) const;
98 std::optional<Scalar> oilTarget(const std::string& group_name) const;
99 static const std::string rateToString(Rate rate);
100 Scalar waterRate(const std::string& group_name) const;
101 std::optional<Scalar> waterTarget(const std::string& group_name) const;
102 void update(const std::string& well_name,
103 Scalar delta_oil,
104 Scalar delta_gas,
105 Scalar delta_water,
106 Scalar delta_alq);
107 void updateRate(int idx,
108 Scalar oil_rate,
109 Scalar gas_rate,
110 Scalar water_rate,
111 Scalar alq);
113
114protected:
115 bool checkDoGasLiftOptimization_(const std::string& well_name);
116 bool checkNewtonIterationIdxOk_(const std::string& well_name);
117 void debugDisplayWellContribution_(const std::string& gr_name,
118 const std::string& well_name,
119 Scalar eff_factor,
120 Scalar well_oil_rate,
121 Scalar well_gas_rate,
122 Scalar well_water_rate,
123 Scalar well_alq,
124 Scalar oil_rate,
125 Scalar gas_rate,
126 Scalar water_rate,
127 Scalar alq) const;
128 void debugDisplayUpdatedGroupRates(const std::string& name,
129 Scalar oil_rate,
130 Scalar gas_rate,
131 Scalar water_rate,
132 Scalar alq) const;
133 void debugEndInitializeGroup(const std::string& name) const;
134 void debugStartInitializeGroup(const std::string& name) const;
135 void displayDebugMessage_(const std::string& msg) const override;
136 void displayDebugMessage_(const std::string& msg, const std::string& well_name);
137
138 std::tuple<Scalar, Scalar, Scalar, Scalar, Scalar, Scalar>
139 getProducerWellRates_(const Well* well, const int index);
140
141 std::tuple<Scalar, Scalar, Scalar, Scalar, Scalar, Scalar, Scalar>
143
144 void initializeWell2GroupMapRecursive_(const Group& group,
145 std::vector<std::string>& group_names,
146 std::vector<Scalar>& group_efficiency,
147 Scalar cur_efficiency);
148 void updateGroupIdxMap_(const std::string& group_name);
149
151 public:
152 GroupRates(Scalar oil_rate,
153 Scalar gas_rate,
154 Scalar water_rate,
155 Scalar alq,
156 Scalar oil_potential,
157 Scalar gas_potential,
158 Scalar water_potential,
159 std::optional<Scalar> oil_target,
160 std::optional<Scalar> gas_target,
161 std::optional<Scalar> water_target,
162 std::optional<Scalar> liquid_target,
163 std::optional<Scalar> total_gas,
164 std::optional<Scalar> max_alq)
165 : oil_rate_{oil_rate}
166 , gas_rate_{gas_rate}
167 , water_rate_{water_rate}
168 , alq_{alq}
169 , oil_potential_{oil_potential}
170 , gas_potential_{gas_potential}
171 , water_potential_{water_potential}
172 , oil_target_{oil_target}
173 , gas_target_{gas_target}
174 , water_target_{water_target}
175 , liquid_target_{liquid_target}
176 , total_gas_{total_gas}
177 , max_alq_{max_alq}
178 {}
179
180 Scalar alq() const { return alq_; }
181 void assign(Scalar oil_rate,
182 Scalar gas_rate,
183 Scalar water_rate,
184 Scalar alq)
185 {
186 oil_rate_ = oil_rate;
187 gas_rate_ = gas_rate;
188 water_rate_ = water_rate;
189 alq_ = alq;
190 }
191 Scalar gasRate() const { return gas_rate_; }
192 Scalar waterRate() const { return water_rate_; }
193 std::optional<Scalar> gasTarget() const { return gas_target_; }
194 std::optional<Scalar> waterTarget() const { return water_target_; }
195 std::optional<Scalar> maxAlq() const { return max_alq_; }
196 std::optional<Scalar > maxTotalGasRate() const { return total_gas_; }
197 Scalar oilRate() const { return oil_rate_; }
198 std::optional<Scalar> oilTarget() const { return oil_target_; }
199 std::optional<Scalar> liquidTarget() const { return liquid_target_; }
200 Scalar oilPotential() const { return oil_potential_; }
201 Scalar gasPotential() const { return gas_potential_; }
202 Scalar waterPotential() const { return water_potential_; }
203
204 void update(Scalar delta_oil,
205 Scalar delta_gas,
206 Scalar delta_water,
207 Scalar delta_alq)
208 {
209 oil_rate_ += delta_oil;
210 gas_rate_ += delta_gas;
211 water_rate_ += delta_water;
212 alq_ += delta_alq;
213 // Note. We don't updata the potentials at this point. They
214 // are only needed initially.
215 }
216
217 private:
218 Scalar oil_rate_;
219 Scalar gas_rate_;
220 Scalar water_rate_;
221 Scalar alq_;
222 Scalar oil_potential_;
223 Scalar gas_potential_;
224 Scalar water_potential_;
225 std::optional<Scalar> oil_target_;
226 std::optional<Scalar> gas_target_;
227 std::optional<Scalar> water_target_;
228 std::optional<Scalar> liquid_target_;
229 std::optional<Scalar> total_gas_;
230 std::optional<Scalar> max_alq_;
231 };
232
234 const Schedule& schedule_;
235 const SummaryState& summary_state_;
237 const int iteration_idx_;
239 const GasLiftOpt& glo_;
244 // Optimize only wells under THP control
246};
247
248} // namespace Opm
249
250#endif // OPM_GASLIFT_GROUP_INFO_INCLUDED
Definition: DeferredLogger.hpp:57
Definition: GasLiftCommon.hpp:35
Definition: GasLiftGroupInfo.hpp:150
std::optional< Scalar > maxAlq() const
Definition: GasLiftGroupInfo.hpp:195
std::optional< Scalar > waterTarget() const
Definition: GasLiftGroupInfo.hpp:194
void assign(Scalar oil_rate, Scalar gas_rate, Scalar water_rate, Scalar alq)
Definition: GasLiftGroupInfo.hpp:181
Scalar oilRate() const
Definition: GasLiftGroupInfo.hpp:197
std::optional< Scalar > maxTotalGasRate() const
Definition: GasLiftGroupInfo.hpp:196
Scalar waterPotential() const
Definition: GasLiftGroupInfo.hpp:202
void update(Scalar delta_oil, Scalar delta_gas, Scalar delta_water, Scalar delta_alq)
Definition: GasLiftGroupInfo.hpp:204
std::optional< Scalar > gasTarget() const
Definition: GasLiftGroupInfo.hpp:193
Scalar oilPotential() const
Definition: GasLiftGroupInfo.hpp:200
Scalar gasPotential() const
Definition: GasLiftGroupInfo.hpp:201
GroupRates(Scalar oil_rate, Scalar gas_rate, Scalar water_rate, Scalar alq, Scalar oil_potential, Scalar gas_potential, Scalar water_potential, std::optional< Scalar > oil_target, std::optional< Scalar > gas_target, std::optional< Scalar > water_target, std::optional< Scalar > liquid_target, std::optional< Scalar > total_gas, std::optional< Scalar > max_alq)
Definition: GasLiftGroupInfo.hpp:152
std::optional< Scalar > oilTarget() const
Definition: GasLiftGroupInfo.hpp:198
Scalar waterRate() const
Definition: GasLiftGroupInfo.hpp:192
Scalar gasRate() const
Definition: GasLiftGroupInfo.hpp:191
std::optional< Scalar > liquidTarget() const
Definition: GasLiftGroupInfo.hpp:199
Scalar alq() const
Definition: GasLiftGroupInfo.hpp:180
Definition: GasLiftGroupInfo.hpp:46
bool hasWell(const std::string &well_name)
const SummaryState & summary_state_
Definition: GasLiftGroupInfo.hpp:235
bool checkDoGasLiftOptimization_(const std::string &well_name)
GasLiftGroupInfo(GLiftEclWells &ecl_wells, const Schedule &schedule, const SummaryState &summary_state, const int report_step_idx, const int iteration_idx, DeferredLogger &deferred_logger, WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Parallel::Communication &comm, bool glift_debug)
const GasLiftOpt & glo_
Definition: GasLiftGroupInfo.hpp:239
Scalar waterRate(const std::string &group_name) const
void debugDisplayUpdatedGroupRates(const std::string &name, Scalar oil_rate, Scalar gas_rate, Scalar water_rate, Scalar alq) const
std::optional< Scalar > maxAlq(const std::string &group_name)
void update(const std::string &well_name, Scalar delta_oil, Scalar delta_gas, Scalar delta_water, Scalar delta_alq)
std::tuple< Scalar, Scalar, Scalar, Scalar > getRates(const int group_idx) const
int getGroupIdx(const std::string &group_name)
Scalar gasRate(const std::string &group_name) const
void updateRate(int idx, Scalar oil_rate, Scalar gas_rate, Scalar water_rate, Scalar alq)
GroupRateMap group_rate_map_
Definition: GasLiftGroupInfo.hpp:240
Scalar waterPotential(const std::string &group_name) const
GLiftEclWells & ecl_wells_
Definition: GasLiftGroupInfo.hpp:233
void updateGroupIdxMap_(const std::string &group_name)
Well2GroupMap well_group_map_
Definition: GasLiftGroupInfo.hpp:241
Scalar getPotential(Rate rate_type, const std::string &group_name) const
const PhaseUsageInfo< IndexTraits > & phase_usage_
Definition: GasLiftGroupInfo.hpp:238
Rate
Definition: GasLiftGroupInfo.hpp:62
Scalar oilPotential(const std::string &group_name) const
const Schedule & schedule_
Definition: GasLiftGroupInfo.hpp:234
bool optimize_only_thp_wells_
Definition: GasLiftGroupInfo.hpp:245
void initializeWell2GroupMapRecursive_(const Group &group, std::vector< std::string > &group_names, std::vector< Scalar > &group_efficiency, Scalar cur_efficiency)
void debugStartInitializeGroup(const std::string &name) const
void debugDisplayWellContribution_(const std::string &gr_name, const std::string &well_name, Scalar eff_factor, Scalar well_oil_rate, Scalar well_gas_rate, Scalar well_water_rate, Scalar well_alq, Scalar oil_rate, Scalar gas_rate, Scalar water_rate, Scalar alq) const
Scalar gasPotential(const std::string &group_name) const
GroupIdxMap group_idx_
Definition: GasLiftGroupInfo.hpp:242
void debugEndInitializeGroup(const std::string &name) const
static const std::string rateToString(Rate rate)
std::map< std::string, std::vector< std::pair< std::string, Scalar > > > Well2GroupMap
Definition: GasLiftGroupInfo.hpp:55
std::vector< std::pair< std::string, Scalar > > & getWellGroups(const std::string &well_name)
Scalar getRate(Rate rate_type, const std::string &group_name) const
void displayDebugMessage_(const std::string &msg) const override
std::tuple< Scalar, Scalar, Scalar, Scalar, Scalar, Scalar, Scalar > initializeGroupRatesRecursive_(const Group &group)
std::optional< Scalar > oilTarget(const std::string &group_name) const
const Well2GroupMap & wellGroupMap()
Definition: GasLiftGroupInfo.hpp:112
Dune::Communication< Dune::MPIHelper::MPICommunicator > Communication
Definition: GasLiftGroupInfo.hpp:59
bool hasAnyTarget(const std::string &group_name) const
std::map< std::string, std::pair< const Well *, int > > GLiftEclWells
Definition: GasLiftGroupInfo.hpp:64
std::map< std::string, int > GroupIdxMap
Definition: GasLiftGroupInfo.hpp:58
void displayDebugMessage_(const std::string &msg, const std::string &well_name)
Scalar oilRate(const std::string &group_name) const
std::optional< Scalar > waterTarget(const std::string &group_name) const
const int report_step_idx_
Definition: GasLiftGroupInfo.hpp:236
std::optional< Scalar > gasTarget(const std::string &group_name) const
std::optional< Scalar > liquidTarget(const std::string &group_name) const
std::map< std::string, GroupRates > GroupRateMap
Definition: GasLiftGroupInfo.hpp:57
Scalar alqRate(const std::string &group_name)
std::tuple< Scalar, Scalar, Scalar, Scalar, Scalar, Scalar > getProducerWellRates_(const Well *well, const int index)
std::optional< Scalar > maxTotalGasRate(const std::string &group_name)
std::optional< Scalar > getTarget(Rate rate_type, const std::string &group_name) const
const int iteration_idx_
Definition: GasLiftGroupInfo.hpp:237
const std::string & groupIdxToName(int group_idx) const
int next_group_idx_
Definition: GasLiftGroupInfo.hpp:243
bool checkNewtonIterationIdxOk_(const std::string &well_name)
Definition: GroupState.hpp:41
Definition: GasLiftGroupInfo.hpp:37
Definition: WellState.hpp:66
Dune::Communication< MPIComm > Communication
Definition: ParallelCommunication.hpp:30
Definition: blackoilboundaryratevector.hh:39