EnptvdTable.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2014 by Andreas Lauser
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 #ifndef OPM_PARSER_ENPTVD_TABLE_HPP
20 #define OPM_PARSER_ENPTVD_TABLE_HPP
21 
22 #include "SimpleTable.hpp"
23 
24 namespace Opm {
25  // forward declaration
26  class TableManager;
27 
28  class EnptvdTable : public SimpleTable {
29  public:
30 
31  friend class TableManager;
32  EnptvdTable() = default;
33 
39  {
40  SimpleTable::init(item,
41  std::vector<std::string>{"DEPTH",
42  "SWCO",
43  "SWCRIT",
44  "SWMAX",
45  "SGCO",
46  "SGCRIT",
47  "SGMAX",
48  "SOWCRIT",
49  "SOGCRIT"});
50 
52  SimpleTable::checkMonotonic("DEPTH", /*isAscending=*/true);
61  }
62 
67 
68  // using this method is strongly discouraged but the current endpoint scaling
69  // code makes it hard to avoid
71 
72  const std::vector<double> &getDepthColumn() const
73  { return SimpleTable::getColumn(0); }
74 
78  const std::vector<double> &getSwcoColumn() const
79  { return SimpleTable::getColumn(1); }
80 
84  const std::vector<double> &getSwcritColumn() const
85  { return SimpleTable::getColumn(2); }
86 
90  const std::vector<double> &getSwmaxColumn() const
91  { return SimpleTable::getColumn(3); }
92 
96  const std::vector<double> &getSgcoColumn() const
97  { return SimpleTable::getColumn(4); }
98 
102  const std::vector<double> &getSgcritColumn() const
103  { return SimpleTable::getColumn(5); }
104 
108  const std::vector<double> &getSgmaxColumn() const
109  { return SimpleTable::getColumn(6); }
110 
114  const std::vector<double> &getSowcritColumn() const
115  { return SimpleTable::getColumn(7); }
116 
120  const std::vector<double> &getSogcritColumn() const
121  { return SimpleTable::getColumn(8); }
122  };
123 }
124 
125 #endif
126 
size_t numColumns() const
const std::vector< double > & getSgcoColumn() const
Connate gas saturation.
Definition: EnptvdTable.hpp:96
void init(Opm::DeckItemConstPtr deckItem, const std::vector< std::string > &columnNames)
Read simple tables from keywords like SWOF.
Definition: Deck.hpp:29
const std::vector< double > & getColumn(const std::string &name) const
const std::vector< double > & getSwcritColumn() const
Critical water saturation.
Definition: EnptvdTable.hpp:84
void checkNonDefaultable(const std::string &columnName)
Definition: EnptvdTable.hpp:28
const std::vector< double > & getDepthColumn() const
Definition: EnptvdTable.hpp:72
std::shared_ptr< const DeckItem > DeckItemConstPtr
Definition: DeckItem.hpp:127
Definition: TableManager.hpp:66
void init(Opm::DeckItemConstPtr item)
Read the ENPTVD keyword and provide some convenience methods for it.
Definition: EnptvdTable.hpp:38
const std::vector< double > & getSogcritColumn() const
Critical oil-in-gas saturation.
Definition: EnptvdTable.hpp:120
const std::vector< double > & getSowcritColumn() const
Critical oil-in-water saturation.
Definition: EnptvdTable.hpp:114
size_t numRows() const
static size_t numTables(Opm::DeckKeywordConstPtr keyword)
Returns the number of tables in a keyword.
double evaluate(const std::string &columnName, double xPos) const
Evaluate a column of the table at a given position.
const std::vector< double > & getSwmaxColumn() const
Maximum water saturation.
Definition: EnptvdTable.hpp:90
const std::vector< double > & getSgmaxColumn() const
Maximum gas saturation.
Definition: EnptvdTable.hpp:108
void checkMonotonic(const std::string &columnName, bool isAscending, bool isStrictlyMonotonic=true)
Definition: SimpleTable.hpp:32
const std::vector< double > & getSgcritColumn() const
Critical gas saturation.
Definition: EnptvdTable.hpp:102
EnptvdTable()=default
void applyDefaultsLinear(const std::string &columnName)
const std::vector< double > & getSwcoColumn() const
Connate water saturation.
Definition: EnptvdTable.hpp:78