RocktabTable.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_ROCKTAB_TABLE_HPP
20 #define OPM_PARSER_ROCKTAB_TABLE_HPP
21 
22 #include "SimpleTable.hpp"
23 
24 namespace Opm {
25  // forward declaration
26  class TableManager;
27 
28  class RocktabTable : public SimpleTable {
29  public:
30  friend class TableManager;
31  RocktabTable() = default;
32 
38  bool isDirectional,
39  bool hasStressOption)
40  {
41  SimpleTable::init(item,
42  isDirectional
43  ? std::vector<std::string>{"PO", "PV_MULT", "TRANSMIS_MULT_X", "TRANSMIS_MULT_Y", "TRANSMIS_MULT_Z"}
44  : std::vector<std::string>{"PO", "PV_MULT", "TRANSMIS_MULT"});
45  m_isDirectional = isDirectional;
46 
48  SimpleTable::checkMonotonic("PO", /*isAscending=*/hasStressOption);
50  if (isDirectional) {
51  SimpleTable::applyDefaultsLinear("TRANSMIS_MULT");
52  } else {
53  SimpleTable::applyDefaultsLinear("TRANSMIS_MULT_X");
54  SimpleTable::applyDefaultsLinear("TRANSMIS_MULT_Y");
55  SimpleTable::applyDefaultsLinear("TRANSMIS_MULT_Z");
56  }
57  }
58 
63 
64  const std::vector<double> &getPressureColumn() const
65  { return SimpleTable::getColumn(0); }
66 
67  const std::vector<double> &getPoreVolumeMultiplierColumn() const
68  { return SimpleTable::getColumn(1); }
69 
70  const std::vector<double> &getTransmissibilityMultiplierColumn() const
71  { return SimpleTable::getColumn(2); }
72 
73  const std::vector<double> &getTransmissibilityMultiplierXColumn() const
74  { return SimpleTable::getColumn(2); }
75 
76  const std::vector<double> &getTransmissibilityMultiplierYColumn() const
77  {
78  if (!m_isDirectional)
79  return SimpleTable::getColumn(2);
80  return SimpleTable::getColumn(3);
81  }
82 
83  const std::vector<double> &getTransmissibilityMultiplierZColumn() const
84  {
85  if (!m_isDirectional)
86  return SimpleTable::getColumn(2);
87  return SimpleTable::getColumn(4);
88  }
89 
90  private:
91  bool m_isDirectional;
92  };
93 }
94 
95 #endif
size_t numColumns() const
const std::vector< double > & getTransmissibilityMultiplierZColumn() const
Definition: RocktabTable.hpp:83
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 > & getTransmissibilityMultiplierXColumn() const
Definition: RocktabTable.hpp:73
std::shared_ptr< const DeckItem > DeckItemConstPtr
Definition: DeckItem.hpp:127
Definition: TableManager.hpp:66
const std::vector< double > & getPressureColumn() const
Definition: RocktabTable.hpp:64
Definition: RocktabTable.hpp:28
const std::vector< double > & getPoreVolumeMultiplierColumn() const
Definition: RocktabTable.hpp:67
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 > & getTransmissibilityMultiplierYColumn() const
Definition: RocktabTable.hpp:76
void init(Opm::DeckItemConstPtr item, bool isDirectional, bool hasStressOption)
Read the ROCKTAB keyword and provide some convenience methods for it.
Definition: RocktabTable.hpp:37
void checkMonotonic(const std::string &columnName, bool isAscending, bool isStrictlyMonotonic=true)
Definition: SimpleTable.hpp:32
const std::vector< double > & getTransmissibilityMultiplierColumn() const
Definition: RocktabTable.hpp:70
void applyDefaultsLinear(const std::string &columnName)
RocktabTable()=default