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
34
35namespace Opm {
36
37template<class Scalar> struct PerforationData;
38class SummaryState;
39class Well;
40
41template<class Scalar>
43public:
44 SingleWellState(const std::string& name,
45 const ParallelWellInfo<Scalar>& pinfo,
46 bool is_producer,
47 Scalar presssure_first_connection,
48 const std::vector<PerforationData<Scalar>>& perf_input,
49 const PhaseUsage& pu,
50 Scalar temp);
51
53
54 template<class Serializer>
55 void serializeOp(Serializer& serializer)
56 {
57 serializer(name);
58 serializer(status);
59 serializer(producer);
60 serializer(bhp);
61 serializer(thp);
62 serializer(temperature);
63 serializer(efficiency_scaling_factor);
64 serializer(phase_mixing_rates);
65 serializer(well_potentials);
66 serializer(productivity_index);
67 serializer(implicit_ipr_a);
68 serializer(implicit_ipr_b);
69 serializer(surface_rates);
70 serializer(reservoir_rates);
71 serializer(prev_surface_rates);
72 serializer(trivial_group_target);
73 serializer(segments);
74 serializer(events);
75 serializer(injection_cmode);
76 serializer(production_cmode);
77 serializer(filtrate_conc);
78 serializer(perf_data);
79 serializer(primaryvar);
80 serializer(alq_state);
81 serializer(group_target);
82 }
83
84 bool operator==(const SingleWellState&) const;
85
86 std::string name;
87 std::reference_wrapper<const ParallelWellInfo<Scalar>> parallel_info;
88
89 WellStatus status{WellStatus::OPEN};
92 Scalar bhp{0};
93 Scalar thp{0};
94 Scalar temperature{0};
96
97 // filtration injection concentration
98 Scalar filtrate_conc{0};
99
100 std::array<Scalar,4> phase_mixing_rates{};
106 };
107
108 std::vector<Scalar> well_potentials;
109 std::vector<Scalar> productivity_index;
110 std::vector<Scalar> implicit_ipr_a;
111 std::vector<Scalar> implicit_ipr_b;
112 std::vector<Scalar> surface_rates;
113 std::vector<Scalar> reservoir_rates;
114 std::vector<Scalar> prev_surface_rates;
117 std::optional<Scalar> group_target;
119 Events events;
120 WellInjectorCMode injection_cmode{WellInjectorCMode::CMODE_UNDEFINED};
121 WellProducerCMode production_cmode{WellProducerCMode::CMODE_UNDEFINED};
122 std::vector<Scalar> primaryvar;
124
131 void reset_connection_factors(const std::vector<PerforationData<Scalar>>& new_perf_data);
132 void update_producer_targets(const Well& ecl_well, const SummaryState& st);
133 void update_injector_targets(const Well& ecl_well, const SummaryState& st);
139 void update_type_and_targets(const Well& ecl_well, const SummaryState& st);
140 void updateStatus(WellStatus status);
141 void init_timestep(const SingleWellState& other);
142 void shut();
143 void stop();
144 void open();
145
146 // The sum_xxx_rates() functions sum over all connection rates of pertinent
147 // types. In the case of distributed wells this involves an MPI
148 // communication.
149 Scalar sum_solvent_rates() const;
150 Scalar sum_polymer_rates() const;
151 Scalar sum_brine_rates() const;
152 Scalar sum_microbial_rates() const;
153 Scalar sum_oxygen_rates() const;
154 Scalar sum_urea_rates() const;
155 Scalar sum_wat_mass_rates() const;
156
157 Scalar sum_filtrate_rate() const;
158 Scalar sum_filtrate_total() const;
159
160private:
161 Scalar sum_connection_rates(const std::vector<Scalar>& connection_rates) const;
162};
163
164}
165
166#endif
Definition: ALQState.hpp:32
Class encapsulating some information about parallel wells.
Definition: ParallelWellInfo.hpp:195
Definition: PerfData.hpp:34
Definition: SegmentState.hpp:34
Definition: SingleWellState.hpp:42
void updateStatus(WellStatus status)
Scalar sum_polymer_rates() const
std::vector< Scalar > surface_rates
Definition: SingleWellState.hpp:112
PhaseUsage pu
Definition: SingleWellState.hpp:91
Scalar sum_filtrate_total() const
std::vector< Scalar > primaryvar
Definition: SingleWellState.hpp:122
std::vector< Scalar > implicit_ipr_b
Definition: SingleWellState.hpp:111
std::optional< Scalar > group_target
Definition: SingleWellState.hpp:117
Events events
Definition: SingleWellState.hpp:119
std::vector< Scalar > prev_surface_rates
Definition: SingleWellState.hpp:114
void update_type_and_targets(const Well &ecl_well, const SummaryState &st)
update the type of the well and the targets.
Scalar sum_brine_rates() const
WellInjectorCMode injection_cmode
Definition: SingleWellState.hpp:120
SegmentState< Scalar > segments
Definition: SingleWellState.hpp:118
std::string name
Definition: SingleWellState.hpp:86
void init_timestep(const SingleWellState &other)
WellProducerCMode production_cmode
Definition: SingleWellState.hpp:121
Scalar sum_urea_rates() const
std::vector< Scalar > well_potentials
Definition: SingleWellState.hpp:108
std::vector< Scalar > implicit_ipr_a
Definition: SingleWellState.hpp:110
Scalar thp
Definition: SingleWellState.hpp:93
bool producer
Definition: SingleWellState.hpp:90
void update_injector_targets(const Well &ecl_well, const SummaryState &st)
Scalar filtrate_conc
Definition: SingleWellState.hpp:98
PerfData< Scalar > perf_data
Definition: SingleWellState.hpp:115
Scalar sum_solvent_rates() const
RateIndices
Definition: SingleWellState.hpp:101
@ dissolved_gas_in_water
Definition: SingleWellState.hpp:103
@ vaporized_oil
Definition: SingleWellState.hpp:104
@ dissolved_gas
Definition: SingleWellState.hpp:102
@ vaporized_water
Definition: SingleWellState.hpp:105
Scalar efficiency_scaling_factor
Definition: SingleWellState.hpp:95
Scalar sum_wat_mass_rates() const
ALQState< Scalar > alq_state
Definition: SingleWellState.hpp:123
bool operator==(const SingleWellState &) const
Scalar bhp
Definition: SingleWellState.hpp:92
SingleWellState(const std::string &name, const ParallelWellInfo< Scalar > &pinfo, bool is_producer, Scalar presssure_first_connection, const std::vector< PerforationData< Scalar > > &perf_input, const PhaseUsage &pu, Scalar temp)
void reset_connection_factors(const std::vector< PerforationData< Scalar > > &new_perf_data)
Scalar sum_microbial_rates() const
static SingleWellState serializationTestObject(const ParallelWellInfo< Scalar > &pinfo)
Scalar temperature
Definition: SingleWellState.hpp:94
void update_producer_targets(const Well &ecl_well, const SummaryState &st)
Scalar sum_filtrate_rate() const
WellStatus status
Definition: SingleWellState.hpp:89
std::reference_wrapper< const ParallelWellInfo< Scalar > > parallel_info
Definition: SingleWellState.hpp:87
std::vector< Scalar > reservoir_rates
Definition: SingleWellState.hpp:113
bool trivial_group_target
Definition: SingleWellState.hpp:116
std::vector< Scalar > productivity_index
Definition: SingleWellState.hpp:109
void serializeOp(Serializer &serializer)
Definition: SingleWellState.hpp:55
std::array< Scalar, 4 > phase_mixing_rates
Definition: SingleWellState.hpp:100
Scalar sum_oxygen_rates() const
Definition: blackoilboundaryratevector.hh:39
Static data associated with a well perforation.
Definition: PerforationData.hpp:30
Definition: BlackoilPhases.hpp:46