|
BlackoilWellModel.hpp
Go to the documentation of this file.
96 class BlackoilWellModel : public WellConnectionAuxiliaryModule<TypeTag, BlackoilWellModel<TypeTag>>
114 using WellConnectionModule = WellConnectionAuxiliaryModule<TypeTag, BlackoilWellModel<TypeTag>>;
118 constexpr static std::size_t pressureVarIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx;
124 static constexpr EnergyModules energyModuleType_ = getPropValue<TypeTag, Properties::EnergyModuleType>();
255 ConvergenceReport getWellConvergence(const std::vector<Scalar>& B_avg, const bool checkWellGroupControlsAndNetwork = false) const;
346 int compressedIndexForInteriorLGR(const std::string& lgr_tag, const Connection& conn) const override
473 static Scalar computeTemperatureWeightFactor(const int perf_index, const int np, const FluidState& fs, const SingleWellState& ws)
488 weight_factor += cellDensity * (perfPhaseRate / cellBinv) * (cellInternalEnergy / cellTemperatures);
527 std::map<std::string, std::unique_ptr<AverageRegionalPressureType>> regionalAveragePressureCalculator_{};
551 // the returned two booleans are {continue_due_to_network, well_group_control_changed}, respectively
552 std::tuple<bool, bool, Scalar> updateWellControlsAndNetworkIteration(const bool mandatory_network_balance,
592 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger& deferred_logger) override;
613 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger& deferred_logger);
713 // Store cell rates after assembling to avoid iterating all wells and connections for every element
Contains the high level supplements required to extend the black oil model by bioeffects. Definition: blackoilbioeffectsmodules.hh:95 Contains the high level supplements required to extend the black oil model by polymer. Definition: blackoilpolymermodules.hh:65 Class for handling the gaslift in the blackoil well model. Definition: BlackoilWellModelGasLift.hpp:96 Class for handling the blackoil well model. Definition: BlackoilWellModelGeneric.hpp:98 GroupStateHelperType & groupStateHelper() Definition: BlackoilWellModelGeneric.hpp:290 const GroupState< GetPropType< TypeTag, Properties::Scalar > > & groupState() const Definition: BlackoilWellModelGeneric.hpp:144 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:520 WellTestState & wellTestState() Definition: BlackoilWellModelGeneric.hpp:185 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:154 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:47 void assignWellGuideRates(data::Wells &wsrpt, const int reportStepIdx) const Assign well guide rates. Class for handling the blackoil well network model. Definition: BlackoilWellModelNetwork.hpp:47 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:99 ReservoirCoupling::Proxy< Scalar > & rescoup() Get the reservoir coupling proxy. Definition: BlackoilWellModel.hpp:392 void initializeGroupStructure(const int reportStepIdx) Definition: BlackoilWellModel_impl.hpp:294 bool network_needs_more_balancing_force_another_newton_iteration_ Definition: BlackoilWellModel.hpp:534 void calcResvCoeff(const int fipnum, const int pvtreg, const std::vector< Scalar > &production_rates, std::vector< Scalar > &resv_coeff) const override Definition: BlackoilWellModel_impl.hpp:2120 ReservoirCouplingMaster< Scalar > & reservoirCouplingMaster() Get reference to reservoir coupling master. Definition: BlackoilWellModel.hpp:427 void prepareTimeStep(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1943 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:1226 WellInterfacePtr createWellPointer(const int wellID, const int report_step) const Definition: BlackoilWellModel_impl.hpp:1013 GuideRateHandler< Scalar, IndexTraits > guide_rate_handler_ Definition: BlackoilWellModel.hpp:530 const EclipseState & eclState() const Definition: BlackoilWellModel.hpp:541 void prepareWellsBeforeAssembling(const double dt) Definition: BlackoilWellModel_impl.hpp:1331 const std::vector< WellInterfacePtr > & localNonshutWells() const Get list of local nonshut wells. Definition: BlackoilWellModel.hpp:309 void prepareDeserialize(const int report_step) Definition: BlackoilWellModel.hpp:200 void setNlddAdapter(BlackoilWellModelNldd< TypeTag > *mod) Definition: BlackoilWellModel.hpp:380 const Simulator & simulator() const Definition: BlackoilWellModel.hpp:369 static constexpr bool has_geochem_ Definition: BlackoilWellModel.hpp:127 static constexpr EnergyModules energyModuleType_ Definition: BlackoilWellModel.hpp:124 std::size_t global_num_cells_ Definition: BlackoilWellModel.hpp:520 GetPropType< TypeTag, Properties::Scalar > Scalar Definition: BlackoilWellModel.hpp:108 const std::vector< Scalar > & B_avg() const Definition: BlackoilWellModel.hpp:465 SimulatorReportSingle last_report_ Definition: BlackoilWellModel.hpp:529 static const int solventSaturationIdx Definition: BlackoilWellModel.hpp:121 void initWellContainer(const int reportStepIdx) override Definition: BlackoilWellModel_impl.hpp:182 void beginReportStep(const int time_step) Definition: BlackoilWellModel_impl.hpp:199 const WellInterface< TypeTag > & getWell(const std::string &well_name) const Definition: BlackoilWellModel_impl.hpp:2092 GetPropType< TypeTag, Properties::FluidSystem > FluidSystem Definition: BlackoilWellModel.hpp:104 bool isReservoirCouplingMaster() const Check if this process is a reservoir coupling master. Definition: BlackoilWellModel.hpp:411 Dune::FieldVector< Scalar, numEq > VectorBlockType Definition: BlackoilWellModel.hpp:131 const BlackoilWellModelNetwork< TypeTag > & network() const Definition: BlackoilWellModel.hpp:375 void initFromRestartFile(const RestartValue &restartValues) Definition: BlackoilWellModel.hpp:191 GetPropType< TypeTag, Properties::ElementContext > ElementContext Definition: BlackoilWellModel.hpp:105 GetPropType< TypeTag, Properties::Grid > Grid Definition: BlackoilWellModel.hpp:102 GetPropType< TypeTag, Properties::EquilGrid > EquilGrid Definition: BlackoilWellModel.hpp:103 int numConservationQuantities() const Definition: BlackoilWellModel_impl.hpp:2064 const std::map< std::string, int > & well_domain() const Definition: BlackoilWellModel.hpp:322 const ReservoirCouplingSlave< Scalar > & reservoirCouplingSlave() const Definition: BlackoilWellModel.hpp:439 bool updateWellControls(DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:1618 static constexpr bool has_polymer_ Definition: BlackoilWellModel.hpp:123 int reportStepIndex() const Definition: BlackoilWellModel_impl.hpp:2108 void calculateProductivityIndexValues(DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:1885 void extractLegacyDepth_() Definition: BlackoilWellModel_impl.hpp:2080 void extractLegacyCellPvtRegionIndex_() Definition: BlackoilWellModel_impl.hpp:2048 std::vector< WellInterfacePtr > & wellContainer() Definition: BlackoilWellModel.hpp:377 void recoverWellSolutionAndUpdateWellStateDomain(const BVector &x, const int domainIdx) Definition: BlackoilWellModel_impl.hpp:1539 void updateAverageFormationFactor() Definition: BlackoilWellModel_impl.hpp:1991 GetPropType< TypeTag, Properties::Simulator > Simulator Definition: BlackoilWellModel.hpp:107 BlackoilWellModel(Simulator &simulator, const NewtonIterationContext &iter_ctx) Definition: BlackoilWellModel_impl.hpp:72 bool isReservoirCouplingSlave() const Check if this process is a reservoir coupling slave. Definition: BlackoilWellModel.hpp:414 const ReservoirCouplingMaster< Scalar > & reservoirCouplingMaster() const Definition: BlackoilWellModel.hpp:430 void initializeWellState(const int timeStepIdx) Definition: BlackoilWellModel_impl.hpp:761 void updatePrimaryVariables() Definition: BlackoilWellModel_impl.hpp:2039 const ReservoirCoupling::Proxy< Scalar > & rescoup() const Definition: BlackoilWellModel.hpp:393 void computeWellTemperature() Definition: BlackoilWellModel_impl.hpp:2142 void addWellPressureEquations(PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights) const Definition: BlackoilWellModel_impl.hpp:1440 const SimulatorReportSingle & lastReport() const Definition: BlackoilWellModel_impl.hpp:637 bool updateWellControlsAndNetwork(const bool mandatory_network_balance, const double dt, DeferredLogger &local_deferredLogger) Definition: BlackoilWellModel_impl.hpp:1164 GetPropType< TypeTag, Properties::SparseMatrixAdapter > SparseMatrixAdapter Definition: BlackoilWellModel.hpp:111 void addWellContributions(SparseMatrixAdapter &jacobian) const Definition: BlackoilWellModel_impl.hpp:1430 const EquilGrid & equilGrid() const Definition: BlackoilWellModel.hpp:538 void assembleWellEq(const double dt) Definition: BlackoilWellModel_impl.hpp:1319 WellInterfacePtr createWellForWellTest(const std::string &well_name, const int report_step, DeferredLogger &deferred_logger) const Definition: BlackoilWellModel_impl.hpp:1064 GetPropType< TypeTag, Properties::Indices > Indices Definition: BlackoilWellModel.hpp:106 int compressedIndexForInteriorLGR(const std::string &lgr_tag, const Connection &conn) const override Definition: BlackoilWellModel.hpp:346 void calculateExplicitQuantities() const Definition: BlackoilWellModel_impl.hpp:1603 BlackoilWellModelNetwork< TypeTag > & network() Definition: BlackoilWellModel.hpp:374 std::vector< WellInterfacePtr > well_container_ Definition: BlackoilWellModel.hpp:497 static constexpr std::size_t pressureVarIndex Definition: BlackoilWellModel.hpp:118 void updateAndCommunicate(const int reportStepIdx) Definition: BlackoilWellModel_impl.hpp:1698 Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > > PressureMatrix Definition: BlackoilWellModel.hpp:288 void computeTotalRatesForDof(RateVector &rate, unsigned globalIdx) const Definition: BlackoilWellModel_impl.hpp:724 bool addMatrixContributions() const Definition: BlackoilWellModel.hpp:335 const std::vector< Scalar > & wellPerfEfficiencyFactors() const GetPropType< TypeTag, Properties::RateVector > RateVector Definition: BlackoilWellModel.hpp:109 bool updateGroupControls(const Group &group, DeferredLogger &deferred_logger, const int reportStepIdx) Definition: BlackoilWellModel_impl.hpp:1725 std::map< std::string, std::unique_ptr< AverageRegionalPressureType > > regionalAveragePressureCalculator_ Definition: BlackoilWellModel.hpp:527 void calcInjResvCoeff(const int fipnum, const int pvtreg, std::vector< Scalar > &resv_coeff) const override Definition: BlackoilWellModel_impl.hpp:2131 static Scalar computeTemperatureWeightFactor(const int perf_index, const int np, const FluidState &fs, const SingleWellState &ws) Definition: BlackoilWellModel.hpp:473 GetPropType< TypeTag, Properties::GlobalEqVector > GlobalEqVector Definition: BlackoilWellModel.hpp:110 void initializeLocalWellStructure(const int reportStepIdx, const bool enableWellPIScaling) Definition: BlackoilWellModel_impl.hpp:248 GuideRateHandler< Scalar, IndexTraits > & guideRateHandler() Definition: BlackoilWellModel.hpp:383 static constexpr bool has_solvent_ Definition: BlackoilWellModel.hpp:122 Dune::BlockVector< VectorBlockType > BVector Definition: BlackoilWellModel.hpp:132 static constexpr bool has_micp_ Definition: BlackoilWellModel.hpp:126 std::unique_ptr< RateConverterType > rateConverter_ Definition: BlackoilWellModel.hpp:526 const SparseTable< int > & well_local_cells() const Definition: BlackoilWellModel.hpp:314 void wellTesting(const int timeStepIdx, const double simulationTime, DeferredLogger &deferred_logger) Definition: BlackoilWellModel_impl.hpp:560 std::vector< bool > is_cell_perforated_ Definition: BlackoilWellModel.hpp:499 ConvergenceReport getWellConvergence(const std::vector< Scalar > &B_avg, const bool checkWellGroupControlsAndNetwork=false) const Definition: BlackoilWellModel_impl.hpp:1552 int numStrictIterations() const Definition: BlackoilWellModel.hpp:338 typename FluidSystem::IndexTraitsType IndexTraits Definition: BlackoilWellModel.hpp:115 void updateCellRatesForDomain(int domainIndex, const std::map< std::string, int > &well_domain_map) Definition: BlackoilWellModel_impl.hpp:1377 data::WellBlockAveragePressures wellBlockAveragePressures() const Definition: BlackoilWellModel.hpp:244 void assembleWellEqWithoutIteration(const double dt) Definition: BlackoilWellModel_impl.hpp:1345 void updateCellRates() Definition: BlackoilWellModel_impl.hpp:1365 void assemble(const double dt) Definition: BlackoilWellModel_impl.hpp:1089 std::size_t local_num_cells_ Definition: BlackoilWellModel.hpp:522 bool alternative_well_rate_init_ Definition: BlackoilWellModel.hpp:525 void timeStepSucceeded(const double simulationTime, const double dt) Definition: BlackoilWellModel_impl.hpp:647 std::unique_ptr< WellType > createTypedWellPointer(const int wellID, const int time_step) const Definition: BlackoilWellModel_impl.hpp:1033 void computePotentials(const std::size_t widx, const WellState< Scalar, IndexTraits > &well_state_copy, std::string &exc_msg, ExceptionType::ExcEnum &exc_type) override Definition: BlackoilWellModel_impl.hpp:1850 void updateGuideRates(const int report_step_idx, const double sim_time) Update guide rates for all wells and groups. Definition: BlackoilWellModel.hpp:402 ReservoirCoupling::Proxy< Scalar > rescoup_ Definition: BlackoilWellModel.hpp:531 void createWellContainer(const int report_step) override Definition: BlackoilWellModel_impl.hpp:804 std::unique_ptr< WellInterface< TypeTag > > WellInterfacePtr Definition: BlackoilWellModel.hpp:188 ReservoirCouplingSlave< Scalar > & reservoirCouplingSlave() Get reference to reservoir coupling slave. Definition: BlackoilWellModel.hpp:436 const ModelParameters & param() const Definition: BlackoilWellModel.hpp:468 void updateWellTestState(const double simulationTime, WellTestState &wellTestState) upate the wellTestState related to economic limits Definition: BlackoilWellModel_impl.hpp:1779 void addWellPressureEquationsDomain(PressureMatrix &jacobian, const BVector &weights, const bool use_well_weights, const int domainIndex) const Definition: BlackoilWellModel.hpp:294 bool isReservoirCouplingMasterGroup(const std::string &group_name) const Check if a group is a reservoir coupling master group. Definition: BlackoilWellModel.hpp:421 const GuideRateHandler< Scalar, IndexTraits > & guideRateHandler() const Definition: BlackoilWellModel.hpp:386 void addReservoirSourceTerms(GlobalEqVector &residual, const std::vector< typename SparseMatrixAdapter::MatrixBlock * > &diagMatAddress) const Definition: BlackoilWellModel_impl.hpp:1462 int compressedIndexForInterior(int cartesian_cell_idx) const override get compressed index for interior cells (-1, otherwise Definition: BlackoilWellModel.hpp:341 static constexpr bool has_energy_ Definition: BlackoilWellModel.hpp:125 void recoverWellSolutionAndUpdateWellState(const BVector &x) Definition: BlackoilWellModel_impl.hpp:1515 void addWellPressureEquationsStruct(PressureMatrix &jacobian) const Definition: BlackoilWellModel_impl.hpp:1492 void calculateProductivityIndexValuesShutWells(const int reportStepIdx, DeferredLogger &deferred_logger) override Definition: BlackoilWellModel_impl.hpp:1899 const std::vector< WellInterfacePtr > & wellContainer() const Definition: BlackoilWellModel.hpp:378 data::WellBlockAveragePressures computeWellBlockAveragePressures(const Scalar gravity) const Definition: ConvergenceReport.hpp:38 Definition: DeferredLogger.hpp:57 Definition: GroupStateHelper.hpp:56 Handles computation and reporting of guide rates for wells and groups. Definition: GuideRateHandler.hpp:46 Definition: RateConverter.hpp:70 Definition: RegionAverageCalculator.hpp:60 Thin proxy for reservoir coupling master/slave pointers. Definition: RescoupProxy.hpp:54 Definition: ReservoirCouplingMaster.hpp:38 Definition: ReservoirCouplingSlave.hpp:40 Definition: SingleWellState.hpp:44 Definition: BlackoilWellModel.hpp:88 Definition: WellConnectionAuxiliaryModule.hpp:39 Definition: WellContributions.hpp:51 Definition: WellInterface.hpp:77 Definition: WellState.hpp:66 data::Wells report(const int *globalCellIdxMap, const std::function< bool(const int)> &wasDynamicallyClosed, const RsConstInfo &rsConst=RsConstInfo{}) const Definition: blackoilbioeffectsmodules.hh:45 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:196 bool matrix_add_well_contributions_ Whether to add influences of wells between cells to the matrix and preconditioner matrix. Definition: BlackoilModelParameters.hpp:310 int strict_outer_iter_wells_ Newton iteration where wells are stricly convergent. Definition: BlackoilModelParameters.hpp:260 Context for iteration-dependent decisions in the Newton solver. Definition: NewtonIterationContext.hpp:43 A struct for returning timing data from a simulator to its caller. Definition: SimulatorReport.hpp:34 |