SingleWellState.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_SINGLE_WELL_STATE_HEADER_INCLUDED
21#define OPM_SINGLE_WELL_STATE_HEADER_INCLUDED
22
23#include <functional>
24#include <vector>
25
26#include <opm/input/eclipse/Schedule/Well/WellEnums.hpp>
27#include <opm/input/eclipse/Schedule/Events.hpp>
28#include <opm/input/eclipse/Schedule/Group/Group.hpp>
29
30#include <opm/material/fluidsystems/PhaseUsageInfo.hpp>
31
36
37namespace Opm {
38
39template<class Scalar> struct PerforationData;
40class SummaryState;
41class Well;
42
43template<typename Scalar, typename IndexTraits>
45public:
49
50 SingleWellState(const std::string& name,
51 const ParallelWellInfo<Scalar>& pinfo,
53 bool is_producer,
55 const std::vector<PerforationData<Scalar>>& perf_input,
56 Scalar temp);
57
59
60 template<class Serializer>
61 void serializeOp(Serializer& serializer)
62 {
63 serializer(name);
64 serializer(status);
65 serializer(producer);
66 serializer(bhp);
67 serializer(thp);
68 serializer(network_thp_limit);
69 serializer(pressure_first_connection);
70 serializer(temperature);
71 serializer(rs_rep);
72 serializer(rv_rep);
73 serializer(rsw_rep);
74 serializer(rvw_rep);
75 serializer(energy_rate);
76 serializer(efficiency_scaling_factor);
77 serializer(well_potentials);
78 serializer(productivity_index);
79 serializer(implicit_ipr_a);
80 serializer(implicit_ipr_b);
81 serializer(surface_rates);
82 serializer(reservoir_rates);
83 serializer(prev_surface_rates);
84 serializer(segments);
85 serializer(events);
86 serializer(injection_cmode);
87 serializer(production_cmode);
88 serializer(filtrate_conc);
89 serializer(perf_data);
90 serializer(primaryvar);
91 serializer(alq_state);
92 serializer(group_target);
93 serializer(group_target_fallback);
94 serializer(use_group_target_fallback);
96 serializer(weldraw_max_rate);
97 serializer(weldraw_cmode);
98 }
99
100 bool operator==(const SingleWellState&) const;
101
113 bool restoreIfDiverged(const SingleWellState& snapshot, const bool solve_threw);
114
115 std::string name;
116 std::reference_wrapper<const ParallelWellInfo<Scalar>> parallel_info;
117
118 WellStatus status{WellStatus::OPEN};
121 Scalar bhp{0};
122 Scalar thp{0};
123 // Network-imposed THP limit retained until the schedule re-specifies the
124 // well's THP limit or VFP table.
125 std::optional<Scalar> network_thp_limit;
127
128 // thermal related
129 Scalar temperature{0};
130 Scalar energy_rate{0.};
131
133
134 // filtration injection concentration
135 Scalar filtrate_conc{0};
136
137 // Representative dissolved gas-oil, vaporised oil-gas, dissolved gas-water
138 // and vaporised water-gas ratios of the produced fluid. Used to split the
139 // total surface rates into free and dissolved/vaporised parts, see
140 // WellInterface::consolidatePhaseMixingRates.
141 Scalar rs_rep{0};
142 Scalar rv_rep{0};
143 Scalar rsw_rep{0};
144 Scalar rvw_rep{0};
145
151 };
152
153 struct GroupTarget {
154 std::string group_name;
155 Scalar target_value{0.0};
158 Scalar guiderate_ratio{1.0}; // well to group guide rate ratio for diagnostics
159
160 bool operator==(const GroupTarget& other) const {
161 return (group_name == other.group_name
162 && target_value == other.target_value
165 && guiderate_ratio == other.guiderate_ratio);
166 }
167
168 template<class Serializer>
169 void serializeOp(Serializer& serializer) {
170 serializer(group_name);
171 serializer(target_value);
172 serializer(production_cmode);
173 serializer(injection_cmode);
174 serializer(guiderate_ratio);
175 }
176 };
177
178 std::vector<Scalar> well_potentials;
179 std::vector<Scalar> productivity_index;
180 std::vector<Scalar> implicit_ipr_a;
181 std::vector<Scalar> implicit_ipr_b;
182 std::vector<Scalar> surface_rates;
183 std::vector<Scalar> reservoir_rates;
184 std::vector<Scalar> prev_surface_rates;
186 std::optional<GroupTarget> group_target;
187 std::optional<GroupTarget> group_target_fallback;
190 Events events;
191 WellInjectorCMode injection_cmode{WellInjectorCMode::CMODE_UNDEFINED};
192 WellProducerCMode production_cmode{WellProducerCMode::CMODE_UNDEFINED};
193 std::vector<Scalar> primaryvar;
195 // This is used to indicate whether the well was shut before applying an action
196 // if it was SHUT, even the action set the well to OPEN, the data in the well state
197 // is not well-defined. We do not use it to overwrite the current well state.
199 // Maximum production rate of the WELDRAW target phase derived from the
200 // well's drawdown limit; updated during the first NUPCOL iterations of
201 // each timestep and unset when no drawdown limit is active.
202 std::optional<Scalar> weldraw_max_rate{};
203 // The rate control which carries that limit, set only while the limit is
204 // at least as restrictive as the well's own target for the same phase.
205 // The well is under drawdown control when this is its active control.
206 std::optional<WellProducerCMode> weldraw_cmode{};
207
214 void reset_connection_factors(const std::vector<PerforationData<Scalar>>& new_perf_data);
215 void update_producer_targets(const Well& ecl_well, const SummaryState& st);
216 void update_injector_targets(const Well& ecl_well, const SummaryState& st);
222 void update_type_and_targets(const Well& ecl_well, const SummaryState& st);
223 bool updateStatus(WellStatus status);
224 void init_timestep(const SingleWellState& other);
225 void shut();
226 void stop();
227 void open();
228
229 // The sum_xxx_rates() functions sum over all connection rates of pertinent
230 // types. In the case of distributed wells this involves an MPI
231 // communication.
232 Scalar sum_solvent_rates() const;
233 Scalar sum_polymer_rates() const;
234 Scalar sum_brine_rates() const;
235 Scalar sum_microbial_rates() const;
236 Scalar sum_oxygen_rates() const;
237 Scalar sum_urea_rates() const;
238 Scalar sum_wat_mass_rates() const;
239
240 Scalar sum_filtrate_rate() const;
241 Scalar sum_filtrate_total() const;
242
245 Scalar sum_fracture_rate() const;
246
247private:
248 Scalar sum_connection_rates(const std::vector<Scalar>& connection_rates) const;
249};
250
251}
252
253#endif
Definition: ALQState.hpp:32
Class encapsulating some information about parallel wells.
Definition: ParallelWellInfo.hpp:217
Definition: PerfData.hpp:35
Definition: GasLiftGroupInfo.hpp:40
Definition: SegmentState.hpp:34
Definition: SingleWellState.hpp:44
WellProducerCMode production_cmode
Definition: SingleWellState.hpp:192
bool restoreIfDiverged(const SingleWellState &snapshot, const bool solve_threw)
Roll the state back to a snapshot if an inner well solve failed badly.
Scalar thp
Definition: SingleWellState.hpp:122
Scalar rsw_rep
Definition: SingleWellState.hpp:143
std::vector< Scalar > prev_surface_rates
Definition: SingleWellState.hpp:184
void reset_connection_factors(const std::vector< PerforationData< Scalar > > &new_perf_data)
static SingleWellState serializationTestObject(const ParallelWellInfo< Scalar > &pinfo)
std::vector< Scalar > surface_rates
Definition: SingleWellState.hpp:182
std::optional< Scalar > weldraw_max_rate
Definition: SingleWellState.hpp:202
SingleWellState(const std::string &name, const ParallelWellInfo< Scalar > &pinfo, const PhaseUsageInfo< IndexTraits > &pu, bool is_producer, Scalar pressure_first_connection, const std::vector< PerforationData< Scalar > > &perf_input, Scalar temp)
std::optional< GroupTarget > group_target
Definition: SingleWellState.hpp:186
WellStatus status
Definition: SingleWellState.hpp:118
void init_timestep(const SingleWellState &other)
Scalar sum_solvent_rates() const
Scalar sum_oxygen_rates() const
std::vector< Scalar > productivity_index
Definition: SingleWellState.hpp:179
std::optional< GroupTarget > group_target_fallback
Definition: SingleWellState.hpp:187
Scalar pressure_first_connection
Definition: SingleWellState.hpp:126
Scalar bhp
Definition: SingleWellState.hpp:121
std::reference_wrapper< const ParallelWellInfo< Scalar > > parallel_info
Definition: SingleWellState.hpp:116
void update_injector_targets(const Well &ecl_well, const SummaryState &st)
Scalar sum_fracture_rate() const
ALQState< Scalar > alq_state
Definition: SingleWellState.hpp:194
std::optional< WellProducerCMode > weldraw_cmode
Definition: SingleWellState.hpp:206
Scalar sum_filtrate_total() const
Scalar sum_microbial_rates() const
std::vector< Scalar > implicit_ipr_a
Definition: SingleWellState.hpp:180
void serializeOp(Serializer &serializer)
Definition: SingleWellState.hpp:61
Scalar rs_rep
Definition: SingleWellState.hpp:141
Scalar sum_filtrate_rate() const
Scalar sum_wat_mass_rates() const
std::vector< Scalar > implicit_ipr_b
Definition: SingleWellState.hpp:181
Scalar rv_rep
Definition: SingleWellState.hpp:142
RateIndices
Definition: SingleWellState.hpp:146
@ vaporized_water
Definition: SingleWellState.hpp:150
@ dissolved_gas_in_water
Definition: SingleWellState.hpp:148
@ dissolved_gas
Definition: SingleWellState.hpp:147
@ vaporized_oil
Definition: SingleWellState.hpp:149
static const int gasPhaseIdx
Definition: SingleWellState.hpp:48
bool operator==(const SingleWellState &) const
std::vector< Scalar > primaryvar
Definition: SingleWellState.hpp:193
Scalar sum_brine_rates() const
bool was_shut_before_action_applied
Definition: SingleWellState.hpp:198
SegmentState< Scalar > segments
Definition: SingleWellState.hpp:189
void update_type_and_targets(const Well &ecl_well, const SummaryState &st)
update the type of the well and the targets.
Scalar filtrate_conc
Definition: SingleWellState.hpp:135
std::vector< Scalar > well_potentials
Definition: SingleWellState.hpp:178
Scalar energy_rate
Definition: SingleWellState.hpp:130
bool updateStatus(WellStatus status)
static const int waterPhaseIdx
Definition: SingleWellState.hpp:46
std::string name
Definition: SingleWellState.hpp:115
Scalar sum_polymer_rates() const
Events events
Definition: SingleWellState.hpp:190
Scalar temperature
Definition: SingleWellState.hpp:129
WellInjectorCMode injection_cmode
Definition: SingleWellState.hpp:191
PhaseUsageInfo< IndexTraits > pu
Definition: SingleWellState.hpp:120
bool producer
Definition: SingleWellState.hpp:119
static const int oilPhaseIdx
Definition: SingleWellState.hpp:47
void update_producer_targets(const Well &ecl_well, const SummaryState &st)
Scalar sum_urea_rates() const
Scalar efficiency_scaling_factor
Definition: SingleWellState.hpp:132
bool use_group_target_fallback
Definition: SingleWellState.hpp:188
PerfData< Scalar > perf_data
Definition: SingleWellState.hpp:185
std::vector< Scalar > reservoir_rates
Definition: SingleWellState.hpp:183
Scalar rvw_rep
Definition: SingleWellState.hpp:144
std::optional< Scalar > network_thp_limit
Definition: SingleWellState.hpp:125
@ NONE
Definition: DeferredLogger.hpp:46
Definition: blackoilbioeffectsmodules.hh:45
Static data associated with a well perforation.
Definition: PerforationData.hpp:30
Definition: SingleWellState.hpp:153
Group::ProductionCMode production_cmode
Definition: SingleWellState.hpp:156
bool operator==(const GroupTarget &other) const
Definition: SingleWellState.hpp:160
Scalar target_value
Definition: SingleWellState.hpp:155
Scalar guiderate_ratio
Definition: SingleWellState.hpp:158
Group::InjectionCMode injection_cmode
Definition: SingleWellState.hpp:157
void serializeOp(Serializer &serializer)
Definition: SingleWellState.hpp:169
std::string group_name
Definition: SingleWellState.hpp:154