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