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