My Project
WVFPEXP.hpp
1 /*
2  Copyright 2022 Equinor.
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 WVFPEXP_HPP_HEADER_INCLUDED
21 #define WVFPEXP_HPP_HEADER_INCLUDED
22 
23 namespace Opm {
24  class DeckRecord;
25 } // namespace Opm
26 
27 namespace Opm { namespace RestartIO {
28  struct RstWell;
29 }} // namespace Opm::RestartIO
30 
31 namespace Opm {
32 
33  class WVFPEXP
34  {
35  public:
36  static WVFPEXP serializationTestObject();
37 
38  void update(const DeckRecord& record);
39  void update(const RestartIO::RstWell& rst_well);
40 
41  bool explicit_lookup() const;
42  bool shut() const;
43  bool prevent() const;
44 
45  bool report_first() const;
46  bool report_every() const;
47 
48  bool operator==(const WVFPEXP& other) const;
49  bool operator!=(const WVFPEXP& other) const;
50 
51  template<class Serializer>
52  void serializeOp(Serializer& serializer)
53  {
54  serializer(m_explicit);
55  serializer(m_shut);
56  serializer(m_prevent);
57  }
58 
59  private:
60  enum class Prevent : unsigned char { No, ReportFirst, ReportEvery };
61 
62  bool m_explicit{false};
63  bool m_shut{false};
64  Prevent m_prevent{Prevent::No};
65  };
66 
67 } // namespace Opm
68 
69 #endif // WVFPEXP_HPP_HEADER_INCLUDED
Definition: DeckRecord.hpp:32
Class for (de-)serializing.
Definition: Serializer.hpp:75
Definition: WVFPEXP.hpp:34
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition: Exceptions.hpp:29
Definition: well.hpp:43