21#ifndef OPM_WELLSTATEFULLYIMPLICITBLACKOIL_HEADER_INCLUDED
22#define OPM_WELLSTATEFULLYIMPLICITBLACKOIL_HEADER_INCLUDED
24#include <dune/common/version.hh>
25#include <dune/common/parallel/mpihelper.hh>
27#include <opm/common/ErrorMacros.hpp>
29#include <opm/material/fluidsystems/PhaseUsageInfo.hpp>
31#include <opm/input/eclipse/Schedule/Events.hpp>
33#include <opm/output/data/Wells.hpp>
56template<
class Scalar>
class ParallelWellInfo;
57template<
class Scalar>
struct PerforationData;
58template<
class Scalar>
class ConnFracStatistics;
60enum class WellStatus : std::uint8_t;
64template<
typename Scalar,
typename IndexTraits>
68 static const std::uint64_t
event_mask = ScheduleEvents::WELL_STATUS_CHANGE
69 | ScheduleEvents::PRODUCTION_UPDATE
70 | ScheduleEvents::INJECTION_UPDATE;
91 return this->wells_.size();
94 std::vector<std::string>
wells()
const
96 return this->wells_.wells();
107 return this->phaseUsageInfo_;
115 void init(
const std::vector<Scalar>& cellPressures,
116 const std::vector<Scalar>& cellTemperatures,
117 const Schedule& schedule,
118 const std::vector<Well>& wells_ecl,
120 const int report_step,
123 const SummaryState& summary_state,
124 const bool enableDistributedWells);
126 void resize(
const std::vector<Well>& wells_ecl,
128 const Schedule& schedule,
129 const bool handle_ms_well,
130 const std::size_t numCells,
132 const SummaryState& summary_state,
133 const bool enable_distributed_wells);
136 const std::vector<Scalar>& new_rates)
138 auto& [owner, rates] = this->well_rates.at(wellName);
147 return this->well_rates.find(wellName) != this->well_rates.end();
152 this->well_rates.clear();
156 std::vector<data::Connection>& to_connections,
161 const std::function<
bool(
const int)>& wasDynamicallyClosed)
const;
164 std::size_t well_index,
165 const int* globalCellIdxMap)
const;
172 const std::vector<std::vector<int>>& segment_inlets,
173 const std::vector<std::vector<int>>& segment_perforations,
174 const std::vector<Scalar>& perforation_rates,
177 std::vector<Scalar>& segment_rates);
183 const std::vector<WellStatus>& well_status);
189 return this->global_well_info.value().in_injecting_group(
name);
194 return this->global_well_info.value().in_producing_group(
name);
199 return this->global_well_info.value().is_open(
name);
204 return this->global_well_info.value().efficiency_scaling_factor(
name);
212 const int report_step,
213 const SummaryState& summary_state);
217 for (
size_t i = 0; i < this->
size(); ++i) {
218 this->wells_[i].alq_state.reset_count();
225 return this->global_well_info.value().well_index(
name);
230 return this->global_well_info.value().well_name(
index);
234 const std::string& wellName)
const;
239 return this->global_well_info.value().isRank0();
251 return phaseUsageInfo_.numActivePhases();
256 {
return this->wells_[well_index].surface_rates; }
257 const std::vector<Scalar>&
wellRates(std::size_t well_index)
const
258 {
return this->wells_[well_index].surface_rates; }
260 const std::string&
name(std::size_t well_index)
const
262 return this->wells_.well_name(well_index);
265 std::optional<std::size_t>
index(
const std::string& well_name)
const
267 return this->wells_.well_index(well_name);
272 return this->wells_[well_index];
277 return this->wells_[well_name];
282 return this->wells_[well_index];
287 return this->wells_[well_name];
310 bool has(
const std::string& well_name)
const
312 return this->wells_.has(well_name);
317 template<
class Serializer>
320 serializer(well_rates);
321 if (serializer.isSerializing()) {
322 serializer(wells_.size());
324 std::size_t
size = 0;
326 if (
size != wells_.size()) {
327 OPM_THROW(std::runtime_error,
"Error deserializing WellState: size mismatch");
330 for (
auto& w : wells_) {
333 serializer(permanently_inactive_well_names_);
337 return std::find(this->permanently_inactive_well_names_.begin(), this->permanently_inactive_well_names_.end(), wname) != this->permanently_inactive_well_names_.end();
341 bool enableDistributedWells_ =
false;
356 std::optional<GlobalWellInfo<Scalar>> global_well_info;
361 std::map<std::string, std::pair<bool, std::vector<Scalar>>> well_rates;
364 std::vector<std::string> permanently_inactive_well_names_;
367 reportSegmentResults(
const int well_id,
369 const int seg_no)
const;
377 void base_init(
const std::vector<Scalar>& cellPressures,
378 const std::vector<Scalar>& cellTemperatures,
379 const std::vector<Well>& wells_ecl,
382 const SummaryState& summary_state);
384 void initSingleWell(
const std::vector<Scalar>& cellPressures,
385 const std::vector<Scalar>& cellTemperatures,
389 const SummaryState& summary_state);
391 void initSingleProducer(
const Well&
well,
393 Scalar pressure_first_connection,
395 const SummaryState& summary_state);
397 void initSingleInjector(
const Well&
well,
399 Scalar pressure_first_connection,
400 Scalar temperature_first_connection,
402 const SummaryState& summary_state);
405 const std::vector<std::vector<int>>& segment_inlets,
406 const std::vector<std::vector<int>>& segment_perforations,
407 const std::vector<Scalar>& perforation_rates,
410 std::vector<Scalar>& segment_rates);
412 void reportConnectionFactors(
const std::size_t well_index,
413 std::vector<data::Connection>& connections)
const;
415 void reportConnectionPressuresAndRates(
const std::size_t well_index,
416 std::vector<data::Connection>& connections)
const;
418 void reportConnectionFilterCake(
const std::size_t well_index,
419 std::vector<data::Connection>& connections)
const;
422 std::vector<data::Connection>& connections)
const;
Definition: ConnFracStatistics.hpp:37
Class encapsulating some information about parallel wells.
Definition: ParallelWellInfo.hpp:198
Definition: GasLiftGroupInfo.hpp:37
Definition: SingleWellState.hpp:43
Definition: WellContainer.hpp:46
Definition: WellState.hpp:66
bool has(const std::string &well_name) const
Definition: WellState.hpp:310
void reportConnections(std::vector< data::Connection > &connections, std::size_t well_index, const int *globalCellIdxMap) const
void resize(const std::vector< Well > &wells_ecl, const std::vector< std::reference_wrapper< ParallelWellInfo< Scalar > > > ¶llel_well_info, const Schedule &schedule, const bool handle_ms_well, const std::size_t numCells, const std::vector< std::vector< PerforationData< Scalar > > > &well_perf_data, const SummaryState &summary_state, const bool enable_distributed_wells)
void clearWellRates()
Definition: WellState.hpp:150
bool isProductionGrup(const std::string &name) const
Definition: WellState.hpp:192
bool wellIsOwned(std::size_t well_index, const std::string &wellName) const
void openWell(int well_index)
SingleWellState< Scalar, IndexTraits > & operator[](std::size_t well_index)
Definition: WellState.hpp:280
constexpr int numPhases() const
The number of phases present.
Definition: WellState.hpp:249
SingleWellState< Scalar, IndexTraits > & well(std::size_t well_index)
Definition: WellState.hpp:300
bool hasWellRates(const std::string &wellName) const
Definition: WellState.hpp:145
bool is_permanently_inactive_well(const std::string &wname) const
Definition: WellState.hpp:336
std::string globalIdxToWellName(const int index)
Definition: WellState.hpp:228
const ParallelWellInfo< Scalar > & parallelWellInfo(std::size_t well_index) const
void updateGlobalIsGrup(const Parallel::Communication &comm, const std::vector< WellStatus > &well_status)
void communicateGroupRates(const Parallel::Communication &comm)
static const int gasPhaseIdx
Definition: WellState.hpp:78
bool isInjectionGrup(const std::string &name) const
Definition: WellState.hpp:187
void initWellStateMSWell(const std::vector< Well > &wells_ecl, const WellState *prev_well_state)
init the MS well related.
int wellNameToGlobalIdx(const std::string &name)
Definition: WellState.hpp:223
static const int waterPhaseIdx
Definition: WellState.hpp:76
void stopWell(int well_index)
void gatherVectorsOnRoot(const std::vector< data::Connection > &from_connections, std::vector< data::Connection > &to_connections, const Parallel::Communication &comm) const
void gliftTimeStepInit()
Definition: WellState.hpp:215
const SingleWellState< Scalar, IndexTraits > & operator[](const std::string &well_name) const
Definition: WellState.hpp:275
bool operator==(const WellState &) const
WellState(const ParallelWellInfo< Scalar > &pinfo)
void setCurrentWellRates(const std::string &wellName, const std::vector< Scalar > &new_rates)
Definition: WellState.hpp:135
int numWells() const
Definition: WellState.hpp:99
static const int oilPhaseIdx
Definition: WellState.hpp:77
Scalar getGlobalEfficiencyScalingFactor(const std::string &name) const
Definition: WellState.hpp:202
const std::vector< Scalar > & currentWellRates(const std::string &wellName) const
const PhaseUsageInfo< IndexTraits > & phaseUsageInfo() const
Definition: WellState.hpp:105
std::vector< std::string > wells() const
Definition: WellState.hpp:94
bool isRank0() const
Definition: WellState.hpp:238
const SingleWellState< Scalar, IndexTraits > & well(const std::string &well_name) const
Definition: WellState.hpp:295
static const std::uint64_t event_mask
Definition: WellState.hpp:68
static WellState serializationTestObject(const ParallelWellInfo< Scalar > &pinfo)
std::size_t size() const
Definition: WellState.hpp:89
WellState(const PhaseUsageInfo< IndexTraits > &pu)
Definition: WellState.hpp:83
void updateStatus(int well_index, WellStatus status)
static void calculateSegmentRates(const ParallelWellInfo< Scalar > &pw_info, const std::vector< std::vector< int > > &segment_inlets, const std::vector< std::vector< int > > &segment_perforations, const std::vector< Scalar > &perforation_rates, const int np, const int segment, std::vector< Scalar > &segment_rates)
void updateEfficiencyScalingFactor(const std::string &wellName, const Scalar value)
const SingleWellState< Scalar, IndexTraits > & well(std::size_t well_index) const
Definition: WellState.hpp:290
const SingleWellState< Scalar, IndexTraits > & operator[](std::size_t well_index) const
Definition: WellState.hpp:270
bool isOpen(const std::string &name) const
Definition: WellState.hpp:197
bool wellIsOwned(const std::string &wellName) const
const std::vector< Scalar > & wellRates(std::size_t well_index) const
Definition: WellState.hpp:257
data::Wells report(const int *globalCellIdxMap, const std::function< bool(const int)> &wasDynamicallyClosed) const
std::vector< Scalar > & wellRates(std::size_t well_index)
One rate per well and phase.
Definition: WellState.hpp:255
void updateWellsDefaultALQ(const Schedule &schedule, const int report_step, const SummaryState &summary_state)
void serializeOp(Serializer &serializer)
Definition: WellState.hpp:318
SingleWellState< Scalar, IndexTraits > & operator[](const std::string &well_name)
Definition: WellState.hpp:285
std::optional< std::size_t > index(const std::string &well_name) const
Definition: WellState.hpp:265
void shutWell(int well_index)
void init(const std::vector< Scalar > &cellPressures, const std::vector< Scalar > &cellTemperatures, const Schedule &schedule, const std::vector< Well > &wells_ecl, const std::vector< std::reference_wrapper< ParallelWellInfo< Scalar > > > ¶llel_well_info, const int report_step, const WellState *prevState, const std::vector< std::vector< PerforationData< Scalar > > > &well_perf_data, const SummaryState &summary_state, const bool enableDistributedWells)
SingleWellState< Scalar, IndexTraits > & well(const std::string &well_name)
Definition: WellState.hpp:305
const std::string & name(std::size_t well_index) const
Definition: WellState.hpp:260
Dune::Communication< MPIComm > Communication
Definition: ParallelCommunication.hpp:30
Definition: blackoilboundaryratevector.hh:39
Static data associated with a well perforation.
Definition: PerforationData.hpp:30