|
GroupStateHelper.hpp
Go to the documentation of this file.
235 std::vector<Scalar> getGroupRatesAvailableForHigherLevelControl(const Group& group, const bool is_injector) const;
280 std::vector<std::string> groupChainTopBot(const std::string& bottom, const std::string& top) const;
306 bool isReservoirCouplingMasterGroup(const Group& group) const { return rescoup_.isMasterGroup(group.name()); }
310 bool isReservoirCouplingSlaveGroup(const Group& group) const { return rescoup_.isSlaveGroup(group.name()); }
577 std::optional<GSatProd::GSatProdGroupProp::Rate> selectRateComponent_(const int phase_pos) const;
592 // NOTE: The deferred logger does not change the object "meaningful" state, so it should be ok to
595 // NOTE: The phase usage info seems to be read-only throughout the simulation, so it should be safe
619 std::map<std::string, std::unique_ptr<AverageRegionalPressureType>>& regional_average_pressure_calculator)
623 this->setRegionAveragePressureCalculator(this->schedule_.getGroup(groupName, this->report_step_),
668 // GPMAINT is not supported for reservoir coupling master groups since master groups do not have
669 // subordinate wells in the master reservoir, so the slaves cannot influence the master reservoir's
671 // Even specifying GPMAINT on a group superior to the master group might not make sense, since if the
673 // the master group's target (that is sent to the slave) could only indirectly influence the master
674 // reservoir's average pressure by affecting the guide rate fractions distributed to actual wells
684 // GPMAINT is not supported for reservoir coupling slave groups since their targets will be overridden
752 // we only activate gpmaint if pressure is lower than the target regional pressure for injectors
#define OPM_DEFLOG_THROW(Exception, message, deferred_logger) Definition: DeferredLoggingErrorHelpers.hpp:45 Definition: DeferredLogger.hpp:57 void logMessages() Definition: GroupStateHelper.hpp:88 GroupStateGuard(GroupStateGuard &&)=delete GroupStateGuard & operator=(GroupStateGuard &&)=delete GroupStateGuard(GroupStateHelper &group_state_helper, GroupState< Scalar > &group_state) Definition: GroupStateHelper.hpp:90 GroupStateGuard(const GroupStateGuard &)=delete ~GroupStateGuard() Definition: GroupStateHelper.hpp:98 GroupStateGuard & operator=(const GroupStateGuard &)=delete RAII guard that owns a DeferredLogger and auto-gathers on destruction. Definition: GroupStateHelper.hpp:128 ScopedLoggerGuard & operator=(const ScopedLoggerGuard &)=delete ScopedLoggerGuard(ScopedLoggerGuard &&other) noexcept Definition: GroupStateHelper.hpp:173 ScopedLoggerGuard(const ScopedLoggerGuard &)=delete ScopedLoggerGuard(const GroupStateHelper &helper, bool do_mpi_gather=true) Constructor for scoped logger guard. Definition: GroupStateHelper.hpp:135 ~ScopedLoggerGuard() Definition: GroupStateHelper.hpp:143 ScopedLoggerGuard & operator=(ScopedLoggerGuard &&)=delete Definition: GroupStateHelper.hpp:59 WellStateGuard(WellStateGuard &&)=delete WellStateGuard(const WellStateGuard &)=delete ~WellStateGuard() Definition: GroupStateHelper.hpp:69 WellStateGuard & operator=(const WellStateGuard &)=delete WellStateGuard & operator=(WellStateGuard &&)=delete WellStateGuard(GroupStateHelper &groupStateHelper, WellState< Scalar, IndexTraits > &well_state) Definition: GroupStateHelper.hpp:61 Definition: GroupStateHelper.hpp:55 void updateWellRatesFromGroupTargetScale(const Scalar scale, const Group &group, bool is_injector, WellState< Scalar, IndexTraits > &well_state) const std::pair< Scalar, Group::ProductionCMode > getAutoChokeGroupProductionTargetRate(const Group &bottom_group, const Group &group, const std::vector< Scalar > &resv_coeff, Scalar efficiencyFactor) const void setRegionAveragePressureCalculator(const Group &group, const FieldPropsManager &fp, std::map< std::string, std::unique_ptr< AverageRegionalPressureType > > ®ional_average_pressure_calculator) const Definition: GroupStateHelper.hpp:616 void setCmodeGroup(const Group &group) std::vector< std::string > groupChainTopBot(const std::string &bottom, const std::string &top) const void updateVREPForGroups(const Group &group) void updateWellRates(const Group &group, const WellState< Scalar, IndexTraits > &well_state_nupcol, WellState< Scalar, IndexTraits > &well_state) const std::optional< GroupTarget > getWellGroupTargetProducer(const std::string &name, const std::string &parent, const Group &group, const Scalar *rates, const Scalar efficiency_factor, const std::vector< Scalar > &resv_coeff) const ReservoirCouplingMaster< Scalar > & reservoirCouplingMaster() Definition: GroupStateHelper.hpp:368 GroupState< Scalar > & groupState() const Definition: GroupStateHelper.hpp:289 Scalar sumWellResRates(const Group &group, const int phase_pos, const bool injector) const void accumulateGroupEfficiencyFactor(const Group &group, Scalar &factor) const int groupControlledWells(const std::string &group_name, const std::string &always_included_child, const bool is_production_group, const Phase injection_phase) const const PhaseUsageInfo< IndexTraits > & phaseUsage() const Definition: GroupStateHelper.hpp:318 const ReservoirCouplingMaster< Scalar > & reservoirCouplingMaster() const Definition: GroupStateHelper.hpp:372 const SummaryState & summaryState() const Definition: GroupStateHelper.hpp:406 const GuideRate & guideRate() const Definition: GroupStateHelper.hpp:294 std::pair< std::optional< std::string >, Scalar > worstOffendingWell(const Group &group, const Group::ProductionCMode &offended_control) const Returns the name of the worst offending well and its fraction (i.e. violated_phase / preferred_phase) ReservoirCoupling::Proxy< Scalar > & rescoup() Definition: GroupStateHelper.hpp:360 void updateReservoirRatesInjectionGroups(const Group &group) bool isReservoirCouplingSlaveGroup(const Group &group) const Definition: GroupStateHelper.hpp:310 const WellState< Scalar, IndexTraits > & wellState() const Definition: GroupStateHelper.hpp:459 GuideRate::RateVector getWellRateVector(const std::string &name) const ScopedLoggerGuard pushLogger(bool do_mpi_gather=true) const Push a new logger onto the stack with auto-cleanup on destruction. Definition: GroupStateHelper.hpp:340 const Parallel::Communication & comm() const Definition: GroupStateHelper.hpp:223 GuideRateModel::Target getInjectionGuideTargetMode(Phase injection_phase) const Get the guide rate target mode for an injection phase. Scalar sumSolventRates(const Group &group, const bool is_injector) const const Schedule & schedule() const Definition: GroupStateHelper.hpp:355 void updateGroupTargetReduction(const Group &group, const bool is_injector) GuideRate::RateVector getProductionGroupRateVector(const std::string &group_name) const void updateGroupProductionRates(const Group &group) bool terminalOutput() const Definition: GroupStateHelper.hpp:423 typename SingleWellState< Scalar, IndexTraits >::GroupTarget GroupTarget Definition: GroupStateHelper.hpp:261 void updateGpMaintTargetForGroups(const Group &group, const RegionalValues ®ional_values, const double dt) Definition: GroupStateHelper.hpp:651 int phaseToActivePhaseIdx(const Phase phase) const std::pair< bool, Scalar > checkGroupConstraintsProd(const std::string &name, const std::string &parent, const Group &group, const Scalar *rates, const Scalar efficiency_factor, const std::vector< Scalar > &resv_coeff, const bool check_guide_rate) const DeferredLogger & deferredLogger() const Get the deferred logger. Definition: GroupStateHelper.hpp:227 Scalar sumWellSurfaceRates(const Group &group, const int phase_pos, const bool injector) const void setReportStep(int report_step) Definition: GroupStateHelper.hpp:401 int updateGroupControlledWells(const bool is_production_group, const Phase injection_phase) void updateState(WellState< Scalar, IndexTraits > &well_state, GroupState< Scalar > &group_state) std::vector< Scalar > getGroupRatesAvailableForHigherLevelControl(const Group &group, const bool is_injector) const bool isReservoirCouplingMasterGroup(const Group &group) const Definition: GroupStateHelper.hpp:306 const ReservoirCoupling::Proxy< Scalar > & rescoup() const Definition: GroupStateHelper.hpp:364 bool isReservoirCouplingMaster() const Definition: GroupStateHelper.hpp:304 const ReservoirCouplingSlave< Scalar > & reservoirCouplingSlave() const Definition: GroupStateHelper.hpp:379 void updateNetworkLeafNodeProductionRates() WellStateGuard pushWellState(WellState< Scalar, IndexTraits > &well_state) Definition: GroupStateHelper.hpp:345 Scalar getInjectionGroupTarget(const Group &group, const Phase &injection_phase, const std::vector< Scalar > &resv_coeff) const GroupStateGuard pushGroupState(GroupState< Scalar > &group_state) Definition: GroupStateHelper.hpp:322 ReservoirCouplingSlave< Scalar > & reservoirCouplingSlave() Definition: GroupStateHelper.hpp:376 Scalar sumWellPhaseRates(bool res_rates, const Group &group, const int phase_pos, const bool injector, const bool network=false) const void updateREINForGroups(const Group &group, bool sum_rank) bool isReservoirCouplingSlave() const Definition: GroupStateHelper.hpp:308 GuideRateModel::Target getProductionGuideTargetMode(const Group &group) const Get the guide rate target mode for a production group. Scalar getProductionGroupTarget(const Group &group) const std::pair< bool, Scalar > checkGroupConstraintsInj(const std::string &name, const std::string &parent, const Group &group, const Scalar *rates, const Phase injection_phase, const Scalar efficiency_factor, const std::vector< Scalar > &resv_coeff, const bool check_guide_rate) const std::optional< GroupTarget > getWellGroupTargetInjector(const std::string &name, const std::string &parent, const Group &group, const Scalar *rates, const Phase injection_phase, const Scalar efficiency_factor, const std::vector< Scalar > &resv_coeff) const GroupStateHelper(WellState< Scalar, IndexTraits > &well_state, GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summary_state, const GuideRate &guide_rate, const PhaseUsageInfo< IndexTraits > &phase_usage_info, const Parallel::Communication &comm, bool terminal_output) void updateSurfaceRatesInjectionGroups(const Group &group) Definition: GroupState.hpp:41 Definition: GasLiftGroupInfo.hpp:37 Thin proxy for reservoir coupling master/slave pointers. Definition: RescoupProxy.hpp:54 Definition: ReservoirCouplingMaster.hpp:38 Definition: ReservoirCouplingSlave.hpp:40 Definition: WellState.hpp:66 Dune::Communication< MPIComm > Communication Definition: ParallelCommunication.hpp:30 RateKind Selects which kind of rate to retrieve from slave group data. Definition: ReservoirCoupling.hpp:168 Phase Phase indices for reservoir coupling, we currently only support black-oil phases (oil,... Definition: ReservoirCoupling.hpp:156 Definition: blackoilbioeffectsmodules.hh:43 Opm::DeferredLogger gatherDeferredLogger(const Opm::DeferredLogger &local_deferredlogger, Parallel::Communication communicator) Create a global log combining local logs. Definition: SingleWellState.hpp:121 |