EnkrvdTable.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_ENKRVD_TABLE_HPP
20 #define OPM_PARSER_ENKRVD_TABLE_HPP
21 
22 #include "SimpleTable.hpp"
23 
24 namespace Opm {
25  // forward declaration
26  class TableManager;
27 
28  class EnkrvdTable : public SimpleTable {
29  public:
30 
31  friend class TableManager;
32  EnkrvdTable() = default;
33 
39  {
40  SimpleTable::init(item,
41  std::vector<std::string>{"DEPTH",
42  "KRWMAX",
43  "KRGMAX",
44  "KROMAX",
45  "KRWCRIT",
46  "KRGCRIT",
47  "KROCRITG",
48  "KROCRITW" });
49 
51  SimpleTable::checkMonotonic("DEPTH", /*isAscending=*/true);
59  }
60 
65 
66  // using this method is strongly discouraged but the current endpoint scaling
67  // code makes it hard to avoid
69 
73  const std::vector<double> &getDepthColumn() const
74  { return SimpleTable::getColumn(0); }
75 
79  const std::vector<double> &getKrwmaxColumn() const
80  { return SimpleTable::getColumn(1); }
81 
85  const std::vector<double> &getKrgmaxColumn() const
86  { return SimpleTable::getColumn(2); }
87 
91  const std::vector<double> &getKromaxColumn() const
92  { return SimpleTable::getColumn(3); }
93 
97  const std::vector<double> &getKrwcritColumn() const
98  { return SimpleTable::getColumn(4); }
99 
103  const std::vector<double> &getKrgcritColumn() const
104  { return SimpleTable::getColumn(5); }
105 
109  const std::vector<double> &getKrocritgColumn() const
110  { return SimpleTable::getColumn(6); }
111 
115  const std::vector<double> &getKrocritwColumn() const
116  { return SimpleTable::getColumn(7); }
117  };
118 }
119 
120 #endif
121 
size_t numColumns() const
const std::vector< double > & getKrwcritColumn() const
Relative permeability of water at the critical oil (or gas) saturation.
Definition: EnkrvdTable.hpp:97
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
void checkNonDefaultable(const std::string &columnName)
const std::vector< double > & getKrgcritColumn() const
Relative permeability of gas at the critical oil (or water) saturation.
Definition: EnkrvdTable.hpp:103
std::shared_ptr< const DeckItem > DeckItemConstPtr
Definition: DeckItem.hpp:127
const std::vector< double > & getKrocritgColumn() const
Oil relative permeability of oil at the critical gas saturation.
Definition: EnkrvdTable.hpp:109
const std::vector< double > & getKromaxColumn() const
Maximum relative permeability of oil.
Definition: EnkrvdTable.hpp:91
Definition: EnkrvdTable.hpp:28
Definition: TableManager.hpp:66
const std::vector< double > & getDepthColumn() const
The datum depth for the remaining columns.
Definition: EnkrvdTable.hpp:73
void init(Opm::DeckItemConstPtr item)
Read the ENKRVD keyword and provide some convenience methods for it.
Definition: EnkrvdTable.hpp:38
size_t numRows() const
static size_t numTables(Opm::DeckKeywordConstPtr keyword)
Returns the number of tables in a keyword.
const std::vector< double > & getKrgmaxColumn() const
Maximum relative permeability of gas.
Definition: EnkrvdTable.hpp:85
double evaluate(const std::string &columnName, double xPos) const
Evaluate a column of the table at a given position.
const std::vector< double > & getKrwmaxColumn() const
Maximum relative permeability of water.
Definition: EnkrvdTable.hpp:79
void checkMonotonic(const std::string &columnName, bool isAscending, bool isStrictlyMonotonic=true)
const std::vector< double > & getKrocritwColumn() const
Oil relative permeability of oil at the critical water saturation.
Definition: EnkrvdTable.hpp:115
Definition: SimpleTable.hpp:32
void applyDefaultsLinear(const std::string &columnName)
EnkrvdTable()=default