WellGroupControls.hpp
Go to the documentation of this file.
1/*
2 Copyright 2017 SINTEF Digital, Mathematics and Cybernetics.
3 Copyright 2017 Statoil ASA.
4 Copyright 2017 IRIS
5 Copyright 2019 Norce
6
7 This file is part of the Open Porous Media project (OPM).
8
9 OPM is free software: you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation, either version 3 of the License, or
12 (at your option) any later version.
13
14 OPM is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
18
19 You should have received a copy of the GNU General Public License
20 along with OPM. If not, see <http://www.gnu.org/licenses/>.
21*/
22
23
24#ifndef OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED
25#define OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED
26
27#include <opm/input/eclipse/Schedule/Group/GuideRate.hpp>
28#include <string>
29#include <functional>
30#include <optional>
31#include <vector>
32
33namespace Opm
34{
35
36class DeferredLogger;
37class Group;
38template<class Scalar> class GroupState;
39enum class InjectorType;
40using RegionId = int;
41class Schedule;
42class SummaryState;
43template<typename Scalar, typename IndexTraits> class WellInterfaceGeneric;
44template<typename Scalar, typename IndexTraits> class WellState;
45
47template<typename Scalar, typename IndexTraits>
49public:
51 explicit WellGroupControls(const WellInterfaceGeneric<Scalar, IndexTraits>& well) : well_(well) {}
52
53 using RateConvFunc = std::function<void(const RegionId, const int,
54 const std::optional<std::string>&, std::vector<Scalar>&)>;
55
56 template<class EvalWell>
57 void getGroupInjectionControl(const Group& group,
58 const WellState<Scalar, IndexTraits>& well_state,
59 const GroupState<Scalar>& group_state,
60 const Schedule& schedule,
61 const SummaryState& summaryState,
62 const InjectorType& injectorType,
63 const EvalWell& bhp,
64 const EvalWell& injection_rate,
65 const RateConvFunc& rateConverter,
66 Scalar efficiencyFactor,
67 EvalWell& control_eq,
68 DeferredLogger& deferred_logger) const;
69
70 std::optional<Scalar>
71 getGroupInjectionTargetRate(const Group& group,
72 const WellState<Scalar, IndexTraits>& well_state,
73 const GroupState<Scalar>& group_state,
74 const Schedule& schedule,
75 const SummaryState& summaryState,
76 const InjectorType& injectorType,
77 const RateConvFunc& rateConverter,
78 Scalar efficiencyFactor,
79 DeferredLogger& deferred_logger) const;
80
81 template<class EvalWell>
82 void getGroupProductionControl(const Group& group,
83 const WellState<Scalar, IndexTraits>& well_state,
84 const GroupState<Scalar>& group_state,
85 const Schedule& schedule,
86 const SummaryState& summaryState,
87 const EvalWell& bhp,
88 const std::vector<EvalWell>& rates,
89 const RateConvFunc& rateConverter,
90 Scalar efficiencyFactor,
91 EvalWell& control_eq,
92 DeferredLogger& deferred_logger) const;
93
94 Scalar getGroupProductionTargetRate(const Group& group,
95 const WellState<Scalar, IndexTraits>& well_state,
96 const GroupState<Scalar>& group_state,
97 const Schedule& schedule,
98 const SummaryState& summaryState,
99 const RateConvFunc& rateConverter,
100 Scalar efficiencyFactor,
101 DeferredLogger& deferred_logger) const;
102
103 static std::pair<Scalar, Group::ProductionCMode> getAutoChokeGroupProductionTargetRate(const std::string& name,
104 const Group& parent,
105 const WellState<Scalar, IndexTraits>& well_state,
106 const GroupState<Scalar>& group_state,
107 const Schedule& schedule,
108 const SummaryState& summaryState,
109 const std::vector<Scalar>& resv_coeff,
110 Scalar efficiencyFactor,
111 const int reportStepIdx,
112 const GuideRate* guideRate,
113 DeferredLogger& deferred_logger);
114
115private:
117};
118
119}
120
121#endif // OPM_WELL_GROUP_CONTROLS_HEADER_INCLUDED
Definition: DeferredLogger.hpp:57
Definition: GroupState.hpp:41
Class for computing well group controls.
Definition: WellGroupControls.hpp:48
WellGroupControls(const WellInterfaceGeneric< Scalar, IndexTraits > &well)
Constructor sets reference to well.
Definition: WellGroupControls.hpp:51
std::optional< Scalar > getGroupInjectionTargetRate(const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const InjectorType &injectorType, const RateConvFunc &rateConverter, Scalar efficiencyFactor, DeferredLogger &deferred_logger) const
static std::pair< Scalar, Group::ProductionCMode > getAutoChokeGroupProductionTargetRate(const std::string &name, const Group &parent, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const std::vector< Scalar > &resv_coeff, Scalar efficiencyFactor, const int reportStepIdx, const GuideRate *guideRate, DeferredLogger &deferred_logger)
Scalar getGroupProductionTargetRate(const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const RateConvFunc &rateConverter, Scalar efficiencyFactor, DeferredLogger &deferred_logger) const
void getGroupProductionControl(const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const EvalWell &bhp, const std::vector< EvalWell > &rates, const RateConvFunc &rateConverter, Scalar efficiencyFactor, EvalWell &control_eq, DeferredLogger &deferred_logger) const
std::function< void(const RegionId, const int, const std::optional< std::string > &, std::vector< Scalar > &)> RateConvFunc
Definition: WellGroupControls.hpp:54
void getGroupInjectionControl(const Group &group, const WellState< Scalar, IndexTraits > &well_state, const GroupState< Scalar > &group_state, const Schedule &schedule, const SummaryState &summaryState, const InjectorType &injectorType, const EvalWell &bhp, const EvalWell &injection_rate, const RateConvFunc &rateConverter, Scalar efficiencyFactor, EvalWell &control_eq, DeferredLogger &deferred_logger) const
Definition: WellInterfaceGeneric.hpp:53
Definition: WellState.hpp:66
Definition: blackoilboundaryratevector.hh:39
int RegionId
Definition: WellConstraints.hpp:37