RescoupConstraintsCalculator.hpp
Go to the documentation of this file.
1/*
2 Copyright 2025 Equinor ASA
3
4 This file is part of the Open Porous Media project (OPM).
5
6 OPM is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10
11 OPM is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15
16 You should have received a copy of the GNU General Public License
17 along with OPM. If not, see <http://www.gnu.org/licenses/>.
18*/
19
20#ifndef OPM_RESCOUP_CONSTRAINTS_CALCULATOR_HPP
21#define OPM_RESCOUP_CONSTRAINTS_CALCULATOR_HPP
22#include <opm/input/eclipse/Schedule/Group/GuideRate.hpp>
23#include <opm/material/fluidsystems/PhaseUsageInfo.hpp>
33
34#include <functional>
35#include <optional>
36#include <set>
37#include <string>
38#include <vector>
39
40namespace Opm {
41
57template<class Scalar, class IndexTraits>
59public:
63
68 std::vector<std::vector<InjectionGroupTarget>> injection_targets;
69 std::vector<std::vector<ProductionGroupConstraints>> production_constraints;
70 std::vector<std::vector<GasLiftGroupLimits>> gas_lift_limits;
71 };
72
82 GuideRateHandler<Scalar, IndexTraits>& guide_rate_handler,
84 );
85
98
106
107private:
124 std::vector<GasLiftGroupLimits> calculateGasLiftGroupLimits_(std::size_t slave_idx) const;
125
143 std::tuple<std::vector<InjectionGroupTarget>, std::vector<ProductionGroupConstraints>>
144 calculateSlaveGroupConstraints_(std::size_t slave_idx, GroupConstraintCalculator<Scalar, IndexTraits>& calculator) const;
145
153 std::vector<InjectionGroupTarget>
154 calculateSlaveGroupInjectionTargets_(std::size_t slave_idx, GroupConstraintCalculator<Scalar, IndexTraits>& calculator) const;
155
158 std::optional<Scalar> efficiencyFactorToAncestor_(const std::string& group,
159 const std::string& ancestor) const;
160
179 void excludeAndRedistributeProductionTargets_(
181 std::vector<std::vector<ProductionGroupConstraints>>& all_production_constraints);
182
200 void excludeAndRedistributeInjectionTargets_(
202 std::vector<std::vector<InjectionGroupTarget>>& all_injection_targets);
203
211 void excludeInactiveSlaveMasterGroupsFromDistribution_();
212
217 void excludeInactiveSlaveMasterGroupsFromInjectionDistribution_();
218
222 static ProductionGroupConstraints makeProductionGroupConstraints_(
223 std::size_t group_idx,
225
248 Scalar shareGasLiftLimit_(const Group& limit_group,
249 const std::string& master_group,
250 Scalar limit,
251 Scalar total_use,
252 const std::function<Scalar(const std::string&)>& use_of) const;
253
263 void shareUnusedTargetAmongExcludedGroups_(
264 const std::set<std::string>& excluded_groups,
265 std::vector<std::vector<ProductionGroupConstraints>>& all_production_constraints);
266
282 void sendSlaveGroupConstraintsToSlave_(
283 const ReservoirCouplingMaster<Scalar>& rescoup_master,
284 std::size_t slave_idx,
285 const std::vector<InjectionGroupTarget>& injection_targets,
286 const std::vector<ProductionGroupConstraints>& production_constraints,
287 const std::vector<GasLiftGroupLimits>& gas_lift_limits
288 ) const;
289
301 void updateGCWAndTargetReductions_();
302
310 void updateInjectionGCWAndTargetReductions_();
311
312 GuideRateHandler<Scalar, IndexTraits>& guide_rate_handler_;
313 GroupStateHelper<Scalar, IndexTraits>& group_state_helper_;
314 const WellState<Scalar, IndexTraits>& well_state_;
315 const GroupState<Scalar>& group_state_;
316 const int report_step_idx_;
317 const Schedule& schedule_;
318 const SummaryState& summary_state_;
319 DeferredLogger& deferred_logger_;
320 ReservoirCouplingMaster<Scalar>& reservoir_coupling_master_;
322 const PhaseUsageInfo<IndexTraits>& phase_usage_;
323};
324
325} // namespace Opm
326#endif // OPM_RESCOUP_CONSTRAINTS_CALCULATOR_HPP
Definition: DeferredLogger.hpp:57
Definition: GroupConstraintCalculator.hpp:55
Definition: GroupStateHelper.hpp:57
Definition: GroupState.hpp:42
Handles computation and reporting of guide rates for wells and groups.
Definition: GuideRateHandler.hpp:46
Definition: GasLiftGroupInfo.hpp:40
Computes per-master-group production targets and per-rate-type limits for reservoir coupling,...
Definition: RescoupConstraintsCalculator.hpp:58
void calculateMasterGroupConstraintsAndSendToSlaves()
Run the full master-side target distribution and dispatch the resulting constraints to each activated...
MasterGroupConstraints calculateMasterGroupConstraints()
Run the master-side target distribution without sending the result to the slaves.
RescoupConstraintsCalculator(GuideRateHandler< Scalar, IndexTraits > &guide_rate_handler, GroupStateHelper< Scalar, IndexTraits > &group_state_helper)
Construct a calculator bound to the master's per-sync-step state.
Definition: ReservoirCouplingMaster.hpp:43
Definition: WellState.hpp:68
Definition: blackoilbioeffectsmodules.hh:45
Definition: GroupConstraintCalculator.hpp:105
The constraints computed for the master groups, indexed by slave.
Definition: RescoupConstraintsCalculator.hpp:67
std::vector< std::vector< InjectionGroupTarget > > injection_targets
Definition: RescoupConstraintsCalculator.hpp:68
std::vector< std::vector< GasLiftGroupLimits > > gas_lift_limits
Definition: RescoupConstraintsCalculator.hpp:70
std::vector< std::vector< ProductionGroupConstraints > > production_constraints
Definition: RescoupConstraintsCalculator.hpp:69
Gas lift limits (GLIFTOPT) the master imposes on a slave group.
Definition: ReservoirCoupling.hpp:336
Definition: ReservoirCoupling.hpp:305
Definition: ReservoirCoupling.hpp:315