My Project
FieldPropsManager.hpp
1/*
2 Copyright 2019 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 it under the terms
7 of the GNU General Public License as published by the Free Software
8 Foundation, either version 3 of the License, or (at your option) any later
9 version.
10
11 OPM is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14
15 You should have received a copy of the GNU General Public License along with
16 OPM. If not, see <http://www.gnu.org/licenses/>.
17*/
18
19#ifndef FIELDPROPS_MANAGER_HPP
20#define FIELDPROPS_MANAGER_HPP
21
22#include <memory>
23#include <string>
24#include <unordered_map>
25#include <vector>
26
27namespace Opm {
28
29class EclipseGrid;
30class Deck;
31class DeckKeyword;
32namespace Fieldprops {
33class TranCalculator;
34template<typename T> struct FieldData;
35}
36class FieldProps;
37class Phases;
38class TableManager;
39class NumericalAquifers;
40
42
43
44public:
45 // The default constructor should be removed when the FieldPropsManager is mandatory
46 // The default constructed fieldProps object is **NOT** usable
47 FieldPropsManager() = default;
48 FieldPropsManager(const Deck& deck, const Phases& ph, const EclipseGrid& grid, const TableManager& tables);
49 virtual ~FieldPropsManager() = default;
50
51 virtual void reset_actnum(const std::vector<int>& actnum);
52 const std::string& default_region() const;
53 virtual std::vector<int> actnum() const;
54 virtual std::vector<double> porv(bool global = false) const;
55
56
57 void apply_schedule_keywords(const std::vector<DeckKeyword>& keywords);
58
60 bool is_usable() const;
61
62 /*
63 The number of cells in the fields managed by this FieldPropsManager.
64 Initially this will correspond to the number of active cells in the grid
65 used when constructing the FieldPropsManager, but using the reset_actnum()
66 method it is possible to deactivate additional cells.
67 */
68 std::size_t active_size() const;
69
70 bool operator==(const FieldPropsManager& other) const;
71 static bool rst_cmp(const FieldPropsManager& full_arg, const FieldPropsManager& rst_arg);
72 /*
73 Because the FieldProps class can autocreate properties the semantics of
74 get() and has() is slightly non intuitve:
75
76 - The has<T>("KW") method will check if the current FieldProps container
77 has an installed "KW" keyword; if the container has the keyword in
78 question it will check if all elements have been assigned a value - only
79 in that case will it return true. The has<T>("KW") method will *not* try
80 to create a new keyword.
81
82 - The has<T>("KW") method will *not* consult the supported<T>("KW")
83 method; i.e. if you ask has<T>("UNKNOWN_KEYWORD") you will just get a
84 false.
85
86 - The get<T>("KW") method will try to create a new keyword if it does not
87 already have the keyword you are asking for. This implies that you can
88 get the following non intuitive sequence of events:
89
90 FieldPropsManager fpm(deck, grid);
91
92 fpm.has<int>("SATNUM"); => false
93 auto satnum = fpm.get<int>("SATNUM"); => SATNUM is autocreated
94 fpm.has<int>("SATNUM"); => true
95
96 - When checking whether the container has the keyword you should rephrase
97 the question slightly:
98
99 * Does the container have the keyword *right now* => has<T>("KW")
100 * Can the container provide the keyword => ptr = try_get<T>("KW")
101
102 - It is quite simple to create a deck where the keywords are only partly
103 initialized, all the methods in the FieldPropsManager only consider
104 fully initialized keywords.
105 */
106
107
108 /*
109 The get_copy() has exactly the same behaviour as get(), but the important
110 difference is that said keyword is not already in the container it is not
111 installed in the container; if we look at SATNUM which is a keywor which
112 can be automatically instantiated we have the following behavior:
113
114 get():
115 fp.has<int>("SATNUM") -> false
116 const std::vector<int>& satnum = fp.get<int>("SATNUM")
117 fp.has<int>("SATNUM") -> true;
118
119
120 get_copy():
121 fp.has<int>("SATNUM") -> false
122 const std::vector<int>& satnum = fp.get_copy<int>("SATNUM")
123 fp.has<int>("SATNUM") -> false
124 */
125
126
127 template <typename T>
128 std::vector<T> get_copy(const std::string& keyword, bool global=false) const;
129
130 /*
131 Will return a pointer to the keyword data, or nullptr if the container
132 does not have suce a keyword. Observe that container will hold on to an
133 manage the underlying keyword data.
134
135 The try_get function will return a nullptr if the container does not
136 contain said keyword, or if the keyword has not been fully initialized. If
137 you ask for a totally unknown keyword the method will return nullptr.
138 */
139 template <typename T> const std::vector<T>* try_get(const
140 std::string& keyword) const;
141
142 /*
143 You can ask whether the elements in the keyword have a default value -
144 which typically is calculated in some way, or if it has been explicitly
145 assigned to in the deck.
146 */
147 template <typename T>
148 std::vector<bool> defaulted(const std::string& keyword) const;
149
150
151 /*
152 Check whether the container supports/recognizes a keyword at all:
153
154 supported<double>("PORO") => true
155 supported<double>("NO_SUCH_KEYWORD") => false
156
157 The method does not at all consult the content of the container - it is a
158 static method.
159 */
160 template <typename T>
161 static bool supported(const std::string& keyword);
162
163 /*
164 The keys() function will return a list of keys corresponding to the fully
165 initialized keywords in the container. Observe that the implementation
166 special cases the PORV and ACTNUM keywords, since these are present with
167 special functions porv(bool) and actnum() the "PORV" and "ACTNUM" string
168 literals are excluded from the keys() list.
169 */
170 template <typename T>
171 std::vector<std::string> keys() const;
172
174 get_int_field_data(const std::string& keyword) const;
175
180 get_double_field_data(const std::string& keyword, bool allow_unsupported=false) const;
181 virtual const std::vector<int>& get_int(const std::string& keyword) const { return this->get<int>(keyword); }
182 virtual std::vector<int> get_global_int(const std::string& keyword) const { return this->get_global<int>(keyword); }
183
184 virtual const std::vector<double>& get_double(const std::string& keyword) const { return this->get<double>(keyword); }
185 virtual std::vector<double> get_global_double(const std::string& keyword) const { return this->get_global<double>(keyword); }
186
187 virtual bool has_int(const std::string& keyword) const { return this->has<int>(keyword); }
188 virtual bool has_double(const std::string& keyword) const { return this->has<double>(keyword); }
189
190 /*
191 The transmissibility keywords TRANX, TRANY and TRANZ do not really fit
192 well in the FieldProps system. The opm codebase is based on a full
193 internalization in the parse phase, and then passing fully assembled
194 objects to the simulator. When it comes to the transmissibilities this
195 model breaks down because the input code in opm-common is not capable of
196 calculating the transmissibility, that is performed in the simulator.
197
198 The EDIT section can have modifiers on TRAN, these must be applied *after*
199 the initial transmissibilities are calculated. To support this all the
200 modifiers to the TRAN{XYZ} fields are assembled in "transmissibility
201 calculators", and then these modifiers can be applied to a TRAN vector
202 after it has been calculated in the simulator. Usage from the simulator
203 could look like:
204
205
206 const auto& fp = eclState.fieldProps();
207
208 // Calculate transmissibilities using grid and permeability
209 std::vector<double> tranx = ....
210
211 // Check if there are any active TRANX modifiers and apply them
212 if (fp.tran_active("TRANX"))
213 fp.apply_tran("TRANX", tranx);
214
215
216 */
217
218 /*
219 Will check if there are any TRAN{XYZ} modifiers active in the deck.
220 */
221 virtual bool tran_active(const std::string& keyword) const;
222
223
224 /*
225 Will apply all the TRAN modifiers which are present in the deck on the
226 already initialized vector tran_data. The vector tran_data should be
227 organised as the data vectors in the fieldpropsmanager - i.e. one element
228 for each active cell - in lexicographical order. The operations which are
229 supported by the transmissibility calculator are those given by the enum
230 ScalarOperation in FieldProps.hpp.
231 */
232 virtual void apply_tran(const std::string& keyword, std::vector<double>& tran_data) const;
233
234 void apply_numerical_aquifers(const NumericalAquifers& aquifers);
235
236 const std::unordered_map<std::string,Fieldprops::TranCalculator>& getTran() const;
237
238private:
239 /*
240 Return the keyword values as a std::vector<>. All elements in the return
241 value are guaranteed to be assigned a valid value. If the keyword is not
242 in the container, or not all elements have a valid value - an exception
243 will be raised:
244
245 - keyword which is not supported at all -> std::logic_error
246 - keyword which is not in the deck at all -> std::out_of_range
247 - keyword which has not been fully initialized -> std::runtime_error
248
249 Many of the keywords in the container can be automatically created, in
250 that case the get() method will silently create a new keyword and default
251 initialize if it is not already in the container. The different exceptions
252 raised for the different error conditions are the same for get(),
253 get_copy() and get_global().
254 */
255 template <typename T>
256 const std::vector<T>& get(const std::string& keyword) const;
257
258 /*
259 Will check if the container has the keyword loaded; in a fully initialized
260 state. If you ask for a keyword which is not supported at all you will
261 just get false back.
262 */
263 template <typename T>
264 bool has(const std::string& keyword) const;
265
266 /*
267 This is exactly like the get() method, but the returned vector will have
268 global cartesian size. If the field has a default value that value will be
269 used for filling in in the inactive cells, otherwise zero is used.
270 */
271 template <typename T>
272 std::vector<T> get_global(const std::string& keyword) const;
273
274 std::shared_ptr<FieldProps> fp;
275};
276
277template<class MapType>
278void apply_tran(const std::unordered_map<std::string, Fieldprops::TranCalculator>& tran,
279 const MapType& double_data,
280 std::size_t active_size,
281 const std::string& keyword, std::vector<double>& data);
282
283}
284
285#endif
Definition: Deck.hpp:49
About cell information and dimension: The actual grid information is held in a pointer to an ERT ecl_...
Definition: EclipseGrid.hpp:54
Definition: FieldPropsManager.hpp:41
const Fieldprops::FieldData< double > & get_double_field_data(const std::string &keyword, bool allow_unsupported=false) const
Get double field data associated with a keyword.
bool is_usable() const
Whether we can call methods on the manager.
Definition: Runspec.hpp:37
Definition: TableManager.hpp:65
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition: Exceptions.hpp:30
Definition: FieldData.hpp:55