BlackoilWellModel.hpp
Go to the documentation of this file.
123 constexpr static std::size_t pressureVarIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx;
297 ConvergenceReport getWellConvergence(const std::vector<Scalar>& B_avg, const bool checkWellGroupControls = false) const;
315 // it should be able to go to prepareTimeStep(), however, the updateWellControls() and initPrimaryVariablesEvaluation()
316 // makes it a little more difficult. unless we introduce if (iterationIdx != 0) to avoid doing the above functions
328 updateWellControls(const bool mandatory_network_balance, DeferredLogger& deferred_logger, const bool relax_network_tolerance = false);
344 void addWellPressureEquations(PressureMatrix& jacobian, const BVector& weights,const bool use_well_weights) const;
391 WellInterfacePtr createWellForWellTest(const std::string& well_name, const int report_step, DeferredLogger& deferred_logger) const;
403 std::map<std::string, std::unique_ptr<AverageRegionalPressureType>> regionalAveragePressureCalculator_{};
415 // Pre-step network solve at static reservoir conditions (group and well states might be updated)
443 // the returned two booleans are {continue_due_to_network, well_group_control_changed}, respectively
444 std::pair<bool, bool> updateWellControlsAndNetworkIteration(const bool mandatory_network_balance,
506 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger& deferred_logger) override;
517 void assembleWellEqDomain(const double dt, const Domain& domain, DeferredLogger& deferred_logger);
544 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger& deferred_logger);
Class for handling the blackoil well model. Definition: BlackoilWellModelGeneric.hpp:83 void assignWellTracerRates(data::Wells &wsrpt, const WellTracerRates &wellTracerRates) const void assignShutConnections(data::Wells &wsrpt, const int reportStepIndex) const const WellState< GetPropType< TypeTag, Properties::Scalar > > & wellState() const Definition: BlackoilWellModelGeneric.hpp:124 std::map< std::string, const WellInterfaceGeneric * > GLiftProdWells Definition: BlackoilWellModelGeneric.hpp:87 WellTestState & wellTestState() Definition: BlackoilWellModelGeneric.hpp:147 std::map< std::string, std::unique_ptr< GasLiftSingleWellGeneric > > GLiftOptWells Definition: BlackoilWellModelGeneric.hpp:86 std::map< std::string, std::unique_ptr< GasLiftWellState > > GLiftWellStateMap Definition: BlackoilWellModelGeneric.hpp:88 Class for handling the guide rates in the blackoil well model. Definition: BlackoilWellModelGuideRates.hpp:46 void assignWellGuideRates(data::Wells &wsrpt, const int reportStepIdx) const Assign well guide rates. Class for handling the blackoil well model. Definition: BlackoilWellModel.hpp:101 ParallelWBPCalculation::EvaluatorFactory makeWellSourceEvaluatorFactory(const std::vector< Well >::size_type wellIdx) const Definition: BlackoilWellModel_impl.hpp:2074 void initializeGroupStructure(const int reportStepIdx) Definition: BlackoilWellModel_impl.hpp:345 void apply(BVector &r) const Definition: BlackoilWellModel_impl.hpp:1543 void prepareTimeStep(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:2339 bool updateGroupControls(const Group &group, DeferredLogger &deferred_logger, const int reportStepIdx, const int iterationIdx) Definition: BlackoilWellModel_impl.hpp:2168 void serialize(Restarter &) This method writes the complete state of the well to the harddisk. Definition: BlackoilWellModel.hpp:196 BlackOilMICPModule< TypeTag > MICPModule Definition: BlackoilWellModel.hpp:139 void calcRates(const int fipnum, const int pvtreg, const std::vector< Scalar > &production_rates, std::vector< Scalar > &resv_coeff) override Definition: BlackoilWellModel_impl.hpp:2534 WellInterfacePtr createWellPointer(const int wellID, const int report_step) const Definition: BlackoilWellModel_impl.hpp:982 const EclipseState & eclState() const Definition: BlackoilWellModel.hpp:432 WellInterfacePtr getWell(const std::string &well_name) const Definition: BlackoilWellModel_impl.hpp:2490 BlackOilPolymerModule< TypeTag > PolymerModule Definition: BlackoilWellModel.hpp:138 const std::vector< WellInterfacePtr > & localNonshutWells() const Get list of local nonshut wells. Definition: BlackoilWellModel.hpp:351 void prepareDeserialize(const int report_step) Definition: BlackoilWellModel.hpp:252 typename BlackoilWellModelGeneric< Scalar >::GLiftProdWells GLiftProdWells Definition: BlackoilWellModel.hpp:118 void updateAndCommunicate(const int reportStepIdx, const int iterationIdx, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:2146 std::size_t global_num_cells_ Definition: BlackoilWellModel.hpp:395 typename GasLiftSingleWellGeneric::GLiftSyncGroups GLiftSyncGroups Definition: BlackoilWellModel.hpp:122 void doPreStepNetworkRebalance(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1060 GetPropType< TypeTag, Properties::Scalar > Scalar Definition: BlackoilWellModel.hpp:112 SimulatorReportSingle last_report_ Definition: BlackoilWellModel.hpp:413 void postSolveDomain(GlobalEqVector &deltaX, const Domain &domain) Definition: BlackoilWellModel.hpp:176 std::vector< Scalar > getPrimaryVarsDomain(const Domain &domain) const Definition: BlackoilWellModel_impl.hpp:2632 static const int solventSaturationIdx Definition: BlackoilWellModel.hpp:127 std::vector< WBPCalcID > wbpCalcMap_ Definition: BlackoilWellModel.hpp:411 void initWellContainer(const int reportStepIdx) override Definition: BlackoilWellModel_impl.hpp:164 void addReservoirSourceTerms(GlobalEqVector &residual, std::vector< typename SparseMatrixAdapter::MatrixBlock * > &diagMatAddress) const Definition: BlackoilWellModel_impl.hpp:1650 void beginReportStep(const int time_step) Definition: BlackoilWellModel_impl.hpp:248 typename WellInterface< TypeTag >::GasLiftSingleWell GasLiftSingleWell Definition: BlackoilWellModel.hpp:116 GetPropType< TypeTag, Properties::FluidSystem > FluidSystem Definition: BlackoilWellModel.hpp:108 void assembleWellEqDomain(const double dt, const Domain &domain, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1500 void applyScaleAdd(const Scalar alpha, const BVector &x, BVector &Ax) const Definition: BlackoilWellModel_impl.hpp:1604 void initFromRestartFile(const RestartValue &restartValues) Definition: BlackoilWellModel.hpp:243 void gasLiftOptimizationStage1SingleWell(WellInterface< TypeTag > *well, DeferredLogger &deferred_logger, GLiftProdWells &prod_wells, GLiftOptWells &glift_wells, GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map, GLiftSyncGroups &groups_to_sync) Definition: BlackoilWellModel_impl.hpp:1451 GetPropType< TypeTag, Properties::ElementContext > ElementContext Definition: BlackoilWellModel.hpp:109 GetPropType< TypeTag, Properties::Grid > Grid Definition: BlackoilWellModel.hpp:106 void updateWellControlsDomain(DeferredLogger &deferred_logger, const Domain &domain) Definition: BlackoilWellModel_impl.hpp:1977 GetPropType< TypeTag, Properties::EquilGrid > EquilGrid Definition: BlackoilWellModel.hpp:107 void assembleWellEq(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1489 void postSolve(GlobalEqVector &deltaX) override Definition: BlackoilWellModel.hpp:171 void linearizeDomain(const Domain &domain, SparseMatrixAdapter &jacobian, GlobalEqVector &res) Definition: BlackoilWellModel_impl.hpp:225 BaseAuxiliaryModule< TypeTag >::NeighborSet NeighborSet Definition: BlackoilWellModel.hpp:124 static constexpr bool has_polymer_ Definition: BlackoilWellModel.hpp:129 int reportStepIndex() const Definition: BlackoilWellModel_impl.hpp:2522 void calculateProductivityIndexValues(DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2280 void extractLegacyDepth_() Definition: BlackoilWellModel_impl.hpp:2478 void extractLegacyCellPvtRegionIndex_() Definition: BlackoilWellModel_impl.hpp:2445 void updateAverageFormationFactor() Definition: BlackoilWellModel_impl.hpp:2386 GetPropType< TypeTag, Properties::Simulator > Simulator Definition: BlackoilWellModel.hpp:111 void calcInjRates(const int fipnum, const int pvtreg, std::vector< Scalar > &resv_coeff) override Definition: BlackoilWellModel_impl.hpp:2545 void initializeWellState(const int timeStepIdx) Definition: BlackoilWellModel_impl.hpp:803 void assemble(const int iterationIdx, const double dt) Definition: BlackoilWellModel_impl.hpp:1099 void computeWellTemperature() Definition: BlackoilWellModel_impl.hpp:2556 void addWellPressureEquations(PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights) const Definition: BlackoilWellModel_impl.hpp:1634 void logPrimaryVars() const Definition: BlackoilWellModel_impl.hpp:2613 const SimulatorReportSingle & lastReport() const Definition: BlackoilWellModel_impl.hpp:654 bool updateWellControlsAndNetwork(const bool mandatory_network_balance, const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1159 GetPropType< TypeTag, Properties::SparseMatrixAdapter > SparseMatrixAdapter Definition: BlackoilWellModel.hpp:115 void addWellContributions(SparseMatrixAdapter &jacobian) const Definition: BlackoilWellModel_impl.hpp:1624 const EquilGrid & equilGrid() const Definition: BlackoilWellModel.hpp:429 WellInterfacePtr createWellForWellTest(const std::string &well_name, const int report_step, DeferredLogger &deferred_logger) const Definition: BlackoilWellModel_impl.hpp:1033 std::map< std::string, int > well_domain_ Definition: BlackoilWellModel.hpp:424 void deserialize(Restarter &) Definition: BlackoilWellModel.hpp:186 GetPropType< TypeTag, Properties::Indices > Indices Definition: BlackoilWellModel.hpp:110 typename BlackoilWellModelGeneric< Scalar >::GLiftOptWells GLiftOptWells Definition: BlackoilWellModel.hpp:117 void computePotentials(const std::size_t widx, const WellState< Scalar > &well_state_copy, std::string &exc_msg, ExceptionType::ExcEnum &exc_type, DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2245 std::pair< bool, bool > updateWellControls(const bool mandatory_network_balance, DeferredLogger &deferred_logger, const bool relax_network_tolerance=false) Definition: BlackoilWellModel_impl.hpp:1889 void recoverWellSolutionAndUpdateWellStateDomain(const BVector &x, const Domain &domain) Definition: BlackoilWellModel_impl.hpp:1722 void applyInitial() override Definition: BlackoilWellModel.hpp:165 void assembleDomain(const int iterationIdx, const double dt, const Domain &domain) Definition: BlackoilWellModel_impl.hpp:1247 bool hasWell(const std::string &well_name) const Definition: BlackoilWellModel_impl.hpp:2507 void assembleWellEqWithoutIteration(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1524 data::WellBlockAveragePressures computeWellBlockAveragePressures() const Definition: BlackoilWellModel_impl.hpp:2028 std::vector< WellInterfacePtr > well_container_ Definition: BlackoilWellModel.hpp:373 static constexpr std::size_t pressureVarIndex Definition: BlackoilWellModel.hpp:123 typename GasLiftGroupInfo::GLiftEclWells GLiftEclWells Definition: BlackoilWellModel.hpp:121 void initPrimaryVariablesEvaluation() const Definition: BlackoilWellModel_impl.hpp:1747 Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > > PressureMatrix Definition: BlackoilWellModel.hpp:342 void computeTotalRatesForDof(RateVector &rate, unsigned globalIdx) const Definition: BlackoilWellModel_impl.hpp:766 unsigned numDofs() const override Definition: BlackoilWellModel.hpp:159 const std::vector< Scalar > & wellPerfEfficiencyFactors() const GetPropType< TypeTag, Properties::RateVector > RateVector Definition: BlackoilWellModel.hpp:113 void calculateExplicitQuantities(DeferredLogger &deferred_logger) const Definition: BlackoilWellModel_impl.hpp:1874 std::map< std::string, std::unique_ptr< AverageRegionalPressureType > > regionalAveragePressureCalculator_ Definition: BlackoilWellModel.hpp:403 Dune::FieldVector< Scalar, numEq > VectorBlockType Definition: BlackoilWellModel.hpp:135 void updatePrimaryVariables(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:2435 GetPropType< TypeTag, Properties::GlobalEqVector > GlobalEqVector Definition: BlackoilWellModel.hpp:114 void initializeLocalWellStructure(const int reportStepIdx, const bool enableWellPIScaling) Definition: BlackoilWellModel_impl.hpp:300 static constexpr bool has_solvent_ Definition: BlackoilWellModel.hpp:128 std::pair< bool, bool > updateWellControlsAndNetworkIteration(const bool mandatory_network_balance, const bool relax_network_tolerance, const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1195 void addNeighbors(std::vector< NeighborSet > &neighbors) const override Definition: BlackoilWellModel_impl.hpp:180 static constexpr bool has_micp_ Definition: BlackoilWellModel.hpp:131 std::unique_ptr< RateConverterType > rateConverter_ Definition: BlackoilWellModel.hpp:402 BlackoilWellModel(Simulator &simulator) Definition: BlackoilWellModel_impl.hpp:137 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:587 std::vector< bool > is_cell_perforated_ Definition: BlackoilWellModel.hpp:375 ConvergenceReport getWellConvergence(const std::vector< Scalar > &B_avg, const bool checkWellGroupControls=false) const Definition: BlackoilWellModel_impl.hpp:1821 void registerOpenWellsForWBPCalculation() Definition: BlackoilWellModel_impl.hpp:2125 void linearize(SparseMatrixAdapter &jacobian, GlobalEqVector &res) override Definition: BlackoilWellModel_impl.hpp:204 data::WellBlockAveragePressures wellBlockAveragePressures() const Definition: BlackoilWellModel.hpp:277 std::size_t local_num_cells_ Definition: BlackoilWellModel.hpp:397 void initGliftEclWellMap(GLiftEclWells &ecl_well_map) Definition: BlackoilWellModel_impl.hpp:1477 void gasLiftOptimizationStage1(DeferredLogger &deferred_logger, GLiftProdWells &prod_wells, GLiftOptWells &glift_wells, GasLiftGroupInfo &group_info, GLiftWellStateMap &state_map) Definition: BlackoilWellModel_impl.hpp:1345 bool alternative_well_rate_init_ Definition: BlackoilWellModel.hpp:400 void timeStepSucceeded(const double simulationTime, const double dt) Definition: BlackoilWellModel_impl.hpp:664 std::unique_ptr< WellType > createTypedWellPointer(const int wellID, const int time_step) const Definition: BlackoilWellModel_impl.hpp:1002 void setPrimaryVarsDomain(const Domain &domain, const std::vector< Scalar > &vars) Definition: BlackoilWellModel_impl.hpp:2649 std::shared_ptr< WellInterface< TypeTag > > WellInterfacePtr Definition: BlackoilWellModel.hpp:240 void createWellContainer(const int report_step) override Definition: BlackoilWellModel_impl.hpp:841 Dune::BlockVector< VectorBlockType > BVector Definition: BlackoilWellModel.hpp:136 bool maybeDoGasLiftOptimize(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1287 void updateWellTestState(const double &simulationTime, WellTestState &wellTestState) const upate the wellTestState related to economic limits Definition: BlackoilWellModel_impl.hpp:2206 ConvergenceReport getDomainWellConvergence(const Domain &domain, const std::vector< Scalar > &B_avg, DeferredLogger &local_deferredLogger) const Definition: BlackoilWellModel_impl.hpp:1775 void initializeWBPCalculationService() Definition: BlackoilWellModel_impl.hpp:2000 int compressedIndexForInterior(int cartesian_cell_idx) const override get compressed index for interior cells (-1, otherwise Definition: BlackoilWellModel.hpp:557 void initPrimaryVariablesEvaluationDomain(const Domain &domain) const Definition: BlackoilWellModel_impl.hpp:1758 static constexpr bool has_energy_ Definition: BlackoilWellModel.hpp:130 void recoverWellSolutionAndUpdateWellState(const BVector &x) Definition: BlackoilWellModel_impl.hpp:1703 void setupDomains(const std::vector< Domain > &domains) Definition: BlackoilWellModel_impl.hpp:2666 void addWellPressureEquationsStruct(PressureMatrix &jacobian) const Definition: BlackoilWellModel_impl.hpp:1680 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2294 void prepareWellsBeforeAssembling(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1513 typename BlackoilWellModelGeneric< Scalar >::GLiftWellStateMap GLiftWellStateMap Definition: BlackoilWellModel.hpp:120 int numComponents() const Definition: BlackoilWellModel_impl.hpp:2461 Definition: ConvergenceReport.hpp:38 Definition: DeferredLogger.hpp:57 Definition: GasLiftGroupInfo.hpp:45 std::map< std::string, std::pair< const Well *, int > > GLiftEclWells Definition: GasLiftGroupInfo.hpp:68 std::set< int > GLiftSyncGroups Definition: GasLiftSingleWellGeneric.hpp:58 Definition: GasLiftSingleWell.hpp:38 std::function< Evaluator()> EvaluatorFactory Definition: ParallelWBPCalculation.hpp:62 Definition: RateConverter.hpp:70 Definition: RegionAverageCalculator.hpp:65 Definition: WellContributions.hpp:52 Definition: WellInterface.hpp:75 Definition: WellState.hpp:62 data::Wells report(const int *globalCellIdxMap, const std::function< bool(const int)> &wasDynamicallyClosed) const Definition: AluGridVanguard.hpp:57 Definition: BlackoilPhases.hpp:27 Solver parameters for the BlackoilModel. Definition: BlackoilModelParameters.hpp:484 bool use_multisegment_well_ Definition: BlackoilModelParameters.hpp:570 Definition: BlackoilWellModel.hpp:406 std::optional< typename std::vector< WellInterfacePtr >::size_type > openWellIdx_ Definition: BlackoilWellModel.hpp:407 std::size_t wbpCalcIdx_ Definition: BlackoilWellModel.hpp:408 Definition: BlackoilPhases.hpp:46 Definition: BlackoilWellModel.hpp:84 UndefinedProperty type Definition: BlackoilWellModel.hpp:85 A struct for returning timing data from a simulator to its caller. Definition: SimulatorReport.hpp:34 Definition: SubDomain.hpp:62 |