My Project
Loading...
Searching...
No Matches
Summary.hpp
1/*
2 Copyright 2016 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_OUTPUT_SUMMARY_HPP
21#define OPM_OUTPUT_SUMMARY_HPP
22
23#include <opm/output/data/Aquifer.hpp>
25
26#include <map>
27#include <memory>
28#include <optional>
29#include <string>
30#include <unordered_map>
31#include <utility>
32#include <vector>
33
34namespace Opm {
35 class EclipseGrid;
36 class EclipseState;
37 class Inplace;
38 class Schedule;
39 class SummaryConfig;
40 class SummaryState;
41} // namespace Opm
42
43namespace Opm { namespace data {
44 class GroupAndNetworkValues;
45 class InterRegFlowMap;
46 struct WellBlockAveragePressures;
47 class Wells;
48}} // namespace Opm::data
49
50namespace Opm { namespace out {
51
53{
54public:
55 using GlobalProcessParameters = std::map<std::string, double>;
56 using RegionParameters = std::map<std::string, std::vector<double>>;
57 using BlockValues = std::map<std::pair<std::string, int>, double>;
58 using InterRegFlowValues = std::unordered_map<std::string, data::InterRegFlowMap>;
59
60 Summary(SummaryConfig& sumcfg,
61 const EclipseState& es,
62 const EclipseGrid& grid,
63 const Schedule& sched,
64 const std::string& basename = "",
65 const bool writeEsmry = false);
66
67 ~Summary();
68
69 void add_timestep(const SummaryState& st, const int report_step, bool isSubstep);
70
71 void eval(SummaryState& summary_state,
72 const int report_step,
73 const double secs_elapsed,
74 const data::Wells& well_solution,
76 const data::GroupAndNetworkValues& group_and_nwrk_solution,
77 const GlobalProcessParameters& single_values,
78 const std::optional<Inplace>& initial_inplace,
79 const Inplace& inplace,
80 const RegionParameters& region_values = {},
81 const BlockValues& block_values = {},
82 const data::Aquifers& aquifers_values = {},
83 const InterRegFlowValues& interreg_flows = {}) const;
84
85 void write(const bool is_final_summary = false) const;
86
87private:
89 std::unique_ptr<SummaryImplementation> pImpl_;
90};
91
92}} // namespace Opm::out
93
94#endif //OPM_OUTPUT_SUMMARY_HPP
Facility for converting collection of region ID pairs into a sparse (CSR) adjacency matrix representa...
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
Definition Inplace.hpp:36
Definition Schedule.hpp:101
Definition SummaryConfig.hpp:133
Definition SummaryState.hpp:72
Definition Groups.hpp:212
Definition Wells.hpp:1096
Definition Summary.cpp:4765
Definition Summary.hpp:53
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Definition Wells.hpp:1184