WellInterface.hpp
Go to the documentation of this file.
121 static constexpr bool has_disgas_in_water = getPropValue<TypeTag, Properties::EnableDisgasInWater>();
122 static constexpr bool has_saltPrecip = getPropValue<TypeTag, Properties::EnableSaltPrecipitation>();
Declares the properties required by the black oil model. Definition: ConvergenceReport.hpp:38 Definition: DeferredLogger.hpp:57 std::map< std::string, std::pair< const Well *, int > > GLiftEclWells Definition: GasLiftGroupInfo.hpp:64 Definition: GasLiftSingleWell.hpp:39 Definition: GroupState.hpp:41 Class encapsulating some information about parallel wells. Definition: ParallelWellInfo.hpp:198 Definition: RateConverter.hpp:70 Manages the initializing and running of time dependent problems. Definition: simulator.hh:84 Definition: SingleWellState.hpp:43 Definition: WellInterfaceFluidSystem.hpp:49 static constexpr int Oil Definition: WellInterfaceFluidSystem.hpp:62 static constexpr int Water Definition: WellInterfaceFluidSystem.hpp:61 static constexpr int Gas Definition: WellInterfaceFluidSystem.hpp:63 int pvtRegionIdx() const Definition: WellInterfaceGeneric.hpp:127 const std::vector< FluidSystem::Scalar > & wellIndex() const Definition: WellInterfaceGeneric.hpp:149 Definition: WellInterfaceIndices.hpp:34 typename WellInterfaceFluidSystem< GetPropType< TypeTag, Properties::FluidSystem > >::ModelParameters ModelParameters Definition: WellInterfaceIndices.hpp:41 DenseAd::Evaluation< Scalar, Indices::numEq > Eval Definition: WellInterfaceIndices.hpp:40 Definition: WellInterface.hpp:76 bool solveWellWithBhp(const Simulator &simulator, const double dt, const Scalar bhp, WellStateType &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:696 virtual std::vector< Scalar > computeCurrentWellRates(const Simulator &simulator, DeferredLogger &deferred_logger) const =0 void checkWellOperability(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:986 GetPropType< TypeTag, Properties::Simulator > Simulator Definition: WellInterface.hpp:81 Scalar computeConnectionDFactor(const int perf, const IntensiveQuantities &intQuants, const SingleWellStateType &ws) const Definition: WellInterface_impl.hpp:1813 void solveWellEquation(const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:776 virtual void computeWellRatesWithBhp(const Simulator &ebosSimulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0 bool updateWellControlAndStatusLocalIteration(const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, const Scalar WQTotal, DeferredLogger &deferred_logger, const bool fixed_control=false, const bool fixed_status=false) Definition: WellInterface_impl.hpp:272 virtual void addWellContributions(SparseMatrixAdapter &) const =0 typename WellInterfaceFluidSystem< FluidSystem >::RateConverterType RateConverterType Definition: WellInterface.hpp:103 bool iterateWellEquations(const Simulator &simulator, const double dt, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:500 const std::vector< RateVector > & connectionRates() const Definition: WellInterface.hpp:340 BlackOilFluidState< Eval, FluidSystem, has_temperature, has_energy, Indices::compositionSwitchIdx >=0, has_watVapor, has_brine, has_saltPrecip, has_disgas_in_water, Indices::numPhases > FluidState Definition: WellInterface.hpp:135 virtual void updateIPR(const Simulator &simulator, DeferredLogger &deferred_logger) const =0 std::optional< Scalar > estimateOperableBhp(const Simulator &ebos_simulator, const double dt, WellStateType &well_state, const SummaryState &summary_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:663 std::vector< RateVector > connectionRates_ Definition: WellInterface.hpp:367 void computeConnLevelProdInd(const FluidState &fs, const std::function< Scalar(const Scalar)> &connPICalc, const std::vector< Scalar > &mobility, Scalar *connPI) const Definition: WellInterface_impl.hpp:2008 void addCellRates(RateVector &rates, int cellIdx) const Definition: WellInterface_impl.hpp:950 Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > > PressureMatrix Definition: WellInterface.hpp:97 void gliftBeginTimeStepWellTestUpdateALQ(const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1013 void assembleWellEq(const Simulator &simulator, const double dt, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:838 Scalar volumetricSurfaceRateForConnection(int cellIdx, int phaseIdx) const Definition: WellInterface_impl.hpp:966 virtual void init(const std::vector< Scalar > &depth_arg, const Scalar gravity_arg, const std::vector< Scalar > &B_avg, const bool changed_to_open_this_step) Definition: WellInterface_impl.hpp:95 void getMobility(const Simulator &simulator, const int local_perf_index, std::vector< Value > &mob, Callback &extendEval, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1899 void assembleWellEqWithoutIteration(const Simulator &simulator, const double dt, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:854 virtual void apply(const BVector &x, BVector &Ax) const =0 Ax = Ax - C D^-1 B x. static const bool has_temperature Definition: WellInterface.hpp:115 GetPropType< TypeTag, Properties::IntensiveQuantities > IntensiveQuantities Definition: WellInterface.hpp:86 GetPropType< TypeTag, Properties::Scalar > Scalar Definition: WellInterface.hpp:82 virtual void checkOperabilityUnderTHPLimit(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger)=0 std::vector< Scalar > initialWellRateFractions(const Simulator &ebosSimulator, const WellStateType &well_state) const Definition: WellInterface_impl.hpp:1575 bool updateWellStateWithTHPTargetProd(const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1977 virtual bool iterateWellEqWithControl(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)=0 void updateConnectionDFactor(const Simulator &simulator, SingleWellStateType &ws) const Definition: WellInterface_impl.hpp:1793 virtual void updateWaterThroughput(const double dt, WellStateType &well_state) const =0 GetPropType< TypeTag, Properties::MaterialLaw > MaterialLaw Definition: WellInterface.hpp:87 virtual Scalar getRefDensity() const =0 typename FluidSystem::IndexTraitsType IndexTraits Definition: WellInterface.hpp:84 virtual void computeWellPotentials(const Simulator &simulator, const WellStateType &well_state, std::vector< Scalar > &well_potentials, DeferredLogger &deferred_logger)=0 Eval getPerfCellPressure(const FluidState &fs) const Definition: WellInterface_impl.hpp:1884 Dune::BlockVector< VectorBlockType > BVector Definition: WellInterface.hpp:96 void initializeProducerWellState(const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1625 bool changed_to_stopped_this_step_ Definition: WellInterface.hpp:369 static constexpr bool has_polymermw Definition: WellInterface.hpp:117 virtual void calculateExplicitQuantities(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger)=0 GetPropType< TypeTag, Properties::Grid > Grid Definition: WellInterface.hpp:80 bool wellUnderZeroGroupRateTarget(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger, std::optional< bool > group_control=std::nullopt) const Definition: WellInterface_impl.hpp:1543 virtual std::optional< Scalar > computeBhpAtThpLimitProdWithAlq(const Simulator &ebos_simulator, const SummaryState &summary_state, const Scalar alq_value, DeferredLogger &deferred_logger, bool iterate_if_no_solution) const =0 typename Base::ModelParameters ModelParameters Definition: WellInterface.hpp:109 virtual void updatePrimaryVariables(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger)=0 bool updateWellControl(const Simulator &simulator, const IndividualOrGroup iog, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:189 virtual void computeWellRatesWithBhpIterations(const Simulator &simulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0 GetPropType< TypeTag, Properties::FluidSystem > FluidSystem Definition: WellInterface.hpp:83 virtual void assembleWellEqWithoutIteration(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)=0 static constexpr bool has_disgas_in_water Definition: WellInterface.hpp:121 static constexpr bool has_saltPrecip Definition: WellInterface.hpp:122 virtual void checkOperabilityUnderBHPLimit(const WellStateType &well_state, const Simulator &simulator, DeferredLogger &deferred_logger)=0 GetPropType< TypeTag, Properties::RateVector > RateVector Definition: WellInterface.hpp:89 virtual void recoverWellSolutionAndUpdateWellState(const Simulator &simulator, const BVector &x, WellStateType &well_state, DeferredLogger &deferred_logger)=0 void updateConnectionTransmissibilityFactor(const Simulator &simulator, SingleWellStateType &ws) const Definition: WellInterface_impl.hpp:1855 void computeConnLevelInjInd(const FluidState &fs, const Phase preferred_phase, const std::function< Scalar(const Scalar)> &connIICalc, const std::vector< Scalar > &mobility, Scalar *connII, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:2042 typename GasLiftGroupInfo< Scalar, IndexTraits >::GLiftEclWells GLiftEclWells Definition: WellInterface.hpp:91 std::unique_ptr< GasLiftSingleWell > initializeGliftWellTest_(const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:2076 virtual void addWellPressureEquations(PressureMatrix &mat, const BVector &x, const int pressureVarIndex, const bool use_well_weights, const WellStateType &well_state) const =0 virtual void updateIPRImplicit(const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger)=0 virtual void solveEqAndUpdateWellState(const Simulator &simulator, WellStateType &well_state, DeferredLogger &deferred_logger)=0 void wellTesting(const Simulator &simulator, const double simulation_time, WellStateType &well_state, const GroupState< Scalar > &group_state, WellTestState &welltest_state, GLiftEclWells &ecl_well_map, std::map< std::string, double > &open_times, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:380 Dune::FieldMatrix< Scalar, Indices::numEq, Indices::numEq > MatrixBlockType Definition: WellInterface.hpp:94 void prepareWellBeforeAssembling(const Simulator &simulator, const double dt, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:874 bool wellUnderZeroRateTarget(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1525 virtual ConvergenceReport getWellConvergence(const Simulator &simulator, const WellStateType &well_state, const std::vector< Scalar > &B_avg, DeferredLogger &deferred_logger, const bool relax_tolerance) const =0 WellInterface(const Well &well, const ParallelWellInfo< Scalar > &pw_info, const int time_step, const ModelParameters ¶m, const RateConverterType &rate_converter, const int pvtRegionIdx, const int num_conservation_quantities, const int num_phases, const int index_of_well, const std::vector< PerforationData< Scalar > > &perf_data) Constructor. Definition: WellInterface_impl.hpp:58 WellState< Scalar, IndexTraits > WellStateType Definition: WellInterface.hpp:99 bool solveWellForTesting(const Simulator &simulator, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:754 void updateWellOperability(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1075 bool solveWellWithOperabilityCheck(const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:563 SingleWellState< Scalar, IndexTraits > SingleWellStateType Definition: WellInterface.hpp:100 virtual void updateProductivityIndex(const Simulator &simulator, const WellProdIndexCalculator< Scalar > &wellPICalc, WellStateType &well_state, DeferredLogger &deferred_logger) const =0 bool updateWellOperabilityFromWellEq(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1112 GetPropType< TypeTag, Properties::Indices > Indices Definition: WellInterface.hpp:85 virtual bool iterateWellEqWithSwitching(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellStateType &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger, const bool fixed_control=false, const bool fixed_status=false)=0 bool solveWellWithZeroRate(const Simulator &simulator, const double dt, WellStateType &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:733 bool thp_update_iterations Definition: WellInterface.hpp:370 Dune::FieldVector< Scalar, Indices::numEq > VectorBlockType Definition: WellInterface.hpp:93 GetPropType< TypeTag, Properties::SparseMatrixAdapter > SparseMatrixAdapter Definition: WellInterface.hpp:88 virtual void updateWellStateWithTarget(const Simulator &simulator, const GroupState< Scalar > &group_state, WellStateType &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1131 static constexpr bool has_zFraction Definition: WellInterface.hpp:112 bool stoppedOrZeroRateTarget(const Simulator &simulator, const WellStateType &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1562 Definition: WellProdIndexCalculator.hpp:37 Definition: WellState.hpp:66 Declares the properties required by the black oil model. 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 Static data associated with a well perforation. Definition: PerforationData.hpp:30 |