My Project
TableManager.hpp
1/*
2 Copyright 2015 Statoil ASA.
3 Copyright 2018 IRIS
4
5 This file is part of the Open Porous Media project (OPM).
6
7 OPM is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 OPM is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with OPM. If not, see <http://www.gnu.org/licenses/>.
19 */
20
21#ifndef OPM_TABLE_MANAGER_HPP
22#define OPM_TABLE_MANAGER_HPP
23
24#include <cassert>
25#include <optional>
26#include <set>
27
28#include <opm/input/eclipse/EclipseState/Tables/DenT.hpp>
29#include <opm/input/eclipse/EclipseState/Tables/JouleThomson.hpp>
30#include <opm/input/eclipse/EclipseState/Tables/PvtgTable.hpp>
31#include <opm/input/eclipse/EclipseState/Tables/PvtgwTable.hpp>
32#include <opm/input/eclipse/EclipseState/Tables/PvtgwoTable.hpp>
33#include <opm/input/eclipse/EclipseState/Tables/PvtoTable.hpp>
34#include <opm/input/eclipse/EclipseState/Tables/PvtsolTable.hpp>
35#include <opm/input/eclipse/EclipseState/Tables/RocktabTable.hpp>
36#include <opm/input/eclipse/EclipseState/Tables/Rock2dTable.hpp>
37#include <opm/input/eclipse/EclipseState/Tables/Rock2dtrTable.hpp>
38#include <opm/input/eclipse/EclipseState/Tables/PlyshlogTable.hpp>
39#include <opm/input/eclipse/EclipseState/Tables/PvtwsaltTable.hpp>
40#include <opm/input/eclipse/EclipseState/Tables/RwgsaltTable.hpp>
41#include <opm/input/eclipse/EclipseState/Tables/BrineDensityTable.hpp>
42#include <opm/input/eclipse/EclipseState/Tables/SolventDensityTable.hpp>
43#include <opm/input/eclipse/EclipseState/Tables/StandardCond.hpp>
44#include <opm/input/eclipse/EclipseState/Tables/FlatTable.hpp>
45#include <opm/input/eclipse/EclipseState/Tables/SorwmisTable.hpp>
46#include <opm/input/eclipse/EclipseState/Tables/SgcwmisTable.hpp>
47#include <opm/input/eclipse/EclipseState/Tables/MiscTable.hpp>
48#include <opm/input/eclipse/EclipseState/Tables/PmiscTable.hpp>
49#include <opm/input/eclipse/EclipseState/Tables/MsfnTable.hpp>
50#include <opm/input/eclipse/EclipseState/Tables/JFunc.hpp>
51#include <opm/input/eclipse/EclipseState/Tables/Tabdims.hpp>
52#include <opm/input/eclipse/EclipseState/Tables/TableContainer.hpp>
53#include <opm/input/eclipse/EclipseState/Tables/Aqudims.hpp>
54#include <opm/input/eclipse/EclipseState/Tables/PlymwinjTable.hpp>
55#include <opm/input/eclipse/EclipseState/Tables/SkprwatTable.hpp>
56#include <opm/input/eclipse/EclipseState/Tables/SkprpolyTable.hpp>
57#include <opm/input/eclipse/EclipseState/Tables/Eqldims.hpp>
58#include <opm/input/eclipse/EclipseState/Tables/Regdims.hpp>
59#include <opm/input/eclipse/EclipseState/Tables/TLMixpar.hpp>
60
61namespace Opm {
62
63 class Deck;
64
66 public:
67 explicit TableManager( const Deck& deck );
68 TableManager() = default;
69
70 static TableManager serializationTestObject();
71
72 const TableContainer& getTables( const std::string& tableName ) const;
73 const TableContainer& operator[](const std::string& tableName) const;
74 bool hasTables( const std::string& tableName ) const;
75
76 const Tabdims& getTabdims() const;
77 const Eqldims& getEqldims() const;
78 const Aqudims& getAqudims() const;
79 const Regdims& getRegdims() const;
80 const TLMixpar& getTLMixpar() const;
81 /*
82 WIll return max{ Tabdims::NTFIP , Regdims::NTFIP }.
83 */
84 size_t numFIPRegions() const;
85
86 const TableContainer& getSwofTables() const;
87 const TableContainer& getSgwfnTables() const;
88 const TableContainer& getSof2Tables() const;
89 const TableContainer& getSof3Tables() const;
90 const TableContainer& getSgofTables() const;
91 const TableContainer& getSlgofTables() const;
92 const TableContainer& getSwfnTables() const;
93 const TableContainer& getSgfnTables() const;
94 const TableContainer& getSsfnTables() const;
95 const TableContainer& getRsvdTables() const;
96 const TableContainer& getRvvdTables() const;
97 const TableContainer& getRvwvdTables() const;
98 const TableContainer& getPbvdTables() const;
99 const TableContainer& getPdvdTables() const;
100 const TableContainer& getSaltvdTables() const;
101 const TableContainer& getSaltpvdTables() const;
102 const TableContainer& getSaltsolTables() const;
103 const TableContainer& getPermfactTables() const;
104 const TableContainer& getEnkrvdTables() const;
105 const TableContainer& getEnptvdTables() const;
106 const TableContainer& getImkrvdTables() const;
107 const TableContainer& getImptvdTables() const;
108 const TableContainer& getPvdgTables() const;
109 const TableContainer& getPvdoTables() const;
110 const TableContainer& getPvdsTables() const;
111 const TableContainer& getSpecheatTables() const;
112 const TableContainer& getSpecrockTables() const;
113 const TableContainer& getWatvisctTables() const;
114 const TableContainer& getOilvisctTables() const;
115 const TableContainer& getGasvisctTables() const;
116 const TableContainer& getRtempvdTables() const;
117 const TableContainer& getRocktabTables() const;
118 const TableContainer& getPlyadsTables() const;
119 const TableContainer& getPlyviscTables() const;
120 const TableContainer& getPlydhflfTables() const;
121 const TableContainer& getPlymaxTables() const;
122 const TableContainer& getPlyrockTables() const;
123 const TableContainer& getPlyshlogTables() const;
124 const TableContainer& getAqutabTables() const;
125 const TableContainer& getFoamadsTables() const;
126 const TableContainer& getFoammobTables() const;
127
128 const TableContainer& getSorwmisTables() const;
129 const TableContainer& getSgcwmisTables() const;
130 const TableContainer& getMiscTables() const;
131 const TableContainer& getPmiscTables() const;
132 const TableContainer& getMsfnTables() const;
133 const TableContainer& getTlpmixpaTables() const;
134
135 const TableContainer& getWsfTables() const;
136 const TableContainer& getGsfTables() const;
137
138 const JFunc& getJFunc() const;
139
140 const std::vector<PvtgTable>& getPvtgTables() const;
141 const std::vector<PvtgwTable>& getPvtgwTables() const;
142 const std::vector<PvtgwoTable>& getPvtgwoTables() const;
143 const std::vector<PvtoTable>& getPvtoTables() const;
144 const std::vector<PvtsolTable>& getPvtsolTables() const;
145 const std::vector<Rock2dTable>& getRock2dTables() const;
146 const std::vector<Rock2dtrTable>& getRock2dtrTables() const;
147 const TableContainer& getRockwnodTables() const;
148 const TableContainer& getOverburdTables() const;
149
150 const DenT& WatDenT() const;
151 const DenT& GasDenT() const;
152 const DenT& OilDenT() const;
153 const JouleThomson& WatJT() const;
154 const JouleThomson& GasJT() const;
155 const JouleThomson& OilJT() const;
156 const StandardCond& stCond() const;
157 std::size_t gas_comp_index() const;
158 const PvtwTable& getPvtwTable() const;
159 const std::vector<PvtwsaltTable>& getPvtwSaltTables() const;
160 const std::vector<RwgsaltTable>& getRwgSaltTables() const;
161 const std::vector<BrineDensityTable>& getBrineDensityTables() const;
162 const std::vector<SolventDensityTable>& getSolventDensityTables() const;
163
164 const PvcdoTable& getPvcdoTable() const;
165 const DensityTable& getDensityTable() const;
166 const DiffCoeffTable& getDiffusionCoefficientTable() const;
167 const DiffCoeffWatTable& getDiffusionCoefficientWaterTable() const;
168 const DiffCoeffGasTable& getDiffusionCoefficientGasTable() const;
169 const PlyvmhTable& getPlyvmhTable() const;
170 const RockTable& getRockTable() const;
171 const ViscrefTable& getViscrefTable() const;
172 const PlmixparTable& getPlmixparTable() const;
173 const ShrateTable& getShrateTable() const;
174 const Stone1exTable& getStone1exTable() const;
175 const WatdentTable& getWatdentTable() const;
176 const SgofletTable& getSgofletTable() const;
177 const SwofletTable& getSwofletTable() const;
178 const std::map<int, PlymwinjTable>& getPlymwinjTables() const;
179 const std::map<int, SkprwatTable>& getSkprwatTables() const;
180 const std::map<int, SkprpolyTable>& getSkprpolyTables() const;
181 const std::map<std::string, TableContainer>& getSimpleTables() const;
182
184 bool useImptvd() const;
185
187 bool useEnptvd() const;
188
190 bool useEqlnum() const;
191
193 bool useShrate() const;
194
196 bool useJFunc() const;
197
198 double rtemp() const;
199
200 double salinity() const;
201
202 bool operator==(const TableManager& data) const;
203
204 template<class Serializer>
205 void serializeOp(Serializer& serializer)
206 {
207 auto simpleTables = m_simpleTables;
208 auto split = splitSimpleTable(simpleTables);
209 serializer(simpleTables);
210 serializer(split.plyshMax);
211 serializer(split.plyshMap);
212 serializer(split.rockMax);
213 serializer(split.rockMap);
214 serializer(m_pvtgTables);
215 serializer(m_pvtgwTables);
216 serializer(m_pvtgwoTables);
217 serializer(m_pvtoTables);
218 serializer(m_pvtsolTables);
219 serializer(m_rock2dTables);
220 serializer(m_rock2dtrTables);
221 serializer(m_pvtwTable);
222 serializer(m_pvcdoTable);
223 serializer(m_densityTable);
224 serializer(m_diffCoeffTable);
225 serializer(m_diffCoeffWatTable);
226 serializer(m_diffCoeffGasTable);
227 serializer(m_plyvmhTable);
228 serializer(m_rockTable);
229 serializer(m_plmixparTable);
230 serializer(m_shrateTable);
231 serializer(m_stone1exTable);
232 serializer(m_viscrefTable);
233 serializer(m_watdentTable);
234 serializer(m_sgofletTable);
235 serializer(m_swofletTable);
236 serializer(m_pvtwsaltTables);
237 serializer(m_rwgsaltTables);
238 serializer(m_bdensityTables);
239 serializer(m_sdensityTables);
240 serializer(m_plymwinjTables);
241 serializer(m_skprwatTables);
242 serializer(m_skprpolyTables);
243 serializer(m_tabdims);
244 serializer(m_regdims);
245 serializer(m_eqldims);
246 serializer(m_aqudims);
247 serializer(hasImptvd);
248 serializer(hasEnptvd);
249 serializer(hasEqlnum);
250 serializer(hasShrate);
251 serializer(jfunc);
252 serializer(oilDenT);
253 serializer(gasDenT);
254 serializer(watDenT);
255 serializer(oilJT);
256 serializer(gasJT);
257 serializer(watJT);
258 serializer(stcond);
259 serializer(m_gas_comp_index);
260 serializer(m_rtemp);
261 serializer(m_salinity);
262 serializer(m_tlmixpar);
263 if (!serializer.isSerializing()) {
264 m_simpleTables = simpleTables;
265 if (split.plyshMax > 0) {
266 TableContainer container(split.plyshMax);
267 for (const auto& it : split.plyshMap) {
268 container.addTable(it.first, it.second);
269 }
270 m_simpleTables.insert(std::make_pair("PLYSHLOG", container));
271 }
272 if (split.rockMax > 0) {
273 TableContainer container(split.rockMax);
274 for (const auto& it : split.rockMap) {
275 container.addTable(it.first, it.second);
276 }
277 m_simpleTables.insert(std::make_pair("ROCKTAB", container));
278 }
279 }
280 }
281
282 private:
283 TableContainer& forceGetTables( const std::string& tableName , size_t numTables);
284
285 void complainAboutAmbiguousKeyword(const Deck& deck, const std::string& keywordName);
286
287 void addTables( const std::string& tableName , size_t numTables);
288 void initSimpleTables(const Deck& deck);
289 void initRTempTables(const Deck& deck);
290 void initDims(const Deck& deck);
291 void initRocktabTables(const Deck& deck);
292 void initGasvisctTables(const Deck& deck);
293
294 void initPlymaxTables(const Deck& deck);
295 void initPlyrockTables(const Deck& deck);
296 void initPlyshlogTables(const Deck& deck);
297
298 void initPlymwinjTables(const Deck& deck);
299 void initSkprwatTables(const Deck& deck);
300 void initSkprpolyTables(const Deck& deck);
301
302 //void initRockTables(const Deck& deck, const std::string& keywordName);
303
304 template <class TableType>
305 void initRockTables(const Deck& deck, const std::string& keywordName, std::vector<TableType>& rocktable );
306
307 template <class TableType>
308 void initPvtwsaltTables(const Deck& deck, std::vector<TableType>& pvtwtables );
309
310 template <class TableType>
311 void initRwgsaltTables(const Deck& deck, std::vector<TableType>& rwgtables );
312
313 template <class TableType>
314 void initBrineTables(const Deck& deck, std::vector<TableType>& brinetables );
315
316 void initSolventTables(const Deck& deck, std::vector<SolventDensityTable>& solventtables);
317
321 template <class TableType>
322 void initSimpleTableContainerWithJFunc(const Deck& deck,
323 const std::string& keywordName,
324 const std::string& tableName,
325 size_t numTables);
326
327 template <class TableType>
328 void initSimpleTableContainer(const Deck& deck,
329 const std::string& keywordName,
330 const std::string& tableName,
331 size_t numTables);
332
333 template <class TableType>
334 void initSimpleTableContainer(const Deck& deck,
335 const std::string& keywordName,
336 size_t numTables);
337
338 template <class TableType>
339 void initSimpleTableContainerWithJFunc(const Deck& deck,
340 const std::string& keywordName,
341 size_t numTables);
342
343 template <class TableType>
344 void initSimpleTable(const Deck& deck,
345 const std::string& keywordName,
346 std::vector<TableType>& tableVector);
347
348 template <class TableType>
349 void initFullTables(const Deck& deck,
350 const std::string& keywordName,
351 std::vector<TableType>& tableVector);
352
353 void checkPVTOMonotonicity(const Deck& deck) const;
354
355 void logPVTOMonotonicityFailure(const Deck& deck,
356 const std::size_t tableID,
357 const std::vector<PvtoTable::FlippedFVF>& flipped_Bo) const;
358
359 std::map<std::string , TableContainer> m_simpleTables;
360 std::vector<PvtgTable> m_pvtgTables;
361 std::vector<PvtgwTable> m_pvtgwTables;
362 std::vector<PvtgwoTable> m_pvtgwoTables;
363 std::vector<PvtoTable> m_pvtoTables;
364 std::vector<PvtsolTable> m_pvtsolTables;
365 std::vector<Rock2dTable> m_rock2dTables;
366 std::vector<Rock2dtrTable> m_rock2dtrTables;
367 PvtwTable m_pvtwTable;
368 PvcdoTable m_pvcdoTable;
369 DensityTable m_densityTable;
370 DiffCoeffTable m_diffCoeffTable;
371 DiffCoeffWatTable m_diffCoeffWatTable;
372 DiffCoeffGasTable m_diffCoeffGasTable;
373 PlyvmhTable m_plyvmhTable;
374 RockTable m_rockTable;
375 PlmixparTable m_plmixparTable;
376 ShrateTable m_shrateTable;
377 Stone1exTable m_stone1exTable;
378 ViscrefTable m_viscrefTable;
379 WatdentTable m_watdentTable;
380 SgofletTable m_sgofletTable;
381 SwofletTable m_swofletTable;
382 std::vector<PvtwsaltTable> m_pvtwsaltTables;
383 std::vector<RwgsaltTable> m_rwgsaltTables;
384 std::vector<BrineDensityTable> m_bdensityTables;
385 std::vector<SolventDensityTable> m_sdensityTables;
386 std::map<int, PlymwinjTable> m_plymwinjTables;
387 std::map<int, SkprwatTable> m_skprwatTables;
388 std::map<int, SkprpolyTable> m_skprpolyTables;
389
390 Tabdims m_tabdims;
391 Regdims m_regdims;
392 Eqldims m_eqldims;
393 Aqudims m_aqudims;
394 TLMixpar m_tlmixpar;
395
396 bool hasImptvd = false;// if deck has keyword IMPTVD
397 bool hasEnptvd = false;// if deck has keyword ENPTVD
398 bool hasEqlnum = false;// if deck has keyword EQLNUM
399 bool hasShrate = false;// if deck has keyword SHRATE
400 std::optional<JFunc> jfunc;
401
402 DenT oilDenT;
403 DenT gasDenT;
404 DenT watDenT;
405 JouleThomson oilJT;
406 JouleThomson gasJT;
407 JouleThomson watJT;
408 StandardCond stcond;
409 std::size_t m_gas_comp_index = 77;
410 double m_rtemp {288.7056}; // 60 Fahrenheit in Kelvin
411 double m_salinity {0.0};
412
413 struct SplitSimpleTables {
414 size_t plyshMax = 0;
415 size_t rockMax = 0;
416 std::map<size_t, std::shared_ptr<PlyshlogTable>> plyshMap;
417 std::map<size_t, std::shared_ptr<RocktabTable>> rockMap;
418 };
419
420 SplitSimpleTables splitSimpleTable(std::map<std::string,TableContainer>& simpleTables);
421 };
422}
423
424
425#endif
426
Definition: Aqudims.hpp:34
Definition: Deck.hpp:49
Definition: DenT.hpp:30
Definition: Eqldims.hpp:32
Definition: JFunc.hpp:28
Definition: JouleThomson.hpp:30
Definition: Regdims.hpp:36
Class for (de-)serializing.
Definition: Serializer.hpp:84
bool isSerializing() const
Returns true if we are currently doing a serialization operation.
Definition: Serializer.hpp:183
Definition: TLMixpar.hpp:55
Definition: Tabdims.hpp:36
Definition: TableContainer.hpp:31
Definition: TableManager.hpp:65
bool useEqlnum() const
deck has keyword "EQLNUM" — Equilibriation region numbers
bool useJFunc() const
deck has keyword "JFUNC" — Use Leverett's J Function for capillary pressure
bool useEnptvd() const
deck has keyword "ENPTVD" — Saturation end-point versus depth tables
bool useImptvd() const
deck has keyword "IMPTVD" — Imbition end-point versus depth tables
bool useShrate() const
deck has keyword "SHRATE"
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition: Exceptions.hpp:30
Definition: FlatTable.hpp:130
Definition: FlatTable.hpp:242
Definition: FlatTable.hpp:185
Definition: FlatTable.hpp:214
Definition: FlatTable.hpp:378
Definition: FlatTable.hpp:412
Definition: FlatTable.hpp:353
Definition: FlatTable.hpp:280
Definition: FlatTable.hpp:316
Definition: FlatTable.hpp:632
Definition: FlatTable.hpp:437
Definition: StandardCond.hpp:24
Definition: FlatTable.hpp:462
Definition: FlatTable.hpp:622
Definition: FlatTable.hpp:518
Definition: FlatTable.hpp:549