RescoupSendSlaveGroupData.hpp
Go to the documentation of this file.
1/*
2 Copyright 2025 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_RESCOUP_SEND_SLAVE_GROUP_DATA_HPP
21#define OPM_RESCOUP_SEND_SLAVE_GROUP_DATA_HPP
22
28
29namespace Opm {
30
49template<class Scalar, class IndexTraits>
51public:
58
64 const WellState<Scalar, IndexTraits>& nupcol_well_state);
65
68 const Parallel::Communication& comm() const { return this->groupStateHelper_.comm(); }
69
86private:
90 Potentials collectSlaveGroupPotentials_(std::size_t group_idx) const;
91
95 SlaveGroupInjectionData collectSlaveGroupInjectionData_(std::size_t group_idx) const;
96
100 SlaveGroupProductionData collectSlaveGroupProductionData_(std::size_t group_idx) const;
101
105 Scalar collectSlaveGroupReinjectionRateForGasPhase_(std::size_t group_idx) const;
106
111 Scalar collectSlaveGroupGasLiftRate_(std::size_t group_idx, bool network) const;
112
118 ProductionRates collectSlaveGroupSurfaceProductionRates_(std::size_t group_idx) const;
119
125 ProductionRates collectSlaveGroupNetworkSurfaceProductionRates_(std::size_t group_idx) const;
126
132 ProductionRates collectSlaveGroupReservoirProductionRates_(std::size_t group_idx) const;
133
137 Scalar collectSlaveGroupVoidageRate_(std::size_t group_idx) const;
138
148 void collectSlaveGroupSummaryProductionData_(std::size_t group_idx,
149 SlaveGroupProductionData& production_data) const;
150
155 void collectSlaveGroupSummaryInjectionData_(std::size_t group_idx,
156 SlaveGroupInjectionData& injection_data) const;
157
167 template <typename Visitor>
168 void visitGroupWells_(const Group& group, Scalar efficiency, const Visitor& visit) const;
169
171 int activePhaseIdx_(ReservoirCoupling::Phase phase) const;
172
176 InjectionRates createInjectionRatesFromRateVector_(const std::vector<Scalar>& rate_vector) const;
177
182 void sendSlaveGroupProductionDataToMaster_() const;
183
188 void sendSlaveGroupInjectionDataToMaster_() const;
189
203 ProductionRates unsolvedNewWellProductionRates_(const std::string& group_name, bool network) const;
204
206 const GroupStateHelperType& groupStateHelper_;
207
209 const WellState<Scalar, IndexTraits>& nupcol_well_state_;
210
212 ReservoirCouplingSlave<Scalar>& reservoir_coupling_slave_;
213
215 const Schedule& schedule_;
216
218 const GroupState<Scalar>& group_state_;
219
221 const PhaseUsageInfo<IndexTraits>& phase_usage_;
222
224 const int report_step_idx_;
225};
226
227} // namespace Opm
228
229#endif // OPM_RESCOUP_SEND_SLAVE_GROUP_DATA_HPP
Definition: GroupStateHelper.hpp:57
const Parallel::Communication & comm() const
Definition: GroupStateHelper.hpp:254
Definition: GroupState.hpp:42
Definition: GasLiftGroupInfo.hpp:40
Collects and sends group data from slave process to master in reservoir coupling.
Definition: RescoupSendSlaveGroupData.hpp:50
void sendSlaveGroupDataToMaster()
Collect and send group data to the master process.
RescoupSendSlaveGroupData(GroupStateHelperType &groupStateHelper, const WellState< Scalar, IndexTraits > &nupcol_well_state)
Construct a sender for slave group data.
const Parallel::Communication & comm() const
Get the communication object.
Definition: RescoupSendSlaveGroupData.hpp:68
Definition: ReservoirCouplingSlave.hpp:40
Definition: WellState.hpp:68
Dune::Communication< MPIComm > Communication
Definition: ParallelCommunication.hpp:30
Phase
Phase indices for reservoir coupling, we currently only support black-oil phases (oil,...
Definition: ReservoirCoupling.hpp:184
Definition: blackoilbioeffectsmodules.hh:45
Definition: ReservoirCoupling.hpp:205
Definition: ReservoirCoupling.hpp:215
Definition: ReservoirCoupling.hpp:223
Definition: ReservoirCoupling.hpp:285
Definition: ReservoirCoupling.hpp:239