My Project
Loading...
Searching...
No Matches
EclipseState.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
20#ifndef OPM_ECLIPSE_STATE_HPP
21#define OPM_ECLIPSE_STATE_HPP
22
23#include <opm/input/eclipse/EclipseState/Aquifer/AquiferConfig.hpp>
24#include <opm/input/eclipse/EclipseState/Compositional/CompositionalConfig.hpp>
25#include <opm/input/eclipse/EclipseState/EclipseConfig.hpp>
26#include <opm/input/eclipse/EclipseState/Grid/EclipseGrid.hpp>
27#include <opm/input/eclipse/EclipseState/Grid/FIPRegionStatistics.hpp>
28#include <opm/input/eclipse/EclipseState/Grid/FaultCollection.hpp>
29#include <opm/input/eclipse/EclipseState/Grid/FieldPropsManager.hpp>
30#include <opm/input/eclipse/EclipseState/Grid/LgrCollection.hpp>
31#include <opm/input/eclipse/EclipseState/Grid/NNC.hpp>
32#include <opm/input/eclipse/EclipseState/Grid/TransMult.hpp>
33#include <opm/input/eclipse/EclipseState/MICPpara.hpp>
34#include <opm/input/eclipse/EclipseState/Runspec.hpp>
35#include <opm/input/eclipse/EclipseState/SimulationConfig/SimulationConfig.hpp>
36#include <opm/input/eclipse/EclipseState/Tables/TableManager.hpp>
37#include <opm/input/eclipse/EclipseState/TracerConfig.hpp>
38#include <opm/input/eclipse/EclipseState/Co2StoreConfig.hpp>
39#include <opm/input/eclipse/EclipseState/WagHysteresisConfig.hpp>
40
41#include <opm/input/eclipse/Units/UnitSystem.hpp>
42
43#include <cstddef>
44#include <memory>
45#include <optional>
46#include <vector>
47
48namespace Opm {
49 class Deck;
50 class DeckKeyword;
51 class InitConfig;
52 class IOConfig;
53 class DeckSection;
54} // namespace Opm
55
56namespace Opm { namespace RestartIO {
57 class RstAquifer;
58 class RstNetwork;
59}} // namespace Opm::RestartIO
60
61namespace Opm {
62
64 public:
65 enum EnabledTypes {
66 IntProperties = 0x01,
67 DoubleProperties = 0x02,
68
69 AllProperties = IntProperties | DoubleProperties
70 };
71
72 EclipseState() = default;
73 explicit EclipseState(const Deck& deck);
74 virtual ~EclipseState() = default;
75
76 const IOConfig& getIOConfig() const;
78
79 const InitConfig& getInitConfig() const;
81
82 const SimulationConfig& getSimulationConfig() const;
83 virtual const EclipseGrid& getInputGrid() const;
84
85 const FaultCollection& getFaults() const;
86 const TransMult& getTransMult() const;
87 TransMult& getTransMult();
88
91 const NNC& getInputNNC() const;
93 const std::vector<NNCdata>& getPinchNNC() const;
94 void appendInputNNC(const std::vector<NNCdata>& nnc);
95 void setInputNNC(const NNC& nnc);
97 void setPinchNNC(std::vector<NNCdata>&& nnc);
98 bool hasInputNNC() const;
99 bool hasPinchNNC() const;
100
101 // The potentially parallelized field properties
102 virtual const FieldPropsManager& fieldProps() const;
103 // Always the non-parallel field properties
104 virtual const FieldPropsManager& globalFieldProps() const;
105
106 virtual void computeFipRegionStatistics();
107 const FIPRegionStatistics& fipRegionStatistics() const;
108
109 const TableManager& getTableManager() const;
110 const EclipseConfig& getEclipseConfig() const;
111 const EclipseConfig& cfg() const;
112 const GridDims& gridDims() const;
113
114 const LgrCollection& getLgrs() const;
115 bool hasInputLGR() const;
116
117 // the unit system used by the deck. note that it is rarely needed
118 // to convert units because internally to opm-parser everything is
119 // represented by SI units.
120 const UnitSystem& getDeckUnitSystem() const;
121 const UnitSystem& getUnits() const;
122
123 const std::string& getTitle() const;
124
125 void apply_schedule_keywords(const std::vector<DeckKeyword>& keywords);
126
127 const Runspec& runspec() const;
128 const AquiferConfig& aquifer() const;
129 const CompositionalConfig& compositionalConfig() const;
130 const TracerConfig& tracer() const;
131 const MICPpara& getMICPpara() const;
132 const WagHysteresisConfig& getWagHysteresis() const;
133 const Co2StoreConfig& getCo2StoreConfig() const;
134
135 void prune_global_for_schedule_run();
136 void reset_actnum(const std::vector<int>& new_actnum);
137 void set_active_indices(const std::vector<int>& indices);
138 void pruneDeactivatedAquiferConnections(const std::vector<std::size_t>& deactivated_cells);
139 void loadRestartAquifers(const RestartIO::RstAquifer& aquifers);
140 // TODO: it is possible that the aquifer are opened through SCHEDULE and not specified in the SOLUTION section
141 // For the ease of the implementation, we create inactive aquifer in the AquiferConfig.
142 // At the moment, it only works for Constant Flux Aquifers(AQUFLUX) as indicated by the function name
143 // When we know and decide to handle the same for AQUFETP and AQUCT, this part will be refactored
144 void appendAqufluxSchedule(const std::unordered_set<int>& ids);
145
146 void loadRestartNetworkPressures(const RestartIO::RstNetwork& network);
147 const std::optional<std::map<std::string, double> >& getRestartNetworkPressures() const { return this->m_restart_network_pressures; }
148
149 template<class Serializer>
150 void serializeOp(Serializer& serializer)
151 {
152 // FieldPropsManager is handled through a different mechanism.
153 // Do not add the member (i.e., field_props) to this list.
154 serializer(m_tables);
155 serializer(m_runspec);
156 serializer(m_eclipseConfig);
157 serializer(m_deckUnitSystem);
158 serializer(m_inputNnc);
159 serializer(m_pinchNnc);
160 serializer(m_gridDims);
161 serializer(m_lgrs);
162 serializer(m_simulationConfig);
163 serializer(aquifer_config);
164 serializer(compositional_config),
165 serializer(m_transMult);
166 serializer(m_faults);
167 serializer(m_title);
168 serializer(tracer_config);
169 serializer(m_micppara);
170 serializer(wag_hyst_config);
171 serializer(co2_store_config);
172 serializer(this->fipRegionStatistics_);
173 }
174
175 static bool rst_cmp(const EclipseState& full_state, const EclipseState& rst_state);
176
177 private:
178 void initIOConfigPostSchedule(const Deck& deck);
179 void assignRunTitle(const Deck& deck);
180 void reportNumberOfActivePhases() const;
181 void initLgrs(const Deck& deck);
182 void conveyNumericalAquiferEffects();
183 void applyMULTXYZ();
184 void initFaults(const Deck& deck);
185 void initPara(const Deck& deck);
186
187 void setMULTFLT(const Opm::DeckSection& section, bool edit = false);
188
189 void complainAboutAmbiguousKeyword(const Deck& deck,
190 const std::string& keywordName);
191
192 protected:
193 TableManager m_tables;
194 Runspec m_runspec;
195 EclipseConfig m_eclipseConfig;
196 UnitSystem m_deckUnitSystem;
197 EclipseGrid m_inputGrid;
198 NNC m_inputNnc;
199 std::vector<NNCdata> m_pinchNnc;
200 GridDims m_gridDims;
201 FieldPropsManager field_props;
202 LgrCollection m_lgrs;
203 SimulationConfig m_simulationConfig;
204 AquiferConfig aquifer_config;
205 CompositionalConfig compositional_config;
206 TransMult m_transMult;
207 TracerConfig tracer_config;
208 MICPpara m_micppara;
209 WagHysteresisConfig wag_hyst_config;
210 Co2StoreConfig co2_store_config;
211
212 std::string m_title{};
213 FaultCollection m_faults{};
214
215 std::optional<std::map<std::string, double> > m_restart_network_pressures{std::nullopt};
216
217 std::optional<FIPRegionStatistics> fipRegionStatistics_{std::nullopt};
218 };
219} // namespace Opm
220
221#endif // OPM_ECLIPSE_STATE_HPP
Definition AquiferConfig.hpp:46
Definition Co2StoreConfig.hpp:33
Definition CompositionalConfig.hpp:34
Definition DeckSection.hpp:47
Definition Deck.hpp:49
Definition EclipseConfig.hpp:32
About cell information and dimension: The actual grid information is held in a pointer to an ERT ecl_...
Definition EclipseGrid.hpp:55
Definition EclipseState.hpp:63
const EclipseConfig & getEclipseConfig() const
[[deprecated]] — use cfg()
Definition EclipseState.cpp:255
void setPinchNNC(std::vector< NNCdata > &&nnc)
Set NNCs created by PINCH.
Definition EclipseState.cpp:311
const std::vector< NNCdata > & getPinchNNC() const
Get sorted vector of NNCs created by PINCH.
Definition EclipseState.cpp:303
const IOConfig & getIOConfig() const
[[deprecated]] — use cfg().io()
Definition EclipseState.cpp:236
const NNC & getInputNNC() const
non-neighboring connections the non-standard adjacencies as specified in input deck
Definition EclipseState.cpp:299
const InitConfig & getInitConfig() const
[[deprecated]] — use cfg().init()
Definition EclipseState.cpp:246
Basic descriptive statistics about a model's fluid-in-place regions.
Definition FIPRegionStatistics.hpp:40
Definition FaultCollection.hpp:35
Definition FieldPropsManager.hpp:42
Definition GridDims.hpp:31
Definition IOConfig.hpp:143
Definition InitConfig.hpp:32
Definition LgrCollection.hpp:33
Definition MICPpara.hpp:26
Definition NNC.hpp:102
Definition aquifer.hpp:45
Definition network.hpp:39
Definition Runspec.hpp:480
Class for (de-)serializing.
Definition Serializer.hpp:91
Definition SimulationConfig.hpp:38
Definition TableManager.hpp:66
Definition TracerConfig.hpp:33
Definition TransMult.hpp:52
Definition UnitSystem.hpp:34
Definition WagHysteresisConfig.hpp:30
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30