Loading...
Searching...
No Matches
TableManager.hpp
/*
Copyright 2015 Statoil ASA.
Copyright 2018 IRIS
This file is part of the Open Porous Media project (OPM).
OPM is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OPM is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OPM. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPM_TABLE_MANAGER_HPP
#define OPM_TABLE_MANAGER_HPP
#include <cassert>
#include <optional>
#include <set>
#include <opm/input/eclipse/EclipseState/Tables/DenT.hpp>
#include <opm/input/eclipse/EclipseState/Tables/JouleThomson.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtgTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtgwTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtgwoTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtoTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtsolTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/RocktabTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Rock2dTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Rock2dtrTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PlyshlogTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PvtwsaltTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/RwgsaltTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/BrineDensityTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SolventDensityTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/StandardCond.hpp>
#include <opm/input/eclipse/EclipseState/Tables/FlatTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SorwmisTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SgcwmisTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/MiscTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PmiscTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/MsfnTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/JFunc.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Tabdims.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TableContainer.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Aqudims.hpp>
#include <opm/input/eclipse/EclipseState/Tables/PlymwinjTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SkprwatTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/SkprpolyTable.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Eqldims.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Regdims.hpp>
#include <opm/input/eclipse/EclipseState/Tables/TLMixpar.hpp>
#include <opm/input/eclipse/EclipseState/Tables/Ppcwmax.hpp>
namespace Opm {
class Deck;
class TableManager {
public:
explicit TableManager( const Deck& deck );
TableManager() = default;
static TableManager serializationTestObject();
const TableContainer& getTables( const std::string& tableName ) const;
const TableContainer& operator[](const std::string& tableName) const;
bool hasTables( const std::string& tableName ) const;
const Tabdims& getTabdims() const;
const Eqldims& getEqldims() const;
const Aqudims& getAqudims() const;
const Regdims& getRegdims() const;
const TLMixpar& getTLMixpar() const;
const Ppcwmax& getPpcwmax() const;
/*
WIll return max{ Tabdims::NTFIP , Regdims::NTFIP }.
*/
size_t numFIPRegions() const;
const TableContainer& getSwofTables() const;
const TableContainer& getSgwfnTables() const;
const TableContainer& getSof2Tables() const;
const TableContainer& getSof3Tables() const;
const TableContainer& getSgofTables() const;
const TableContainer& getSlgofTables() const;
const TableContainer& getSwfnTables() const;
const TableContainer& getSgfnTables() const;
const TableContainer& getSsfnTables() const;
const TableContainer& getRsvdTables() const;
const TableContainer& getRvvdTables() const;
const TableContainer& getRvwvdTables() const;
const TableContainer& getPbvdTables() const;
const TableContainer& getPdvdTables() const;
const TableContainer& getSaltvdTables() const;
const TableContainer& getSaltpvdTables() const;
const TableContainer& getSaltsolTables() const;
const TableContainer& getPcfactTables() const;
const TableContainer& getPermfactTables() const;
const TableContainer& getBiofilmTables() const;
const TableContainer& getDiffMICPTables() const;
const TableContainer& getEnkrvdTables() const;
const TableContainer& getEnptvdTables() const;
const TableContainer& getImkrvdTables() const;
const TableContainer& getImptvdTables() const;
const TableContainer& getPvdgTables() const;
const TableContainer& getPvdoTables() const;
const TableContainer& getPvdsTables() const;
const TableContainer& getSpecheatTables() const;
const TableContainer& getSpecrockTables() const;
const TableContainer& getWatvisctTables() const;
const TableContainer& getOilvisctTables() const;
const TableContainer& getGasvisctTables() const;
const TableContainer& getRtempvdTables() const;
const TableContainer& getRocktabTables() const;
const TableContainer& getPlyadsTables() const;
const TableContainer& getPlyviscTables() const;
const TableContainer& getPlydhflfTables() const;
const TableContainer& getPlymaxTables() const;
const TableContainer& getPlyrockTables() const;
const TableContainer& getPlyshlogTables() const;
const TableContainer& getAqutabTables() const;
const TableContainer& getFoamadsTables() const;
const TableContainer& getFoammobTables() const;
const TableContainer& getSorwmisTables() const;
const TableContainer& getSgcwmisTables() const;
const TableContainer& getMiscTables() const;
const TableContainer& getPmiscTables() const;
const TableContainer& getMsfnTables() const;
const TableContainer& getTlpmixpaTables() const;
const TableContainer& getWsfTables() const;
const TableContainer& getGsfTables() const;
const JFunc& getJFunc() const;
const std::vector<PvtgTable>& getPvtgTables() const;
const std::vector<PvtgwTable>& getPvtgwTables() const;
const std::vector<PvtgwoTable>& getPvtgwoTables() const;
const std::vector<PvtoTable>& getPvtoTables() const;
const std::vector<PvtsolTable>& getPvtsolTables() const;
const std::vector<Rock2dTable>& getRock2dTables() const;
const std::vector<Rock2dtrTable>& getRock2dtrTables() const;
const TableContainer& getRockwnodTables() const;
const TableContainer& getOverburdTables() const;
const DenT& WatDenT() const;
const DenT& GasDenT() const;
const DenT& OilDenT() const;
const JouleThomson& WatJT() const;
const JouleThomson& GasJT() const;
const JouleThomson& OilJT() const;
const StandardCond& stCond() const;
std::size_t gas_comp_index() const;
const PvtwTable& getPvtwTable() const;
const std::vector<PvtwsaltTable>& getPvtwSaltTables() const;
const std::vector<RwgsaltTable>& getRwgSaltTables() const;
const std::vector<BrineDensityTable>& getBrineDensityTables() const;
const std::vector<SolventDensityTable>& getSolventDensityTables() const;
const PvcdoTable& getPvcdoTable() const;
const DensityTable& getDensityTable() const;
const DiffCoeffTable& getDiffusionCoefficientTable() const;
const DiffCoeffWatTable& getDiffusionCoefficientWaterTable() const;
const DiffCoeffGasTable& getDiffusionCoefficientGasTable() const;
const PlyvmhTable& getPlyvmhTable() const;
const RockTable& getRockTable() const;
const ViscrefTable& getViscrefTable() const;
const PlmixparTable& getPlmixparTable() const;
const ShrateTable& getShrateTable() const;
const Stone1exTable& getStone1exTable() const;
const WatdentTable& getWatdentTable() const;
const SgofletTable& getSgofletTable() const;
const SwofletTable& getSwofletTable() const;
const std::map<int, PlymwinjTable>& getPlymwinjTables() const;
const std::map<int, SkprwatTable>& getSkprwatTables() const;
const std::map<int, SkprpolyTable>& getSkprpolyTables() const;
const std::map<std::string, TableContainer>& getSimpleTables() const;
bool useImptvd() const;
bool useEnptvd() const;
bool useEqlnum() const;
bool useShrate() const;
bool useJFunc() const;
double rtemp() const;
double salinity() const;
bool diffMoleFraction() const;
bool operator==(const TableManager& data) const;
template<class Serializer>
void serializeOp(Serializer& serializer)
{
auto simpleTables = m_simpleTables;
auto split = splitSimpleTable(simpleTables);
serializer(simpleTables);
serializer(split.plyshMax);
serializer(split.plyshMap);
serializer(split.rockMax);
serializer(split.rockMap);
serializer(m_pvtgTables);
serializer(m_pvtgwTables);
serializer(m_pvtgwoTables);
serializer(m_pvtoTables);
serializer(m_pvtsolTables);
serializer(m_rock2dTables);
serializer(m_rock2dtrTables);
serializer(m_pvtwTable);
serializer(m_pvcdoTable);
serializer(m_densityTable);
serializer(m_diffCoeffTable);
serializer(m_diffCoeffWatTable);
serializer(m_diffCoeffGasTable);
serializer(m_plyvmhTable);
serializer(m_rockTable);
serializer(m_plmixparTable);
serializer(m_shrateTable);
serializer(m_stone1exTable);
serializer(m_viscrefTable);
serializer(m_watdentTable);
serializer(m_sgofletTable);
serializer(m_swofletTable);
serializer(m_pvtwsaltTables);
serializer(m_rwgsaltTables);
serializer(m_bdensityTables);
serializer(m_sdensityTables);
serializer(m_plymwinjTables);
serializer(m_skprwatTables);
serializer(m_skprpolyTables);
serializer(m_tabdims);
serializer(m_regdims);
serializer(m_eqldims);
serializer(m_aqudims);
serializer(hasImptvd);
serializer(hasEnptvd);
serializer(hasEqlnum);
serializer(hasShrate);
serializer(jfunc);
serializer(oilDenT);
serializer(gasDenT);
serializer(watDenT);
serializer(oilJT);
serializer(gasJT);
serializer(watJT);
serializer(stcond);
serializer(m_gas_comp_index);
serializer(m_rtemp);
serializer(m_salinity);
serializer(m_diff_mole_fraction);
serializer(m_tlmixpar);
serializer(m_ppcwmax);
if (!serializer.isSerializing()) {
m_simpleTables = simpleTables;
if (split.plyshMax > 0) {
TableContainer container(split.plyshMax);
for (const auto& it : split.plyshMap) {
container.addTable(it.first, it.second);
}
m_simpleTables.insert(std::make_pair("PLYSHLOG", container));
}
if (split.rockMax > 0) {
TableContainer container(split.rockMax);
for (const auto& it : split.rockMap) {
container.addTable(it.first, it.second);
}
m_simpleTables.insert(std::make_pair("ROCKTAB", container));
}
}
}
private:
TableContainer& forceGetTables( const std::string& tableName , size_t numTables);
void complainAboutAmbiguousKeyword(const Deck& deck, const std::string& keywordName);
void addTables( const std::string& tableName , size_t numTables);
void initSimpleTables(const Deck& deck);
void initRTempTables(const Deck& deck);
void initDims(const Deck& deck);
void initRocktabTables(const Deck& deck);
void initPlymaxTables(const Deck& deck);
void initPlyrockTables(const Deck& deck);
void initPlyshlogTables(const Deck& deck);
void initPlymwinjTables(const Deck& deck);
void initSkprwatTables(const Deck& deck);
void initSkprpolyTables(const Deck& deck);
//void initRockTables(const Deck& deck, const std::string& keywordName);
template <class TableType>
void initRockTables(const Deck& deck, const std::string& keywordName, std::vector<TableType>& rocktable );
template <class TableType>
void initPvtwsaltTables(const Deck& deck, std::vector<TableType>& pvtwtables );
template <class TableType>
void initRwgsaltTables(const Deck& deck, std::vector<TableType>& rwgtables );
template <class TableType>
void initBrineTables(const Deck& deck, std::vector<TableType>& brinetables );
void initSolventTables(const Deck& deck, std::vector<SolventDensityTable>& solventtables);
template <class TableType>
void initSimpleTableContainerWithJFunc(const Deck& deck,
const std::string& keywordName,
const std::string& tableName,
size_t numTables);
template <class TableType>
void initSimpleTableContainer(const Deck& deck,
const std::string& keywordName,
const std::string& tableName,
size_t numTables);
template <class TableType>
void initSimpleTableContainer(const Deck& deck,
const std::string& keywordName,
size_t numTables);
template <class TableType>
void initSimpleTableContainerWithJFunc(const Deck& deck,
const std::string& keywordName,
size_t numTables);
template <class TableType>
void initSimpleTable(const Deck& deck,
const std::string& keywordName,
std::vector<TableType>& tableVector);
template <class TableType>
void initFullTables(const Deck& deck,
const std::string& keywordName,
std::vector<TableType>& tableVector);
void checkPVTOMonotonicity(const Deck& deck) const;
void logPVTOMonotonicityFailure(const Deck& deck,
const std::size_t tableID,
const std::vector<PvtoTable::FlippedFVF>& flipped_Bo) const;
std::map<std::string , TableContainer> m_simpleTables;
std::vector<PvtgTable> m_pvtgTables;
std::vector<PvtgwTable> m_pvtgwTables;
std::vector<PvtgwoTable> m_pvtgwoTables;
std::vector<PvtoTable> m_pvtoTables;
std::vector<PvtsolTable> m_pvtsolTables;
std::vector<Rock2dTable> m_rock2dTables;
std::vector<Rock2dtrTable> m_rock2dtrTables;
PvtwTable m_pvtwTable;
PvcdoTable m_pvcdoTable;
DensityTable m_densityTable;
DiffCoeffTable m_diffCoeffTable;
DiffCoeffWatTable m_diffCoeffWatTable;
DiffCoeffGasTable m_diffCoeffGasTable;
PlyvmhTable m_plyvmhTable;
RockTable m_rockTable;
PlmixparTable m_plmixparTable;
ShrateTable m_shrateTable;
Stone1exTable m_stone1exTable;
ViscrefTable m_viscrefTable;
WatdentTable m_watdentTable;
SgofletTable m_sgofletTable;
SwofletTable m_swofletTable;
std::vector<PvtwsaltTable> m_pvtwsaltTables;
std::vector<RwgsaltTable> m_rwgsaltTables;
std::vector<BrineDensityTable> m_bdensityTables;
std::vector<SolventDensityTable> m_sdensityTables;
std::map<int, PlymwinjTable> m_plymwinjTables;
std::map<int, SkprwatTable> m_skprwatTables;
std::map<int, SkprpolyTable> m_skprpolyTables;
Tabdims m_tabdims;
Regdims m_regdims;
Eqldims m_eqldims;
Aqudims m_aqudims;
TLMixpar m_tlmixpar;
Ppcwmax m_ppcwmax;
bool hasImptvd = false;// if deck has keyword IMPTVD
bool hasEnptvd = false;// if deck has keyword ENPTVD
bool hasEqlnum = false;// if deck has keyword EQLNUM
bool hasShrate = false;// if deck has keyword SHRATE
std::optional<JFunc> jfunc;
DenT oilDenT;
DenT gasDenT;
DenT watDenT;
JouleThomson oilJT;
JouleThomson gasJT;
JouleThomson watJT;
StandardCond stcond;
std::size_t m_gas_comp_index = 77;
double m_rtemp {288.7056}; // 60 Fahrenheit in Kelvin
double m_salinity {0.0};
bool m_diff_mole_fraction {true};
struct SplitSimpleTables {
size_t plyshMax = 0;
size_t rockMax = 0;
std::map<size_t, std::shared_ptr<PlyshlogTable>> plyshMap;
std::map<size_t, std::shared_ptr<RocktabTable>> rockMap;
};
SplitSimpleTables splitSimpleTable(std::map<std::string,TableContainer>& simpleTables);
};
}
#endif
Opm::Aqudims
Definition Aqudims.hpp:34
Opm::Deck
Definition Deck.hpp:46
Opm::DenT
Definition DenT.hpp:31
Opm::Eqldims
Definition Eqldims.hpp:32
Opm::JFunc
Definition JFunc.hpp:28
Opm::JouleThomson
Definition JouleThomson.hpp:30
Opm::Ppcwmax
Definition Ppcwmax.hpp:51
Opm::Regdims
Definition Regdims.hpp:36
Opm::Serializer
Class for (de-)serializing.
Definition Serializer.hpp:94
Opm::Serializer::isSerializing
bool isSerializing() const
Returns true if we are currently doing a serialization operation.
Definition Serializer.hpp:207
Opm::TLMixpar
Definition TLMixpar.hpp:54
Opm::Tabdims
Definition Tabdims.hpp:36
Opm::TableContainer
The TableContainer class implements a simple map:
Definition TableContainer.hpp:61
Opm::TableManager::useEqlnum
bool useEqlnum() const
deck has keyword "EQLNUM" — Equilibriation region numbers
Definition TableManager.cpp:1245
Opm::TableManager::useJFunc
bool useJFunc() const
deck has keyword "JFUNC" — Use Leverett's J Function for capillary pressure
Definition TableManager.cpp:1253
Opm::TableManager::useEnptvd
bool useEnptvd() const
deck has keyword "ENPTVD" — Saturation end-point versus depth tables
Definition TableManager.cpp:1241
Opm::TableManager::useImptvd
bool useImptvd() const
deck has keyword "IMPTVD" — Imbition end-point versus depth tables
Definition TableManager.cpp:1237
Opm::TableManager::useShrate
bool useShrate() const
deck has keyword "SHRATE"
Definition TableManager.cpp:1249
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30
Opm::salinity
Scalar Brine< Scalar, H2O >::salinity
Default value for the salinity of the brine (dimensionless).
Definition Brine.hpp:391
Opm::DensityTable
Definition FlatTable.hpp:124
Opm::DiffCoeffGasTable
Definition FlatTable.hpp:230
Opm::DiffCoeffTable
Definition FlatTable.hpp:173
Opm::DiffCoeffWatTable
Definition FlatTable.hpp:202
Opm::PlmixparTable
Definition FlatTable.hpp:363
Opm::PlyvmhTable
Definition FlatTable.hpp:397
Opm::PvcdoTable
Definition FlatTable.hpp:338
Opm::PvtwTable
Definition FlatTable.hpp:268
Opm::RockTable
Definition FlatTable.hpp:299
Opm::SgofletTable
Definition FlatTable.hpp:617
Opm::ShrateTable
Definition FlatTable.hpp:422
Opm::StandardCond
Definition StandardCond.hpp:24
Opm::Stone1exTable
Definition FlatTable.hpp:447
Opm::SwofletTable
Definition FlatTable.hpp:607
Opm::ViscrefTable
Definition FlatTable.hpp:503
Opm::WatdentTable
Definition FlatTable.hpp:534