WellInterface.hpp
Go to the documentation of this file.
118 static constexpr bool has_disgas_in_water = getPropValue<TypeTag, Properties::EnableDisgasInWater>();
119 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:70 Definition: GasLiftSingleWell.hpp:37 Definition: GroupState.hpp:43 Class encapsulating some information about parallel wells. Definition: ParallelWellInfo.hpp:195 Definition: RateConverter.hpp:71 Manages the initializing and running of time dependent problems. Definition: simulator.hh:84 Definition: SingleWellState.hpp:42 Definition: WellInterfaceFluidSystem.hpp:51 static constexpr int Oil Definition: WellInterfaceFluidSystem.hpp:63 static constexpr int Water Definition: WellInterfaceFluidSystem.hpp:62 static constexpr int Gas Definition: WellInterfaceFluidSystem.hpp:64 int pvtRegionIdx() const Definition: WellInterfaceGeneric.hpp:124 const std::vector< FluidSystem::Scalar > & wellIndex() const Definition: WellInterfaceGeneric.hpp:146 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:77 bool updateWellControl(const Simulator &simulator, const IndividualOrGroup iog, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:191 virtual std::vector< Scalar > computeCurrentWellRates(const Simulator &simulator, DeferredLogger &deferred_logger) const =0 GetPropType< TypeTag, Properties::Simulator > Simulator Definition: WellInterface.hpp:82 virtual ConvergenceReport getWellConvergence(const Simulator &simulator, const WellState< Scalar > &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_components, const int num_phases, const int index_of_well, const std::vector< PerforationData< Scalar > > &perf_data) Constructor. Definition: WellInterface_impl.hpp:58 virtual void recoverWellSolutionAndUpdateWellState(const Simulator &simulator, const BVector &x, WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 virtual void computeWellPotentials(const Simulator &simulator, const WellState< Scalar > &well_state, std::vector< Scalar > &well_potentials, DeferredLogger &deferred_logger)=0 void assembleWellEq(const Simulator &simulator, const double dt, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:841 virtual void computeWellRatesWithBhp(const Simulator &ebosSimulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0 virtual void addWellContributions(SparseMatrixAdapter &) const =0 typename WellInterfaceFluidSystem< FluidSystem >::RateConverterType RateConverterType Definition: WellInterface.hpp:100 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:132 virtual void assembleWellEqWithoutIteration(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)=0 virtual void updateIPR(const Simulator &simulator, DeferredLogger &deferred_logger) const =0 virtual void checkOperabilityUnderBHPLimit(const WellState< Scalar > &well_state, const Simulator &simulator, DeferredLogger &deferred_logger)=0 std::vector< RateVector > connectionRates_ Definition: WellInterface.hpp:367 bool wellUnderZeroRateTarget(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1521 void computeConnLevelProdInd(const FluidState &fs, const std::function< Scalar(const Scalar)> &connPICalc, const std::vector< Scalar > &mobility, Scalar *connPI) const Definition: WellInterface_impl.hpp:2004 bool updateWellStateWithTHPTargetProd(const Simulator &simulator, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1973 void addCellRates(RateVector &rates, int cellIdx) const Definition: WellInterface_impl.hpp:953 virtual void calculateExplicitQuantities(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 Dune::BCRSMatrix< Opm::MatrixBlock< Scalar, 1, 1 > > PressureMatrix Definition: WellInterface.hpp:97 Scalar volumetricSurfaceRateForConnection(int cellIdx, int phaseIdx) const Definition: WellInterface_impl.hpp:969 virtual void addWellPressureEquations(PressureMatrix &mat, const BVector &x, const int pressureVarIndex, const bool use_well_weights, const WellState< Scalar > &well_state) const =0 void getMobility(const Simulator &simulator, const int local_perf_index, std::vector< Value > &mob, Callback &extendEval, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1895 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:112 virtual void updatePrimaryVariables(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 bool iterateWellEquations(const Simulator &simulator, const double dt, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:503 GetPropType< TypeTag, Properties::IntensiveQuantities > IntensiveQuantities Definition: WellInterface.hpp:86 virtual void updateProductivityIndex(const Simulator &simulator, const WellProdIndexCalculator< Scalar > &wellPICalc, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const =0 GetPropType< TypeTag, Properties::Scalar > Scalar Definition: WellInterface.hpp:83 void checkWellOperability(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:989 std::optional< Scalar > estimateOperableBhp(const Simulator &ebos_simulator, const double dt, WellState< Scalar > &well_state, const SummaryState &summary_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:666 void updateWellOperability(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1080 void wellTesting(const Simulator &simulator, const double simulation_time, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, WellTestState &welltest_state, const PhaseUsage &phase_usage, GLiftEclWells &ecl_well_map, std::map< std::string, double > &open_times, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:381 GetPropType< TypeTag, Properties::MaterialLaw > MaterialLaw Definition: WellInterface.hpp:87 bool solveWellWithOperabilityCheck(const Simulator &simulator, const double dt, const Well::InjectionControls &inj_controls, const Well::ProductionControls &prod_controls, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:566 virtual void updateWellStateWithTarget(const Simulator &simulator, const GroupState< Scalar > &group_state, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1136 virtual Scalar getRefDensity() const =0 Eval getPerfCellPressure(const FluidState &fs) const Definition: WellInterface_impl.hpp:1880 Dune::BlockVector< VectorBlockType > BVector Definition: WellInterface.hpp:96 bool changed_to_stopped_this_step_ Definition: WellInterface.hpp:369 virtual void solveEqAndUpdateWellState(const Simulator &simulator, WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 static constexpr bool has_polymermw Definition: WellInterface.hpp:114 GetPropType< TypeTag, Properties::Grid > Grid Definition: WellInterface.hpp:81 void updateConnectionTransmissibilityFactor(const Simulator &simulator, SingleWellState< Scalar > &ws) const Definition: WellInterface_impl.hpp:1851 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 bool stoppedOrZeroRateTarget(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1558 void initializeProducerWellState(const Simulator &simulator, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) const Definition: WellInterface_impl.hpp:1621 typename Base::ModelParameters ModelParameters Definition: WellInterface.hpp:106 virtual void computeWellRatesWithBhpIterations(const Simulator &simulator, const Scalar &bhp, std::vector< Scalar > &well_flux, DeferredLogger &deferred_logger) const =0 virtual void updateIPRImplicit(const Simulator &simulator, WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 GetPropType< TypeTag, Properties::FluidSystem > FluidSystem Definition: WellInterface.hpp:84 static constexpr bool has_disgas_in_water Definition: WellInterface.hpp:118 void prepareWellBeforeAssembling(const Simulator &simulator, const double dt, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:877 static constexpr bool has_saltPrecip Definition: WellInterface.hpp:119 GetPropType< TypeTag, Properties::RateVector > RateVector Definition: WellInterface.hpp:89 virtual void updateWaterThroughput(const double dt, WellState< Scalar > &well_state) const =0 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:2039 void solveWellEquation(const Simulator &simulator, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:779 virtual void init(const PhaseUsage *phase_usage_arg, 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 updateConnectionDFactor(const Simulator &simulator, SingleWellState< Scalar > &ws) const Definition: WellInterface_impl.hpp:1789 virtual bool iterateWellEqWithControl(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger)=0 std::vector< Scalar > initialWellRateFractions(const Simulator &ebosSimulator, const WellState< Scalar > &well_state) const Definition: WellInterface_impl.hpp:1571 bool updateWellOperabilityFromWellEq(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1117 virtual bool iterateWellEqWithSwitching(const Simulator &simulator, const double dt, const WellInjectionControls &inj_controls, const WellProductionControls &prod_controls, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger, const bool fixed_control=false, const bool fixed_status=false)=0 Dune::FieldMatrix< Scalar, Indices::numEq, Indices::numEq > MatrixBlockType Definition: WellInterface.hpp:94 void gliftBeginTimeStepWellTestUpdateALQ(const Simulator &simulator, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, const PhaseUsage &phase_usage, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:1016 typename GasLiftGroupInfo< Scalar >::GLiftEclWells GLiftEclWells Definition: WellInterface.hpp:91 Scalar computeConnectionDFactor(const int perf, const IntensiveQuantities &intQuants, const SingleWellState< Scalar > &ws) const Definition: WellInterface_impl.hpp:1809 bool solveWellWithBhp(const Simulator &simulator, const double dt, const Scalar bhp, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:699 bool solveWellWithZeroRate(const Simulator &simulator, const double dt, WellState< Scalar > &well_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:736 bool solveWellForTesting(const Simulator &simulator, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:757 GetPropType< TypeTag, Properties::Indices > Indices Definition: WellInterface.hpp:85 bool wellUnderZeroGroupRateTarget(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger, std::optional< bool > group_control=std::nullopt) const Definition: WellInterface_impl.hpp:1539 bool thp_update_iterations Definition: WellInterface.hpp:370 Dune::FieldVector< Scalar, Indices::numEq > VectorBlockType Definition: WellInterface.hpp:93 void assembleWellEqWithoutIteration(const Simulator &simulator, const double dt, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:857 GetPropType< TypeTag, Properties::SparseMatrixAdapter > SparseMatrixAdapter Definition: WellInterface.hpp:88 bool updateWellControlAndStatusLocalIteration(const Simulator &simulator, WellState< Scalar > &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:274 std::unique_ptr< GasLiftSingleWell > initializeGliftWellTest_(const Simulator &simulator, WellState< Scalar > &well_state, const GroupState< Scalar > &group_state, const PhaseUsage &phase_usage, GLiftEclWells &ecl_well_map, DeferredLogger &deferred_logger) Definition: WellInterface_impl.hpp:2075 virtual void checkOperabilityUnderTHPLimit(const Simulator &simulator, const WellState< Scalar > &well_state, DeferredLogger &deferred_logger)=0 static constexpr bool has_zFraction Definition: WellInterface.hpp:109 Definition: WellProdIndexCalculator.hpp:37 Definition: WellState.hpp:65 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 Definition: BlackoilPhases.hpp:46 |