113 using GLiftOptWells =
typename BlackoilWellModelGeneric::GLiftOptWells;
114 using GLiftProdWells =
typename BlackoilWellModelGeneric::GLiftProdWells;
115 using GLiftWellStateMap =
116 typename BlackoilWellModelGeneric::GLiftWellStateMap;
117 using GLiftEclWells =
typename GasLiftGroupInfo::GLiftEclWells;
118 using GLiftSyncGroups =
typename GasLiftSingleWellGeneric::GLiftSyncGroups;
120 typedef typename BaseAuxiliaryModule<TypeTag>::NeighborSet NeighborSet;
122 static const int numEq = Indices::numEq;
123 static const int solventSaturationIdx = Indices::solventSaturationIdx;
131 typedef Dune::FieldVector<Scalar, numEq > VectorBlockType;
132 typedef Dune::BlockVector<VectorBlockType> BVector;
139 SurfaceToReservoirVoidage<FluidSystem, std::vector<int> >;
143 AverageRegionalPressure<FluidSystem, std::vector<int> >;
155 unsigned numDofs()
const override
159 void addNeighbors(std::vector<NeighborSet>&
neighbors)
const override;
161 void applyInitial()
override
164 void linearize(SparseMatrixAdapter&
jacobian, GlobalEqVector&
res)
override;
167 void postSolve(GlobalEqVector&
deltaX)
override
169 recoverWellSolutionAndUpdateWellState(
deltaX);
174 recoverWellSolutionAndUpdateWellStateDomain(
deltaX,
domain);
181 template <
class Restarter>
191 template <
class Restarter>
200 beginReportStep(ebosSimulator_.episodeIndex());
203 void beginTimeStep();
205 void beginIteration()
207 OPM_TIMEBLOCK(beginIteration);
208 assemble(ebosSimulator_.model().newtonMethod().numIterations(),
209 ebosSimulator_.timeStepSize());
217 OPM_TIMEBLOCK(endTimeStep);
218 timeStepSucceeded(ebosSimulator_.time(), ebosSimulator_.timeStepSize());
226 void computeTotalRatesForDof(RateVector& rate,
227 unsigned globalIdx)
const;
229 template <
class Context>
230 void computeTotalRatesForDof(RateVector& rate,
231 const Context& context,
233 unsigned timeIdx)
const;
236 using WellInterfacePtr = std::shared_ptr<WellInterface<TypeTag> >;
238 using BlackoilWellModelGeneric::initFromRestartFile;
239 void initFromRestartFile(
const RestartValue& restartValues)
241 initFromRestartFile(restartValues,
242 this->ebosSimulator_.vanguard().transferWTestState(),
244 param_.use_multisegment_well_);
247 using BlackoilWellModelGeneric::prepareDeserialize;
248 void prepareDeserialize(
const int report_step)
250 prepareDeserialize(report_step, grid().size(0),
251 param_.use_multisegment_well_);
254 data::Wells wellData()
const
256 auto wsrpt = this->wellState()
257 .report(ebosSimulator_.vanguard().globalCell().data(),
258 [
this](
const int well_index) ->
bool
260 return this->wasDynamicallyShutThisTimeStep(well_index);
263 const auto& tracerRates = ebosSimulator_.problem().tracerModel().getWellTracerRates();
264 this->assignWellTracerRates(wsrpt, tracerRates);
267 BlackoilWellModelGuideRates(*this).assignWellGuideRates(wsrpt, this->reportStepIndex());
268 this->assignShutConnections(wsrpt, this->reportStepIndex());
273 data::WellBlockAveragePressures wellBlockAveragePressures()
const
275 return this->computeWellBlockAveragePressures();
279 void apply( BVector& r)
const;
282 void apply(
const BVector& x, BVector& Ax)
const;
285 void getWellContributions(WellContributions& x)
const;
288 void applyScaleAdd(
const Scalar alpha,
const BVector& x, BVector& Ax)
const;
291 ConvergenceReport getWellConvergence(
const std::vector<Scalar>& B_avg,
const bool checkWellGroupControls =
false)
const;
294 ConvergenceReport getDomainWellConvergence(
const Domain& domain,
295 const std::vector<Scalar>& B_avg)
const;
297 const SimulatorReportSingle& lastReport()
const;
299 void addWellContributions(SparseMatrixAdapter& jacobian)
const;
302 void addReservoirSourceTerms(GlobalEqVector& residual,
303 std::vector<typename SparseMatrixAdapter::MatrixBlock*>& diagMatAddress)
const;
306 void beginReportStep(
const int time_step);
316 void prepareTimeStep(DeferredLogger& deferred_logger);
317 void initPrimaryVariablesEvaluation()
const;
318 void initPrimaryVariablesEvaluationDomain(
const Domain& domain)
const;
320 std::pair<bool, bool>
321 updateWellControls(
const bool mandatory_network_balance, DeferredLogger& deferred_logger,
const bool relax_network_tolerance =
false);
323 void updateAndCommunicate(
const int reportStepIdx,
324 const int iterationIdx,
325 DeferredLogger& deferred_logger);
327 bool updateGroupControls(
const Group& group,
328 DeferredLogger& deferred_logger,
329 const int reportStepIdx,
330 const int iterationIdx);
332 WellInterfacePtr getWell(
const std::string& well_name)
const;
333 bool hasWell(
const std::string& well_name)
const;
335 using PressureMatrix = Dune::BCRSMatrix<Opm::MatrixBlock<double, 1, 1>>;
337 void addWellPressureEquations(PressureMatrix& jacobian,
const BVector& weights,
const bool use_well_weights)
const;
339 void addWellPressureEquationsStruct(PressureMatrix& jacobian)
const;
341 void initGliftEclWellMap(GLiftEclWells &ecl_well_map);
346 return well_container_;
356 void logPrimaryVars()
const;
357 std::vector<double> getPrimaryVarsDomain(
const Domain&
domain)
const;
358 void setPrimaryVarsDomain(
const Domain&
domain,
const std::vector<double>&
vars);
360 void setupDomains(
const std::vector<Domain>&
domains);
363 Simulator& ebosSimulator_;
366 std::vector<WellInterfacePtr> well_container_{};
368 std::vector<bool> is_cell_perforated_{};
370 void initializeWellState(
const int timeStepIdx);
373 void createWellContainer(
const int time_step)
override;
376 createWellPointer(
const int wellID,
377 const int time_step)
const;
379 template <
typename WellType>
380 std::unique_ptr<WellType>
381 createTypedWellPointer(
const int wellID,
382 const int time_step)
const;
384 WellInterfacePtr createWellForWellTest(
const std::string& well_name,
const int report_step, DeferredLogger& deferred_logger)
const;
387 const ModelParameters param_;
388 std::size_t global_num_cells_{};
390 std::size_t local_num_cells_{};
392 std::vector<double> depth_{};
393 bool alternative_well_rate_init_{};
395 std::unique_ptr<RateConverterType> rateConverter_{};
396 std::map<std::string, std::unique_ptr<AverageRegionalPressureType>> regionalAveragePressureCalculator_{};
400 std::optional<typename std::vector<WellInterfacePtr>::size_type> openWellIdx_{};
401 std::size_t wbpCalcIdx_{};
404 std::vector<WBPCalcID> wbpCalcMap_{};
410 void balanceNetwork(DeferredLogger& deferred_logger);
413 mutable BVector scaleAddRes_{};
415 std::vector<Scalar> B_avg_{};
418 std::map<std::string, int> well_domain_;
420 const Grid& grid()
const
421 {
return ebosSimulator_.vanguard().grid(); }
423 const EquilGrid& equilGrid()
const
424 {
return ebosSimulator_.vanguard().equilGrid(); }
426 const EclipseState& eclState()
const
427 {
return ebosSimulator_.vanguard().eclState(); }
431 void assemble(
const int iterationIdx,
438 std::pair<bool, bool> updateWellControlsAndNetworkIteration(
const bool mandatory_network_balance,
439 const bool relax_network_tolerance,
441 DeferredLogger& local_deferredLogger);
443 bool updateWellControlsAndNetwork(
const bool mandatory_network_balance,
445 DeferredLogger& local_deferredLogger);
456 const bool enableWellPIScaling);
464 void timeStepSucceeded(
const double simulationTime,
const double dt);
467 void endReportStep();
471 void recoverWellSolutionAndUpdateWellState(
const BVector& x);
475 void recoverWellSolutionAndUpdateWellStateDomain(
const BVector& x,
const Domain& domain);
478 void updatePrimaryVariables(DeferredLogger& deferred_logger);
480 void initializeWBPCalculationService();
482 data::WellBlockAveragePressures
483 computeWellBlockAveragePressures()
const;
486 makeWellSourceEvaluatorFactory(
const std::vector<Well>::size_type wellIdx)
const;
488 void registerOpenWellsForWBPCalculation();
490 void updateAverageFormationFactor();
492 void computePotentials(
const std::size_t widx,
493 const WellState& well_state_copy,
494 std::string& exc_msg,
495 ExceptionType::ExcEnum& exc_type,
496 DeferredLogger& deferred_logger)
override;
498 const std::vector<double>& wellPerfEfficiencyFactors()
const;
500 void calculateProductivityIndexValuesShutWells(
const int reportStepIdx, DeferredLogger& deferred_logger)
override;
501 void calculateProductivityIndexValues(DeferredLogger& deferred_logger)
override;
502 void calculateProductivityIndexValues(
const WellInterface<TypeTag>* wellPtr,
503 DeferredLogger& deferred_logger);
506 int numComponents()
const;
508 int reportStepIndex()
const;
510 void assembleWellEq(
const double dt, DeferredLogger& deferred_logger);
511 void assembleWellEqDomain(
const double dt,
const Domain& domain, DeferredLogger& deferred_logger);
513 void prepareWellsBeforeAssembling(
const double dt, DeferredLogger& deferred_logger);
516 void assembleWellEqWithoutIteration(
const double dt, DeferredLogger& deferred_logger);
518 bool maybeDoGasLiftOptimize(DeferredLogger& deferred_logger);
520 void gasLiftOptimizationStage1(DeferredLogger& deferred_logger,
521 GLiftProdWells &prod_wells, GLiftOptWells &glift_wells,
522 GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map);
525 void gasLiftOptimizationStage1SingleWell(WellInterface<TypeTag> *well,
526 DeferredLogger& deferred_logger,
527 GLiftProdWells &prod_wells, GLiftOptWells &glift_wells,
528 GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map,
529 GLiftSyncGroups& groups_to_sync);
531 void extractLegacyCellPvtRegionIndex_();
533 void extractLegacyDepth_();
536 void updateWellTestState(
const double& simulationTime, WellTestState& wellTestState)
const;
538 void wellTesting(
const int timeStepIdx,
const double simulationTime, DeferredLogger& deferred_logger);
540 void calcRates(
const int fipnum,
542 const std::vector<double>& production_rates,
543 std::vector<double>& resv_coeff)
override;
545 void calcInjRates(
const int fipnum,
547 std::vector<double>& resv_coeff)
override;
549 void computeWellTemperature();