BlackoilWellModel.hpp
Go to the documentation of this file.
99 class BlackoilWellModel : public WellConnectionAuxiliaryModule<TypeTag, BlackoilWellModel<TypeTag>>
117 using WellConnectionModule = WellConnectionAuxiliaryModule<TypeTag, BlackoilWellModel<TypeTag>>;
121 constexpr static std::size_t pressureVarIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx;
258 ConvergenceReport getWellConvergence(const std::vector<Scalar>& B_avg, const bool checkWellGroupControls = false) const;
272 // makes it a little more difficult. unless we introduce if (iterationIdx != 0) to avoid doing the above function
285 updateNetworks(const bool mandatory_network_balance, DeferredLogger& deferred_logger, const bool relax_network_tolerance = false);
357 int compressedIndexForInteriorLGR(const std::string& lgr_tag, const Connection& conn) const override
437 std::map<std::string, std::unique_ptr<AverageRegionalPressureType>> regionalAveragePressureCalculator_{};
442 // Pre-step network solve at static reservoir conditions (group and well states might be updated)
461 // the returned two booleans are {continue_due_to_network, well_group_control_changed}, respectively
462 std::tuple<bool, bool, Scalar> updateWellControlsAndNetworkIteration(const bool mandatory_network_balance,
509 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger& deferred_logger) override;
533 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger& deferred_logger);
Contains the high level supplements required to extend the black oil model by MICP. Definition: blackoilmicpmodules.hh:54 Contains the high level supplements required to extend the black oil model by polymer. Definition: blackoilpolymermodules.hh:64 Class for handling the gaslift in the blackoil well model. Definition: BlackoilWellModelGasLift.hpp:96 Class for handling the blackoil well model. Definition: BlackoilWellModelGeneric.hpp:95 void assignDynamicWellStatus(data::Wells &wsrpt) const void assignWellTargets(data::Wells &wsrpt) const BlackoilWellModelWBP< GetPropType< TypeTag, Properties::Scalar >, GetPropType< TypeTag, Properties::FluidSystem >::IndexTraitsType > wbp_ Definition: BlackoilWellModelGeneric.hpp:517 WellTestState & wellTestState() Definition: BlackoilWellModelGeneric.hpp:175 void assignShutConnections(data::Wells &wsrpt, const int reportStepIndex) const const WellState< GetPropType< TypeTag, Properties::Scalar >, GetPropType< TypeTag, Properties::FluidSystem >::IndexTraitsType > & wellState() const Definition: BlackoilWellModelGeneric.hpp:152 void assignMassGasRate(data::Wells &wsrpt, const GetPropType< TypeTag, Properties::Scalar > gasDensity) const 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 in a NLDD solver. Definition: BlackoilWellModelNldd.hpp:80 Class for handling the blackoil well model. Definition: BlackoilWellModel.hpp:102 void setReservoirCouplingSlave(ReservoirCouplingSlave *slave) Definition: BlackoilWellModel.hpp:397 void initializeGroupStructure(const int reportStepIdx) Definition: BlackoilWellModel_impl.hpp:290 void prepareTimeStep(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:2126 std::tuple< bool, bool, Scalar > updateWellControlsAndNetworkIteration(const bool mandatory_network_balance, const bool relax_network_tolerance, const bool optimize_gas_lift, const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1240 bool updateGroupControls(const Group &group, DeferredLogger &deferred_logger, const int reportStepIdx, const int iterationIdx) Definition: BlackoilWellModel_impl.hpp:1930 WellInterfacePtr createWellPointer(const int wellID, const int report_step) const Definition: BlackoilWellModel_impl.hpp:1016 GuideRateHandler< Scalar, IndexTraits > guide_rate_handler_ Definition: BlackoilWellModel.hpp:440 const EclipseState & eclState() const Definition: BlackoilWellModel.hpp:450 WellInterfacePtr getWell(const std::string &well_name) const Definition: BlackoilWellModel_impl.hpp:2272 void calcInjResvCoeff(const int fipnum, const int pvtreg, std::vector< Scalar > &resv_coeff) override Definition: BlackoilWellModel_impl.hpp:2312 const std::vector< WellInterfacePtr > & localNonshutWells() const Get list of local nonshut wells. Definition: BlackoilWellModel.hpp:320 void prepareDeserialize(const int report_step) Definition: BlackoilWellModel.hpp:205 void setNlddAdapter(BlackoilWellModelNldd< TypeTag > *mod) Definition: BlackoilWellModel.hpp:377 void calcResvCoeff(const int fipnum, const int pvtreg, const std::vector< Scalar > &production_rates, std::vector< Scalar > &resv_coeff) override Definition: BlackoilWellModel_impl.hpp:2301 const Simulator & simulator() const Definition: BlackoilWellModel.hpp:374 void updateAndCommunicate(const int reportStepIdx, const int iterationIdx, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1894 std::size_t global_num_cells_ Definition: BlackoilWellModel.hpp:429 std::map< std::string, Scalar > well_group_thp_calc_ Definition: BlackoilWellModel.hpp:435 void doPreStepNetworkRebalance(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1092 GetPropType< TypeTag, Properties::Scalar > Scalar Definition: BlackoilWellModel.hpp:111 SimulatorReportSingle last_report_ Definition: BlackoilWellModel.hpp:439 static const int solventSaturationIdx Definition: BlackoilWellModel.hpp:124 void initWellContainer(const int reportStepIdx) override Definition: BlackoilWellModel_impl.hpp:176 void beginReportStep(const int time_step) Definition: BlackoilWellModel_impl.hpp:193 GetPropType< TypeTag, Properties::FluidSystem > FluidSystem Definition: BlackoilWellModel.hpp:107 bool isReservoirCouplingMaster() const Definition: BlackoilWellModel.hpp:387 Dune::FieldVector< Scalar, numEq > VectorBlockType Definition: BlackoilWellModel.hpp:132 void initFromRestartFile(const RestartValue &restartValues) Definition: BlackoilWellModel.hpp:195 GetPropType< TypeTag, Properties::ElementContext > ElementContext Definition: BlackoilWellModel.hpp:108 GetPropType< TypeTag, Properties::Grid > Grid Definition: BlackoilWellModel.hpp:105 GetPropType< TypeTag, Properties::EquilGrid > EquilGrid Definition: BlackoilWellModel.hpp:106 int numConservationQuantities() const Definition: BlackoilWellModel_impl.hpp:2244 void assembleWellEq(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1486 const std::map< std::string, int > & well_domain() const Definition: BlackoilWellModel.hpp:333 void setReservoirCouplingMaster(ReservoirCouplingMaster *master) Definition: BlackoilWellModel.hpp:393 bool updateWellControls(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1756 static constexpr bool has_polymer_ Definition: BlackoilWellModel.hpp:126 int reportStepIndex() const Definition: BlackoilWellModel_impl.hpp:2289 void calculateProductivityIndexValues(DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2068 void extractLegacyDepth_() Definition: BlackoilWellModel_impl.hpp:2260 void extractLegacyCellPvtRegionIndex_() Definition: BlackoilWellModel_impl.hpp:2228 void recoverWellSolutionAndUpdateWellStateDomain(const BVector &x, const int domainIdx) Definition: BlackoilWellModel_impl.hpp:1677 void updateAverageFormationFactor() Definition: BlackoilWellModel_impl.hpp:2171 GetPropType< TypeTag, Properties::Simulator > Simulator Definition: BlackoilWellModel.hpp:110 bool isReservoirCouplingSlave() const Definition: BlackoilWellModel.hpp:390 void initializeWellState(const int timeStepIdx) Definition: BlackoilWellModel_impl.hpp:750 void assemble(const int iterationIdx, const double dt) Definition: BlackoilWellModel_impl.hpp:1122 void computeWellTemperature() Definition: BlackoilWellModel_impl.hpp:2323 void addWellPressureEquations(PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights) const Definition: BlackoilWellModel_impl.hpp:1577 const SimulatorReportSingle & lastReport() const Definition: BlackoilWellModel_impl.hpp:624 bool updateWellControlsAndNetwork(const bool mandatory_network_balance, const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1187 GetPropType< TypeTag, Properties::SparseMatrixAdapter > SparseMatrixAdapter Definition: BlackoilWellModel.hpp:114 void addWellContributions(SparseMatrixAdapter &jacobian) const Definition: BlackoilWellModel_impl.hpp:1567 const EquilGrid & equilGrid() const Definition: BlackoilWellModel.hpp:447 std::tuple< bool, Scalar > updateNetworks(const bool mandatory_network_balance, DeferredLogger &deferred_logger, const bool relax_network_tolerance=false) Definition: BlackoilWellModel_impl.hpp:1833 WellInterfacePtr createWellForWellTest(const std::string &well_name, const int report_step, DeferredLogger &deferred_logger) const Definition: BlackoilWellModel_impl.hpp:1067 GetPropType< TypeTag, Properties::Indices > Indices Definition: BlackoilWellModel.hpp:109 int compressedIndexForInteriorLGR(const std::string &lgr_tag, const Connection &conn) const override Definition: BlackoilWellModel.hpp:357 void assembleWellEqWithoutIteration(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1510 std::vector< WellInterfacePtr > well_container_ Definition: BlackoilWellModel.hpp:406 static constexpr std::size_t pressureVarIndex Definition: BlackoilWellModel.hpp:121 Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > > PressureMatrix Definition: BlackoilWellModel.hpp:299 void computeTotalRatesForDof(RateVector &rate, unsigned globalIdx) const Definition: BlackoilWellModel_impl.hpp:711 bool addMatrixContributions() const Definition: BlackoilWellModel.hpp:346 const std::vector< Scalar > & wellPerfEfficiencyFactors() const GetPropType< TypeTag, Properties::RateVector > RateVector Definition: BlackoilWellModel.hpp:112 void calculateExplicitQuantities(DeferredLogger &deferred_logger) const Definition: BlackoilWellModel_impl.hpp:1741 std::map< std::string, std::unique_ptr< AverageRegionalPressureType > > regionalAveragePressureCalculator_ Definition: BlackoilWellModel.hpp:437 void updatePrimaryVariables(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:2219 bool computeWellGroupThp(const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1303 GetPropType< TypeTag, Properties::GlobalEqVector > GlobalEqVector Definition: BlackoilWellModel.hpp:113 void initializeLocalWellStructure(const int reportStepIdx, const bool enableWellPIScaling) Definition: BlackoilWellModel_impl.hpp:245 static constexpr bool has_solvent_ Definition: BlackoilWellModel.hpp:125 Dune::BlockVector< VectorBlockType > BVector Definition: BlackoilWellModel.hpp:133 static constexpr bool has_micp_ Definition: BlackoilWellModel.hpp:128 std::unique_ptr< RateConverterType > rateConverter_ Definition: BlackoilWellModel.hpp:436 BlackoilWellModel(Simulator &simulator) Definition: BlackoilWellModel_impl.hpp:72 const SparseTable< int > & well_local_cells() const Definition: BlackoilWellModel.hpp:325 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:535 std::vector< bool > is_cell_perforated_ Definition: BlackoilWellModel.hpp:408 int numStrictIterations() const Definition: BlackoilWellModel.hpp:349 ConvergenceReport getWellConvergence(const std::vector< Scalar > &B_avg, const bool checkWellGroupControls=false) const Definition: BlackoilWellModel_impl.hpp:1690 typename FluidSystem::IndexTraitsType IndexTraits Definition: BlackoilWellModel.hpp:119 data::WellBlockAveragePressures wellBlockAveragePressures() const Definition: BlackoilWellModel.hpp:247 std::size_t local_num_cells_ Definition: BlackoilWellModel.hpp:431 bool alternative_well_rate_init_ Definition: BlackoilWellModel.hpp:434 void timeStepSucceeded(const double simulationTime, const double dt) Definition: BlackoilWellModel_impl.hpp:634 std::unique_ptr< WellType > createTypedWellPointer(const int wellID, const int time_step) const Definition: BlackoilWellModel_impl.hpp:1036 ReservoirCouplingMaster & reservoirCouplingMaster() Definition: BlackoilWellModel.hpp:381 std::shared_ptr< WellInterface< TypeTag > > WellInterfacePtr Definition: BlackoilWellModel.hpp:192 void createWellContainer(const int report_step) override Definition: BlackoilWellModel_impl.hpp:793 ReservoirCouplingSlave & reservoirCouplingSlave() Definition: BlackoilWellModel.hpp:384 void addWellPressureEquationsDomain(PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights, const int domainIndex) const Definition: BlackoilWellModel.hpp:305 void updateWellTestState(const double &simulationTime, WellTestState &wellTestState) const upate the wellTestState related to economic limits Definition: BlackoilWellModel_impl.hpp:1975 void addReservoirSourceTerms(GlobalEqVector &residual, const std::vector< typename SparseMatrixAdapter::MatrixBlock * > &diagMatAddress) const Definition: BlackoilWellModel_impl.hpp:1599 int compressedIndexForInterior(int cartesian_cell_idx) const override get compressed index for interior cells (-1, otherwise Definition: BlackoilWellModel.hpp:352 static constexpr bool has_energy_ Definition: BlackoilWellModel.hpp:127 void recoverWellSolutionAndUpdateWellState(const BVector &x) Definition: BlackoilWellModel_impl.hpp:1652 void addWellPressureEquationsStruct(PressureMatrix &jacobian) const Definition: BlackoilWellModel_impl.hpp:1629 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2082 void computePotentials(const std::size_t widx, const WellState< Scalar, IndexTraits > &well_state_copy, std::string &exc_msg, ExceptionType::ExcEnum &exc_type, DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:2032 void prepareWellsBeforeAssembling(const double dt, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1498 data::WellBlockAveragePressures computeWellBlockAveragePressures(const Scalar gravity) const Definition: ConvergenceReport.hpp:38 Definition: DeferredLogger.hpp:57 Handles computation and reporting of guide rates for wells and groups. Definition: GuideRateHandler.hpp:53 Definition: RateConverter.hpp:70 Definition: RegionAverageCalculator.hpp:60 Definition: ReservoirCouplingMaster.hpp:35 Definition: ReservoirCouplingSlave.hpp:35 Definition: BlackoilWellModel.hpp:91 Definition: WellConnectionAuxiliaryModule.hpp:39 Definition: WellContributions.hpp:51 Definition: WellGroupHelpers.hpp:51 Definition: WellInterface.hpp:76 Definition: WellState.hpp:66 data::Wells report(const int *globalCellIdxMap, const std::function< bool(const int)> &wasDynamicallyClosed) const Definition: blackoilboundaryratevector.hh:39 typename Properties::Detail::GetPropImpl< TypeTag, Property >::type::type GetPropType get the type alias defined in the property (equivalent to old macro GET_PROP_TYPE(.... Definition: propertysystem.hh:233 Solver parameters for the BlackoilModel. Definition: BlackoilModelParameters.hpp:179 bool matrix_add_well_contributions_ Whether to add influences of wells between cells to the matrix and preconditioner matrix. Definition: BlackoilModelParameters.hpp:285 bool use_multisegment_well_ Definition: BlackoilModelParameters.hpp:279 int strict_outer_iter_wells_ Newton iteration where wells are stricly convergent. Definition: BlackoilModelParameters.hpp:235 A struct for returning timing data from a simulator to its caller. Definition: SimulatorReport.hpp:34 |