cfd38b8a66
the intend is to better reflect that these properties where explicitly created in the deck. The old method names can still be used, but they will result in deprecation warnings.
179 lines
7.9 KiB
C++
179 lines
7.9 KiB
C++
/*
|
|
Copyright 2013 Statoil ASA.
|
|
|
|
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_ECLIPSE_STATE_HPP
|
|
#define OPM_ECLIPSE_STATE_HPP
|
|
|
|
#include <utility>
|
|
#include <memory>
|
|
#include <set>
|
|
|
|
#include <opm/parser/eclipse/EclipseState/Schedule/ScheduleEnums.hpp>
|
|
|
|
namespace Opm {
|
|
|
|
template< typename > class GridProperty;
|
|
template< typename > class GridProperties;
|
|
|
|
class Box;
|
|
class BoxManager;
|
|
class Deck;
|
|
class DeckItem;
|
|
class DeckKeyword;
|
|
class DeckRecord;
|
|
class EclipseGrid;
|
|
class Fault;
|
|
class FaultCollection;
|
|
class InitConfig;
|
|
class IOConfig;
|
|
class NNC;
|
|
class ParseMode;
|
|
class Schedule;
|
|
class Section;
|
|
class SimulationConfig;
|
|
class TableManager;
|
|
class TransMult;
|
|
class UnitSystem;
|
|
|
|
class EclipseState {
|
|
public:
|
|
enum EnabledTypes {
|
|
IntProperties = 0x01,
|
|
DoubleProperties = 0x02,
|
|
|
|
AllProperties = IntProperties | DoubleProperties
|
|
};
|
|
|
|
EclipseState(std::shared_ptr< const Deck > deck , const ParseMode& parseMode);
|
|
|
|
const ParseMode& getParseMode() const;
|
|
std::shared_ptr< const Schedule > getSchedule() const;
|
|
std::shared_ptr< const IOConfig > getIOConfigConst() const;
|
|
std::shared_ptr< IOConfig > getIOConfig() const;
|
|
std::shared_ptr< const InitConfig > getInitConfig() const;
|
|
std::shared_ptr< const SimulationConfig > getSimulationConfig() const;
|
|
std::shared_ptr< const EclipseGrid > getEclipseGrid() const;
|
|
std::shared_ptr< EclipseGrid > getEclipseGridCopy() const;
|
|
bool hasPhase(enum Phase::PhaseEnum phase) const;
|
|
std::string getTitle() const;
|
|
bool supportsGridProperty(const std::string& keyword, int enabledTypes=AllProperties) const;
|
|
|
|
std::shared_ptr<const GridProperty<int> > getRegion( const DeckItem& regionItem ) const;
|
|
std::shared_ptr<const GridProperty<int> > getDefaultRegion() const;
|
|
std::shared_ptr<const GridProperty<int> > getIntGridProperty( const std::string& keyword ) const;
|
|
std::shared_ptr<const GridProperty<double> > getDoubleGridProperty( const std::string& keyword ) const;
|
|
bool hasDeckIntGridProperty(const std::string& keyword) const;
|
|
bool hasDeckDoubleGridProperty(const std::string& keyword) const;
|
|
|
|
bool hasIntGridProperty(const std::string& keyword) const __attribute__((deprecated("use hasDeckIntGridProperty() instead")))
|
|
{ return hasDeckIntGridProperty(keyword); }
|
|
bool hasDoubleGridProperty(const std::string& keyword) const __attribute__((deprecated("use hasDeckDoubleGridProperty() instead")))
|
|
{ return hasDeckDoubleGridProperty(keyword); }
|
|
|
|
void loadGridPropertyFromDeckKeyword(std::shared_ptr<const Box> inputBox,
|
|
const DeckKeyword& deckKeyword,
|
|
int enabledTypes = AllProperties);
|
|
|
|
std::shared_ptr<const FaultCollection> getFaults() const;
|
|
std::shared_ptr<const TransMult> getTransMult() const;
|
|
std::shared_ptr<const NNC> getNNC() const;
|
|
bool hasNNC() const;
|
|
|
|
std::shared_ptr<const TableManager> getTableManager() const;
|
|
size_t getNumPhases() const;
|
|
|
|
// the unit system used by the deck. note that it is rarely needed to convert
|
|
// units because internally to opm-parser everything is represented by SI
|
|
// units...
|
|
const UnitSystem& getDeckUnitSystem() const;
|
|
void applyModifierDeck( std::shared_ptr<const Deck> deck);
|
|
|
|
private:
|
|
void initTabdims(std::shared_ptr< const Deck > deck);
|
|
void initTables(std::shared_ptr< const Deck > deck);
|
|
void initIOConfig(std::shared_ptr< const Deck > deck);
|
|
void initSchedule(std::shared_ptr< const Deck > deck);
|
|
void initIOConfigPostSchedule(std::shared_ptr< const Deck > deck);
|
|
void initInitConfig(std::shared_ptr< const Deck > deck);
|
|
void initSimulationConfig(std::shared_ptr< const Deck > deck);
|
|
void initEclipseGrid(std::shared_ptr< const Deck > deck);
|
|
void initGridopts(std::shared_ptr< const Deck > deck);
|
|
void initPhases(std::shared_ptr< const Deck > deck);
|
|
void initTitle(std::shared_ptr< const Deck > deck);
|
|
void initProperties(std::shared_ptr< const Deck > deck);
|
|
void initTransMult();
|
|
void initFaults(std::shared_ptr< const Deck > deck);
|
|
void initNNC(std::shared_ptr< const Deck > deck);
|
|
|
|
|
|
void setMULTFLT(std::shared_ptr<const Opm::Section> section) const;
|
|
void initMULTREGT(std::shared_ptr< const Deck > deck);
|
|
|
|
double getSIScaling(const std::string &dimensionString) const;
|
|
|
|
void processGridProperties(std::shared_ptr< const Deck > deck, int enabledTypes);
|
|
void scanSection(std::shared_ptr<Opm::Section> section , int enabledTypes);
|
|
void handleADDKeyword(const DeckKeyword& deckKeyword , BoxManager& boxManager, int enabledTypes);
|
|
void handleBOXKeyword(const DeckKeyword& deckKeyword , BoxManager& boxManager);
|
|
void handleCOPYKeyword(const DeckKeyword& deckKeyword , BoxManager& boxManager, int enabledTypes);
|
|
void handleENDBOXKeyword(BoxManager& boxManager);
|
|
void handleEQUALSKeyword(const DeckKeyword& deckKeyword , BoxManager& boxManager, int enabledTypes);
|
|
void handleMULTIPLYKeyword(const DeckKeyword& deckKeyword , BoxManager& boxManager, int enabledTypes);
|
|
|
|
void handleEQUALREGKeyword(const DeckKeyword& deckKeyword, int enabledTypes);
|
|
void handleMULTIREGKeyword(const DeckKeyword& deckKeyword, int enabledTypes);
|
|
void handleADDREGKeyword(const DeckKeyword& deckKeyword , int enabledTypes);
|
|
void handleCOPYREGKeyword(const DeckKeyword& deckKeyword , int enabledTypes);
|
|
|
|
void setKeywordBox( const DeckKeyword& deckKeyword, const DeckRecord&, BoxManager& boxManager);
|
|
|
|
void copyIntKeyword(const std::string& srcField , const std::string& targetField , std::shared_ptr<const Box> inputBox);
|
|
void copyDoubleKeyword(const std::string& srcField , const std::string& targetField , std::shared_ptr<const Box> inputBox);
|
|
|
|
void complainAboutAmbiguousKeyword(std::shared_ptr< const Deck > deck, const std::string& keywordName) const;
|
|
|
|
std::shared_ptr<GridProperty<int> > getOrCreateIntProperty_(const std::string name);
|
|
std::shared_ptr<GridProperty<double> > getOrCreateDoubleProperty_(const std::string name);
|
|
|
|
std::shared_ptr< const EclipseGrid > m_eclipseGrid;
|
|
std::shared_ptr< IOConfig > m_ioConfig;
|
|
std::shared_ptr< const InitConfig > m_initConfig;
|
|
std::shared_ptr< const Schedule > schedule;
|
|
std::shared_ptr< const SimulationConfig > m_simulationConfig;
|
|
|
|
std::shared_ptr<const TableManager> m_tables;
|
|
|
|
std::set<enum Phase::PhaseEnum> phases;
|
|
std::string m_title;
|
|
const UnitSystem& m_deckUnitSystem;
|
|
std::shared_ptr<GridProperties<int> > m_intGridProperties;
|
|
std::shared_ptr<GridProperties<double> > m_doubleGridProperties;
|
|
std::shared_ptr<TransMult> m_transMult;
|
|
std::shared_ptr<FaultCollection> m_faults;
|
|
std::shared_ptr<NNC> m_nnc;
|
|
std::string m_defaultRegion;
|
|
const ParseMode& m_parseMode;
|
|
};
|
|
|
|
typedef std::shared_ptr<EclipseState> EclipseStatePtr;
|
|
typedef std::shared_ptr<const EclipseState> EclipseStateConstPtr;
|
|
}
|
|
|
|
#endif
|