My Project
Loading...
Searching...
No Matches
ParallelWBPCalculation.hpp
1/*
2 Copyright 2023 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 PARALLEL_WBP_CALCULATION_HPP
21#define PARALLEL_WBP_CALCULATION_HPP
22
23#include <opm/simulators/wells/ParallelPAvgDynamicSourceData.hpp>
24
25#include <opm/simulators/utils/ParallelCommunication.hpp>
26
27#include <opm/simulators/wells/PerforationData.hpp>
28
29#include <opm/input/eclipse/Schedule/Well/PAvgCalculator.hpp>
30#include <opm/input/eclipse/Schedule/Well/PAvgCalculatorCollection.hpp>
31
32#include <cstddef>
33#include <functional>
34#include <memory>
35#include <vector>
36
37namespace Opm {
38 class GridDims;
39 template<class Scalar> class ParallelWellInfo;
40 class PAvg;
41 class Well;
42}
43
44namespace Opm {
45
49template<class Scalar>
51{
52public:
56
59
63 using EvaluatorFactory = std::function<Evaluator()>;
64
70 explicit ParallelWBPCalculation(const GridDims& cellIndexMap,
71 const Parallel::Communication& gridComm);
72
81
89
114 std::size_t
115 createCalculator(const Well& well,
116 const ParallelWellInfo<Scalar>& parallelWellInfo,
117 const std::vector<int>& localConnIdx,
118 EvaluatorFactory makeWellSourceEvaluator);
119
126 void defineCommunication();
127
141
154 void inferBlockAveragePressures(const std::size_t calcIndex,
155 const PAvg& controls,
156 const Scalar gravity,
157 const Scalar refDepth);
158
167 const typename PAvgCalculator<Scalar>::Result&
168 averagePressures(const std::size_t calcIndex) const;
169
170private:
172 class LocalConnSet
173 {
174 public:
185 explicit LocalConnSet(const std::vector<int>& localConnIdx);
186
195 int localIndex(const std::size_t connIdx) const;
196
197 private:
206 std::vector<int> localConnIdx_{};
207 };
208
210 class SourceData
211 {
212 public:
217 operator const ParallelPAvgDynamicSourceData<Scalar>&() const
218 {
219 return *this->srcData_;
220 }
221
225 explicit SourceData(const Parallel::Communication& comm);
226
234 SourceData& localIndex(GlobalToLocal localIdx);
235
242 SourceData& evaluator(Evaluator eval);
243
252 SourceData& evaluatorFactory(EvaluatorFactory evalFactory);
253
263 void buildStructure(const std::vector<std::size_t>& sourceLocations);
264
274 void collectDynamicValues();
275
279 const Parallel::Communication& comm() const
280 {
281 return this->comm_.get();
282 }
283
293 std::vector<int>
294 getLocalIndex(const std::vector<std::size_t>& globalIndex) const;
295
296 private:
298 using DataPtr = std::unique_ptr<ParallelPAvgDynamicSourceData<Scalar>>;
299
301 std::reference_wrapper<const Parallel::Communication> comm_;
302
304 GlobalToLocal localIdx_{};
305
308 Evaluator eval_{};
309
313 EvaluatorFactory evalFactory_{};
314
316 DataPtr srcData_{};
317 };
318
320 using WellID = typename std::vector<SourceData>::size_type;
321
323 std::reference_wrapper<const GridDims> cellIndexMap_;
324
326 SourceData reservoirSrc_;
327
330 PAvgCalculatorCollection<Scalar> calculators_{};
331
333 std::vector<SourceData> wellConnSrc_{};
334
336 std::vector<LocalConnSet> localConnSet_{};
337
340 void pruneInactiveWBPCells();
341
343 void pruneInactiveWBPCellsSerial();
344
346 void pruneInactiveWBPCellsParallel();
347
349 void defineReservoirCommunication();
350
355 void defineWellCommunication(const std::size_t well);
356
364 typename PAvgCalculator<Scalar>::Sources
365 makeEvaluationSources(const WellID well) const;
366};
367
368} // namespace Opm
369
370#endif // PARALLEL_WBP_CALCULATION_HPP
std::function< void(int, SourceDataSpan< Scalar >)> Evaluator
Collect source term contributions from local, on-rank, cell.
Definition ParallelPAvgDynamicSourceData.hpp:54
std::function< int(const std::size_t)> GlobalToLocal
Translate globally unique, linearised Cartesian cell indices to local, on-rank, cell indices.
Definition ParallelPAvgDynamicSourceData.hpp:42
Parallel facility for managing the on-rank collection and global distribution of WBPn source values a...
Definition ParallelWBPCalculation.hpp:51
void inferBlockAveragePressures(const std::size_t calcIndex, const PAvg &controls, const Scalar gravity, const Scalar refDepth)
Compute WBPn report values for a single well.
Definition ParallelWBPCalculation.cpp:251
const PAvgCalculator< Scalar >::Result & averagePressures(const std::size_t calcIndex) const
Retrieve results from most recent WBPn value calculation for specified well.
Definition ParallelWBPCalculation.cpp:264
std::size_t createCalculator(const Well &well, const ParallelWellInfo< Scalar > &parallelWellInfo, const std::vector< int > &localConnIdx, EvaluatorFactory makeWellSourceEvaluator)
Create, or reassign, a WBPn calculation object for a particular well.
Definition ParallelWBPCalculation.cpp:189
ParallelWBPCalculation(const GridDims &cellIndexMap, const Parallel::Communication &gridComm)
Constructor.
Definition ParallelWBPCalculation.cpp:163
void defineCommunication()
Set up communication patterns for both cell and connection level source terms and partial/intermediat...
Definition ParallelWBPCalculation.cpp:224
typename ParallelPAvgDynamicSourceData< Scalar >::GlobalToLocal GlobalToLocal
Callback for inferring the source locations which are active on the current MPI rank.
Definition ParallelWBPCalculation.hpp:55
ParallelWBPCalculation & evalCellSource(Evaluator evalCellSrc)
Assign evaluation function for computing the on-rank, cell level WBPn source terms.
Definition ParallelWBPCalculation.cpp:181
typename ParallelPAvgDynamicSourceData< Scalar >::Evaluator Evaluator
Callback for evaluating WBPn source terms on the current MPI rank.
Definition ParallelWBPCalculation.hpp:58
std::function< Evaluator()> EvaluatorFactory
Callback for constructing a source term evaluation function on the current MPI rank.
Definition ParallelWBPCalculation.hpp:63
ParallelWBPCalculation & localCellIndex(GlobalToLocal localCellIdx)
Assign translation function for inferring the on-rank IDs of the known source locations.
Definition ParallelWBPCalculation.cpp:172
void collectDynamicValues()
Collect all on-rank source term value and distribute those on-rank values to all other MPI ranks.
Definition ParallelWBPCalculation.cpp:240
Class encapsulating some information about parallel wells.
Definition WGState.hpp:31
This file contains a set of helper functions used by VFPProd / VFPInj.
Definition blackoilboundaryratevector.hh:37