My Project
Loading...
Searching...
No Matches
HandlerContext.hpp
1/*
2 Copyright 2013 Statoil 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#ifndef HANDLER_CONTEXT_HPP
20#define HANDLER_CONTEXT_HPP
21
22#include <opm/common/OpmLog/KeywordLocation.hpp>
23
24#include <opm/input/eclipse/Schedule/Action/ActionResult.hpp>
25
26#include <cstddef>
27#include <optional>
28#include <set>
29#include <string>
30#include <unordered_map>
31#include <vector>
32
33namespace Opm::Action {
34 class WGNames;
35}
36
37namespace Opm {
38class DeckKeyword;
39class DeckRecord;
40class ErrorGuard;
41class ParseContext;
42class Schedule;
43class ScheduleBlock;
44class ScheduleGrid;
45class ScheduleState;
46struct ScheduleStatic;
47struct SimulatorUpdate;
48enum class WellStatus;
49class WelSegsSet;
50}
51
52namespace Opm {
54{
55public:
59 const ScheduleBlock& block_,
60 const DeckKeyword& keyword_,
61 const ScheduleGrid& grid_,
62 const std::size_t currentStep_,
64 bool action_mode_,
65 const ParseContext& parseContext_,
66 ErrorGuard& errors_,
67 SimulatorUpdate* sim_update_,
68 const std::unordered_map<std::string, double>* target_wellpi_,
69 std::unordered_map<std::string, double>& wpimult_global_factor_,
70 WelSegsSet* welsegs_wells_,
71 std::set<std::string>* compsegs_wells_)
72 : block(block_)
73 , keyword(keyword_)
74 , currentStep(currentStep_)
75 , matches(matches_)
76 , action_mode(action_mode_)
77 , parseContext(parseContext_)
78 , errors(errors_)
79 , wpimult_global_factor(wpimult_global_factor_)
80 , grid(grid_)
81 , target_wellpi(target_wellpi_)
82 , welsegs_wells(welsegs_wells_)
83 , compsegs_wells(compsegs_wells_)
84 , sim_update(sim_update_)
85 , schedule_(schedule)
86 {}
87
89 void affected_well(const std::string& well_name);
90
92 void welpi_well(const std::string& well_name);
93
95 void record_tran_change();
96
99
102
104 const ScheduleStatic& static_schedule() const;
105
107 void welsegs_handled(const std::string& well_name);
108
110 void compsegs_handled(const std::string& well_name);
111
113 void setExitCode(int code);
114
116 bool updateWellStatus(const std::string& well,
117 WellStatus status,
118 std::optional<KeywordLocation> location = {});
119
121 WellStatus getWellStatus(const std::string& well) const;
122
124 void addGroup(const std::string& groupName);
126 void addGroupToGroup(const std::string& parent_group,
127 const std::string& child_group);
128
130 void welspecsCreateNewWell(const DeckRecord& record,
131 const std::string& wellName,
132 const std::string& groupName);
133
135 void welspecsUpdateExistingWells(const DeckRecord& record,
136 const std::vector<std::string>& wellNames,
137 const std::string& groupName);
138
140 double getWellPI(const std::string& well_name) const;
141
143 double elapsed_seconds() const;
144
146 void invalidNamePattern(const std::string& namePattern) const;
147
149 const Action::WGNames& action_wgnames() const;
150
152 std::vector<std::string> groupNames(const std::string& pattern) const;
153
156 std::vector<std::string>
157 wellNames(const std::string& pattern) const;
158
162 std::vector<std::string>
163 wellNames(const std::string& pattern, bool allowEmpty) const;
164
165 const ScheduleBlock& block;
166 const DeckKeyword& keyword;
167 const std::size_t currentStep;
168 const Action::Result::MatchingEntities& matches;
169 const bool action_mode;
170 const ParseContext& parseContext;
171 ErrorGuard& errors;
172 std::unordered_map<std::string, double>& wpimult_global_factor;
173 const ScheduleGrid& grid;
174
175private:
176 const std::unordered_map<std::string, double>* target_wellpi{nullptr};
177 WelSegsSet* welsegs_wells{nullptr};
178 std::set<std::string>* compsegs_wells{nullptr};
179 SimulatorUpdate* sim_update{nullptr};
180 Schedule& schedule_;
181};
182
183} // end namespace Opm
184
185#endif // HANDLER_CONTEXT_HPP
Container of matching entities.
Definition ActionResult.hpp:174
Definition DeckKeyword.hpp:36
Definition ErrorGuard.hpp:30
Definition HandlerContext.hpp:54
void compsegs_handled(const std::string &well_name)
Mark that the well occured in a COMPSEGS keyword.
Definition HandlerContext.cpp:78
void addGroupToGroup(const std::string &parent_group, const std::string &child_group)
Adds a group to a group.
Definition HandlerContext.cpp:178
void setExitCode(int code)
Set exit code.
Definition HandlerContext.cpp:90
void welspecsCreateNewWell(const DeckRecord &record, const std::string &wellName, const std::string &groupName)
Create a new Well from a WELSPECS record.
Definition HandlerContext.cpp:184
ScheduleState & state()
Returns a reference to current state.
Definition HandlerContext.cpp:85
void addGroup(const std::string &groupName)
Adds a group to the schedule.
Definition HandlerContext.cpp:173
void record_well_structure_change()
Mark that well structure has changed.
Definition HandlerContext.cpp:64
void welpi_well(const std::string &well_name)
Mark that a well is affected by WELPI.
Definition HandlerContext.cpp:50
std::vector< std::string > groupNames(const std::string &pattern) const
Obtain well group names from a pattern.
Definition HandlerContext.cpp:155
void welspecsUpdateExistingWells(const DeckRecord &record, const std::vector< std::string > &wellNames, const std::string &groupName)
Update one or more existing wells from a WELSPECS record.
Definition HandlerContext.cpp:213
WellStatus getWellStatus(const std::string &well) const
Get status of a well.
Definition HandlerContext.cpp:103
const Action::WGNames & action_wgnames() const
Obtain action well group names.
Definition HandlerContext.cpp:149
void record_tran_change()
Mark that transmissibilities must be recalculated.
Definition HandlerContext.cpp:57
double getWellPI(const std::string &well_name) const
Obtain PI for a well.
Definition HandlerContext.cpp:113
void invalidNamePattern(const std::string &namePattern) const
Adds parse error for an invalid name pattern.
Definition HandlerContext.cpp:132
std::vector< std::string > wellNames(const std::string &pattern) const
Obtain well names from a pattern.
Definition HandlerContext.cpp:167
HandlerContext(Schedule &schedule, const ScheduleBlock &block_, const DeckKeyword &keyword_, const ScheduleGrid &grid_, const std::size_t currentStep_, const Action::Result::MatchingEntities &matches_, bool action_mode_, const ParseContext &parseContext_, ErrorGuard &errors_, SimulatorUpdate *sim_update_, const std::unordered_map< std::string, double > *target_wellpi_, std::unordered_map< std::string, double > &wpimult_global_factor_, WelSegsSet *welsegs_wells_, std::set< std::string > *compsegs_wells_)
Definition HandlerContext.hpp:58
double elapsed_seconds() const
Returns elapsed time since simulation start in seconds.
Definition HandlerContext.cpp:127
void welsegs_handled(const std::string &well_name)
Mark that the well occured in a WELSEGS keyword.
Definition HandlerContext.cpp:71
bool updateWellStatus(const std::string &well, WellStatus status, std::optional< KeywordLocation > location={})
Update status of a well.
Definition HandlerContext.cpp:95
const ScheduleStatic & static_schedule() const
Returns a const-ref to the static schedule.
Definition HandlerContext.cpp:108
void affected_well(const std::string &well_name)
Mark that a well has changed.
Definition HandlerContext.cpp:43
Definition ParseContext.hpp:84
Definition ScheduleBlock.hpp:52
Collection of intersected cells and associate properties for all simulation grids,...
Definition ScheduleGrid.hpp:50
Definition ScheduleState.hpp:97
Definition Schedule.hpp:101
Definition WelSegsSet.hpp:34
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Definition ScheduleStatic.hpp:40
This struct is used to communicate back from the Schedule::applyAction() what needs to be updated in ...
Definition SimulatorUpdate.hpp:33