My Project
Loading...
Searching...
No Matches
GasLiftStage2.hpp
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_STAGE2_HEADER_INCLUDED
21#define OPM_GASLIFT_STAGE2_HEADER_INCLUDED
22
23#include <opm/simulators/wells/GasLiftSingleWellGeneric.hpp>
24
25#include <opm/simulators/utils/BlackoilPhases.hpp>
26
27#include <map>
28#include <memory>
29#include <optional>
30#include <string>
31#include <tuple>
32#include <vector>
33
34namespace Opm {
35
36class DeferredLogger;
37class GasLiftOpt;
38template<class Scalar> class GasLiftWellState;
39class Group;
40template<class Scalar> class GroupState;
41class Schedule;
42template<class Scalar> class WellInterfaceGeneric;
43template<class Scalar> class WellState;
44
45template<class Scalar>
46class GasLiftStage2 : public GasLiftCommon<Scalar>
47{
49 using GLiftOptWells = std::map<std::string,std::unique_ptr<GasLiftSingleWell>>;
50 using GLiftProdWells = std::map<std::string,const WellInterfaceGeneric<Scalar>*>;
51 using GLiftWellStateMap = std::map<std::string,std::unique_ptr<GasLiftWellState<Scalar>>>;
52 using GradPair = std::pair<std::string, Scalar>;
53 using GradPairItr = typename std::vector<GradPair>::iterator;
54 using GradInfo = typename GasLiftSingleWellGeneric<Scalar>::GradInfo;
55 using GradMap = std::map<std::string, GradInfo>;
56 using MessageType = typename GasLiftCommon<Scalar>::MessageType;
57
58 static const int Water = BlackoilPhases::Aqua;
59 static const int Oil = BlackoilPhases::Liquid;
60 static const int Gas = BlackoilPhases::Vapour;
61
62public:
64 const Parallel::Communication& comm,
65 const Schedule& schedule,
68 WellState<Scalar>& well_state,
69 const GroupState<Scalar>& group_state,
70 GLiftProdWells& prod_wells,
71 GLiftOptWells& glift_wells,
73 GLiftWellStateMap& state_map,
74 bool glift_debug);
75
76 void runOptimize();
77
78protected:
79 void addOrRemoveALQincrement_(GradMap& grad_map,
80 const std::string& well_name,
81 bool add);
82
83 std::optional<GradInfo> calcIncOrDecGrad_(const std::string name,
85 const std::string& gr_name_dont_limit,
86 bool increase);
87
88 bool checkRateAlreadyLimited_(const std::string& well_name,
90 bool increase);
91
92 GradInfo deleteDecGradItem_(const std::string& name);
93 GradInfo deleteIncGradItem_(const std::string& name);
94 GradInfo deleteGrad_(const std::string& name, bool increase);
95
96 void displayDebugMessage_(const std::string& msg) const override;
97 void displayDebugMessage2B_(const std::string& msg);
98 void displayDebugMessage_(const std::string& msg,
99 const std::string& group_name);
100 void displayWarning_(const std::string& msg,
101 const std::string& group_name);
102 void displayWarning_(const std::string& msg);
103
104 std::tuple<Scalar, Scalar, Scalar, Scalar>
105 getCurrentGroupRates_(const Group& group);
106
107 std::optional<Scalar> getGroupMaxALQ_(const Group& group);
108 std::optional<Scalar> getGroupMaxTotalGas_(const Group& group);
109
110 std::vector<GasLiftSingleWell*> getGroupGliftWells_(const Group& group);
111
112 void getGroupGliftWellsRecursive_(const Group& group,
113 std::vector<GasLiftSingleWell*>& wells);
114
115 void optimizeGroup_(const Group& group);
116 void optimizeGroupsRecursive_(const Group& group);
117
118 void recalculateGradientAndUpdateData_(GradPairItr& grad_itr,
119 const std::string& gr_name_dont_limit,
120 bool increase,
121 std::vector<GradPair>& grads,
122 std::vector<GradPair>& other_grads);
123
124 void redistributeALQ_(std::vector<GasLiftSingleWell*>& wells,
125 const Group& group,
126 std::vector<GradPair>& inc_grads,
127 std::vector<GradPair>& dec_grads);
128
129 void removeSurplusALQ_(const Group& group,
130 std::vector<GradPair>& inc_grads,
131 std::vector<GradPair>& dec_grads);
132
133 void saveGrad_(GradMap& map, const std::string& name, GradInfo& grad);
134 void saveDecGrad_(const std::string& name, GradInfo& grad);
135 void saveIncGrad_(const std::string& name, GradInfo& grad);
136 void sortGradients_(std::vector<GradPair>& grads);
137
138 std::optional<GradInfo> updateGrad_(const std::string& name,
139 GradInfo& grad, bool increase);
140
141 void updateGradVector_(const std::string& name,
142 std::vector<GradPair>& grads,
143 Scalar grad);
144
145 void mpiSyncGlobalGradVector_(std::vector<GradPair>& grads_global) const;
146 void mpiSyncLocalToGlobalGradVector_(const std::vector<GradPair>& grads_local,
147 std::vector<GradPair>& grads_global) const;
148
149 GLiftProdWells& prod_wells_;
150 GLiftOptWells& stage1_wells_;
151 GasLiftGroupInfo<Scalar>& group_info_;
152 GLiftWellStateMap& well_state_map_;
153
154 int report_step_idx_;
155 const SummaryState& summary_state_;
156 const Schedule& schedule_;
157 const GasLiftOpt& glo_;
158 GradMap inc_grads_;
159 GradMap dec_grads_;
160 int max_iterations_ = 1000;
161 //int time_step_idx_;
162
164 {
165 OptimizeState(GasLiftStage2& parent_, const Group& group_)
166 : parent{parent_}
167 , group{group_}
168 , it{0}
169 {}
170
171 GasLiftStage2& parent;
172 const Group& group;
173 int it;
174
175 using GradInfo = typename GasLiftStage2::GradInfo;
176 using GradPair = typename GasLiftStage2::GradPair;
177 using GradPairItr = typename GasLiftStage2::GradPairItr;
178 using GradMap = typename GasLiftStage2::GradMap;
179
180 void calculateEcoGradients(std::vector<GasLiftSingleWell*>& wells,
181 std::vector<GradPair>& inc_grads,
182 std::vector<GradPair>& dec_grads);
183
184 bool checkAtLeastTwoWells(std::vector<GasLiftSingleWell*>& wells);
185
186 void debugShowIterationInfo();
187
188 std::pair<std::optional<GradPairItr>,std::optional<GradPairItr>>
189 getEcoGradients(std::vector<GradPair>& inc_grads,
190 std::vector<GradPair>& dec_grads);
191
192 void recalculateGradients(std::vector<GradPair>& inc_grads,
193 std::vector<GradPair>& dec_grads,
194 GradPairItr& min_dec_grad_itr,
195 GradPairItr &max_inc_grad_itr);
196
197 void redistributeALQ( GradPairItr& min_dec_grad,
198 GradPairItr& max_inc_grad);
199
200 private:
201 void displayDebugMessage_(const std::string& msg);
202 void displayWarning_(const std::string& msg);
203 };
204
206 {
208 const Group& group_,
209 Scalar oil_rate_,
210 Scalar gas_rate_,
211 Scalar water_rate_,
212 Scalar alq_,
213 Scalar min_eco_grad_,
214 Scalar oil_target_,
215 Scalar gas_target_,
216 Scalar water_target_,
217 Scalar liquid_target_,
218 std::optional<Scalar> max_glift_,
219 std::optional<Scalar> max_total_gas_)
220 : parent{parent_}
221 , group{group_}
222 , oil_rate{oil_rate_}
223 , gas_rate{gas_rate_}
224 , water_rate{water_rate_}
225 , alq{alq_}
226 , min_eco_grad{min_eco_grad_}
227 , oil_target{oil_target_}
228 , gas_target{gas_target_}
229 , water_target(water_target_)
230 , liquid_target{liquid_target_}
231 , max_glift{max_glift_}
232 , max_total_gas{max_total_gas_}
233 , it{0}
234 {}
235
236 GasLiftStage2 &parent;
237 const Group &group;
238 Scalar oil_rate;
239 Scalar gas_rate;
240 Scalar water_rate;
241 Scalar alq;
242 const Scalar min_eco_grad;
243 const Scalar oil_target;
244 const Scalar gas_target;
245 const Scalar water_target;
246 const Scalar liquid_target;
247 std::optional<Scalar> max_glift;
248 std::optional<Scalar> max_total_gas;
249 int it;
250
251 void addOrRemoveALQincrement(GradMap &grad_map,
252 const std::string& well_name,
253 bool add);
254
255 bool checkALQlimit();
256 bool checkEcoGradient(const std::string& well_name, Scalar eco_grad);
257 bool checkGasTarget(Scalar delta_gas);
258 bool checkLiquidTarget(Scalar delta_liquid);
259 bool checkOilTarget(Scalar delta_oil);
260 bool checkWaterTarget(Scalar delta_water);
261 std::array<Scalar, 4> computeDelta(const std::string& name);
262 void updateRates(const std::array<Scalar, 4>& delta);
263 };
264};
265
266} // namespace Opm
267
268#endif // OPM_GASLIFT_STAGE2_HEADER_INCLUDED
Definition DeferredLogger.hpp:57
Definition GasLiftCommon.hpp:35
Definition GasLiftGroupInfo.hpp:46
Definition GasLiftSingleWellGeneric.hpp:50
Definition GasLiftStage2.hpp:47
Definition GasLiftWellState.hpp:30
Definition GroupState.hpp:38
The state of a set of wells, tailored for use by the fully implicit blackoil simulator.
Definition WellState.hpp:62
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilboundaryratevector.hh:37
constexpr auto getPropValue()
get the value data member of a property
Definition propertysystem.hh:242
Definition GasLiftSingleWellGeneric.hpp:64
Definition GasLiftStage2.hpp:164
Definition GasLiftStage2.hpp:206