GroupState.hpp
Go to the documentation of this file.
1/*
2 Copyright 2021 Equinor
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_GROUPSTATE_HEADER_INCLUDED
21#define OPM_GROUPSTATE_HEADER_INCLUDED
22
23#include <opm/input/eclipse/EclipseState/Phase.hpp>
24
25#include <opm/input/eclipse/Schedule/Group/GPMaint.hpp>
26#include <opm/input/eclipse/Schedule/Group/Group.hpp>
27
29
30#include <map>
31#include <vector>
32#include <utility>
33
34namespace Opm {
35
36 class GConSump;
37 class Schedule;
38 class SummaryState;
39
40template<class Scalar>
42public:
43 GroupState() = default;
44 explicit GroupState(std::size_t num_phases);
45
47
48 bool operator==(const GroupState& other) const;
49
50 bool has_production_rates(const std::string& gname) const;
51 void update_production_rates(const std::string& gname,
52 const std::vector<Scalar>& rates);
53 void update_network_leaf_node_production_rates(const std::string& gname,
54 const std::vector<Scalar>& rates);
55 const std::vector<Scalar>& production_rates(const std::string& gname) const;
56 const std::vector<Scalar>& network_leaf_node_production_rates(const std::string& gname) const;
57
58 void update_well_group_thp(const std::string& gname, const double& thp);
59 Scalar well_group_thp(const std::string& gname) const;
60 bool is_autochoke_group(const std::string& gname) const;
61
62 bool has_production_reduction_rates(const std::string& gname) const;
63 void update_production_reduction_rates(const std::string& gname,
64 const std::vector<Scalar>& rates);
65 const std::vector<Scalar>& production_reduction_rates(const std::string& gname) const;
66
67 bool has_injection_reduction_rates(const std::string& gname) const;
68 void update_injection_reduction_rates(const std::string& gname,
69 const std::vector<Scalar>& rates);
70 const std::vector<Scalar>& injection_reduction_rates(const std::string& gname) const;
71
72 bool has_injection_reservoir_rates(const std::string& gname) const;
73 void update_injection_reservoir_rates(const std::string& gname,
74 const std::vector<Scalar>& rates);
75 const std::vector<Scalar>& injection_reservoir_rates(const std::string& gname) const;
76
77 bool has_injection_surface_rates(const std::string& gname) const;
78 void update_injection_surface_rates(const std::string& gname,
79 const std::vector<Scalar>& rates);
80 const std::vector<Scalar>& injection_surface_rates(const std::string& gname) const;
81
82 void update_injection_rein_rates(const std::string& gname,
83 const std::vector<Scalar>& rates);
84 const std::vector<Scalar>& injection_rein_rates(const std::string& gname) const;
85
86 void update_injection_vrep_rate(const std::string& gname, Scalar rate);
87 Scalar injection_vrep_rate(const std::string& gname) const;
88
89 void update_grat_sales_target(const std::string& gname, Scalar target);
90 Scalar grat_sales_target(const std::string& gname) const;
91 bool has_grat_sales_target(const std::string& gname) const;
92
93 void update_gpmaint_target(const std::string& gname, Scalar target);
94 Scalar gpmaint_target(const std::string& gname) const;
95 bool has_gpmaint_target(const std::string& gname) const;
96
97 bool has_production_control(const std::string& gname) const;
98 void production_control(const std::string& gname, Group::ProductionCMode cmode);
99 Group::ProductionCMode production_control(const std::string& gname) const;
100
101 bool has_injection_control(const std::string& gname, Phase phase) const;
102 void injection_control(const std::string& gname, Phase phase, Group::InjectionCMode cmode);
103 Group::InjectionCMode injection_control(const std::string& gname, Phase phase) const;
104
105 void update_number_of_wells_under_group_control(const std::string& gname, int number);
106 int number_of_wells_under_group_control(const std::string& gname) const;
107
108 void update_number_of_wells_under_inj_group_control(const std::string& gname, Phase phase, int number);
109 int number_of_wells_under_inj_group_control(const std::string& gname, Phase phase) const;
110
111
112 void update_gconsump(const Schedule& schedule, const int report_step, const SummaryState& summary_state);
113 const std::pair<Scalar, Scalar>& gconsump_rates(const std::string& gname) const;
114
116 Scalar oil_rate;
117 Scalar gas_rate;
119
120 GroupPotential(Scalar oil = 0.0, Scalar gas = 0.0, Scalar water = 0.0)
121 : oil_rate(oil), gas_rate(gas), water_rate(water) {}
122 };
123
125 const std::string& gname, Scalar oil_rate, Scalar gas_rate, Scalar water_rate
126 );
127 const GroupPotential& get_production_group_potential(const std::string& gname) const;
128
129 std::size_t data_size() const;
130 std::size_t collect(Scalar* data) const;
131 std::size_t distribute(const Scalar* data);
132
133 GPMaint::State& gpmaint(const std::string& gname);
134
135 template<class Comm>
136 void communicate_rates(const Comm& comm)
137 {
138 // Note that injection_group_vrep_rates is handled separate from
139 // the forAllGroupData() function, since it contains single doubles,
140 // not vectors.
141
142 // Create a function that calls some function
143 // for all the individual data items to simplify
144 // the further code.
145 auto iterateContainer = [](auto& container, const auto& func) {
146 for (auto& x : container) {
147 func(x.second);
148 }
149 };
150
151
152 auto forAllGroupData = [&](auto& func) {
153 iterateContainer(m_production_rates, func);
154 iterateContainer(m_network_leaf_node_production_rates, func);
155 iterateContainer(prod_red_rates, func);
156 iterateContainer(inj_red_rates, func);
157 iterateContainer(inj_resv_rates, func);
158 iterateContainer(inj_rein_rates, func);
159 iterateContainer(inj_surface_rates, func);
160 };
161
162 // Compute the size of the data.
163 std::size_t sz = 0;
164 auto computeSize = [&sz](const auto& v) {
165 sz += v.size();
166 };
167 forAllGroupData(computeSize);
168 sz += this->inj_vrep_rate.size();
169
170 // Make a vector and collect all data into it.
171 std::vector<Scalar> data(sz);
172 std::size_t pos = 0;
173
174 // That the collect function mutates the vector v is an artifact for
175 // testing.
176 auto doCollect = [&data, &pos](auto& v) {
177 for (auto& x : v) {
178 data[pos++] = x;
179 x = -1;
180 }
181 };
182 forAllGroupData(doCollect);
183 for (const auto& x : this->inj_vrep_rate) {
184 data[pos++] = x.second;
185 }
186 if (pos != sz)
187 throw std::logic_error("Internal size mismatch when collecting groupData");
188
189 // Communicate it with a single sum() call.
190 comm.sum(data.data(), data.size());
191
192 // Distribute the summed vector to the data items.
193 pos = 0;
194 auto doDistribute = [&data, &pos](auto& v) {
195 std::copy_n(data.begin() + pos, v.size(), v.begin());
196 pos += v.size();
197 };
198 forAllGroupData(doDistribute);
199 for (auto& x : this->inj_vrep_rate) {
200 x.second = data[pos++];
201 }
202 if (pos != sz)
203 throw std::logic_error("Internal size mismatch when distributing groupData");
204 }
205
206 template<class Serializer>
207 void serializeOp(Serializer& serializer)
208 {
209 serializer(num_phases);
210 serializer(m_production_rates);
211 serializer(m_network_leaf_node_production_rates);
212 serializer(production_controls);
213 serializer(group_thp);
214 serializer(prod_red_rates);
215 serializer(inj_red_rates);
216 serializer(inj_surface_rates);
217 serializer(inj_resv_rates);
218 serializer(inj_rein_rates);
219 serializer(inj_vrep_rate);
220 serializer(m_grat_sales_target);
221 serializer(m_gpmaint_target);
222 serializer(injection_controls);
223 serializer(gpmaint_state);
224 serializer(m_gconsump_rates);
225 serializer(m_number_of_wells_under_group_control);
226 serializer(m_number_of_wells_under_inj_group_control);
227 }
228
229private:
230 std::size_t num_phases{};
231 std::map<std::string, std::vector<Scalar>> m_production_rates;
232 std::map<std::string, std::vector<Scalar>> m_network_leaf_node_production_rates;
233 std::map<std::string, Group::ProductionCMode> production_controls;
234 std::map<std::string, std::vector<Scalar>> prod_red_rates;
235 std::map<std::string, std::vector<Scalar>> inj_red_rates;
236 std::map<std::string, std::vector<Scalar>> inj_surface_rates;
237 std::map<std::string, std::vector<Scalar>> inj_resv_rates;
238 std::map<std::string, std::vector<Scalar>> inj_rein_rates;
239 std::map<std::string, Scalar> inj_vrep_rate;
240 std::map<std::string, Scalar> m_grat_sales_target;
241 std::map<std::string, Scalar> m_gpmaint_target;
242 std::map<std::string, Scalar> group_thp;
243 std::map<std::string, GroupPotential> production_group_potentials;
244 std::map<std::string, int> m_number_of_wells_under_group_control;
245 std::map<std::pair<Phase, std::string>, int> m_number_of_wells_under_inj_group_control;
246
247
248 std::map<std::pair<Phase, std::string>, Group::InjectionCMode> injection_controls;
249 WellContainer<GPMaint::State> gpmaint_state;
250 std::map<std::string, std::pair<Scalar, Scalar>> m_gconsump_rates; // Pair with {consumption_rate, import_rate} for each group
251 static constexpr std::pair<Scalar, Scalar> zero_pair = {0.0, 0.0};
252};
253
254}
255
256#endif
Dune::OwnerOverlapCopyCommunication< int, int > Comm
Definition: FlexibleSolver_impl.hpp:304
Definition: GroupState.hpp:41
const std::vector< Scalar > & injection_reservoir_rates(const std::string &gname) const
bool has_injection_control(const std::string &gname, Phase phase) const
Scalar injection_vrep_rate(const std::string &gname) const
void update_production_reduction_rates(const std::string &gname, const std::vector< Scalar > &rates)
bool has_production_control(const std::string &gname) const
bool has_production_rates(const std::string &gname) const
void update_injection_rein_rates(const std::string &gname, const std::vector< Scalar > &rates)
void update_well_group_thp(const std::string &gname, const double &thp)
void serializeOp(Serializer &serializer)
Definition: GroupState.hpp:207
void update_gconsump(const Schedule &schedule, const int report_step, const SummaryState &summary_state)
GroupState()=default
const std::vector< Scalar > & injection_rein_rates(const std::string &gname) const
bool has_injection_reduction_rates(const std::string &gname) const
const std::pair< Scalar, Scalar > & gconsump_rates(const std::string &gname) const
const std::vector< Scalar > & injection_surface_rates(const std::string &gname) const
std::size_t distribute(const Scalar *data)
Scalar well_group_thp(const std::string &gname) const
const std::vector< Scalar > & production_rates(const std::string &gname) const
void injection_control(const std::string &gname, Phase phase, Group::InjectionCMode cmode)
GPMaint::State & gpmaint(const std::string &gname)
static GroupState serializationTestObject()
void update_injection_vrep_rate(const std::string &gname, Scalar rate)
void production_control(const std::string &gname, Group::ProductionCMode cmode)
int number_of_wells_under_inj_group_control(const std::string &gname, Phase phase) const
const GroupPotential & get_production_group_potential(const std::string &gname) const
void update_gpmaint_target(const std::string &gname, Scalar target)
std::size_t collect(Scalar *data) const
const std::vector< Scalar > & production_reduction_rates(const std::string &gname) const
void update_injection_reservoir_rates(const std::string &gname, const std::vector< Scalar > &rates)
void update_injection_surface_rates(const std::string &gname, const std::vector< Scalar > &rates)
const std::vector< Scalar > & network_leaf_node_production_rates(const std::string &gname) const
Scalar grat_sales_target(const std::string &gname) const
int number_of_wells_under_group_control(const std::string &gname) const
bool has_production_reduction_rates(const std::string &gname) const
Scalar gpmaint_target(const std::string &gname) const
bool operator==(const GroupState &other) const
void update_production_rates(const std::string &gname, const std::vector< Scalar > &rates)
void communicate_rates(const Comm &comm)
Definition: GroupState.hpp:136
void update_injection_reduction_rates(const std::string &gname, const std::vector< Scalar > &rates)
void update_group_production_potential(const std::string &gname, Scalar oil_rate, Scalar gas_rate, Scalar water_rate)
GroupState(std::size_t num_phases)
bool is_autochoke_group(const std::string &gname) const
void update_number_of_wells_under_inj_group_control(const std::string &gname, Phase phase, int number)
bool has_gpmaint_target(const std::string &gname) const
Group::InjectionCMode injection_control(const std::string &gname, Phase phase) const
void update_number_of_wells_under_group_control(const std::string &gname, int number)
Group::ProductionCMode production_control(const std::string &gname) const
void update_network_leaf_node_production_rates(const std::string &gname, const std::vector< Scalar > &rates)
void update_grat_sales_target(const std::string &gname, Scalar target)
const std::vector< Scalar > & injection_reduction_rates(const std::string &gname) const
bool has_injection_reservoir_rates(const std::string &gname) const
std::size_t data_size() const
bool has_injection_surface_rates(const std::string &gname) const
bool has_grat_sales_target(const std::string &gname) const
Definition: blackoilboundaryratevector.hh:39
Definition: GroupState.hpp:115
Scalar oil_rate
Definition: GroupState.hpp:116
Scalar gas_rate
Definition: GroupState.hpp:117
Scalar water_rate
Definition: GroupState.hpp:118
GroupPotential(Scalar oil=0.0, Scalar gas=0.0, Scalar water=0.0)
Definition: GroupState.hpp:120