Loading...
Searching...
No Matches
Parser.hpp
/*
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_PARSER_HPP
#define OPM_PARSER_HPP
#include <filesystem>
#include <iosfwd>
#include <list>
#include <map>
#include <memory>
#include <string>
#include <utility>
#include <vector>
#include <stddef.h>
#include <opm/input/eclipse/Parser/ParserKeyword.hpp>
namespace Json {
class JsonObject;
}
namespace Opm {
namespace Ecl {
enum SectionType {
RUNSPEC, GRID, EDIT, PROPS, REGIONS, SOLUTION, SUMMARY, SCHEDULE
};
}
class Deck;
class EclipseGrid;
class EclipseState;
class ParseContext;
class ErrorGuard;
class RawKeyword;
class Parser {
public:
explicit Parser(bool addDefault = true);
static std::string stripComments(const std::string& inputString);
Deck parseFile(const std::string &dataFile,
const ParseContext&,
ErrorGuard& errors,
const std::vector<Opm::Ecl::SectionType>& sections = {}) const;
Deck parseFile(const std::string&,
const ParseContext&) const;
Deck parseFile(const std::string&,
const ParseContext&,
const std::vector<Opm::Ecl::SectionType>& sections
) const;
Deck parseFile(const std::string& datafile) const;
Deck parseString(const std::string &data,
const ParseContext&,
ErrorGuard& errors) const;
Deck parseString(const std::string &data, const ParseContext& ) const;
Deck parseString(const std::string &data) const;
Deck parseStream(std::unique_ptr<std::istream>&& inputStream , const ParseContext& parseContext, ErrorGuard& errors) const;
void addParserKeyword(const Json::JsonObject& jsonKeyword);
void addParserKeyword(ParserKeyword parserKeyword);
bool hasKeyword( const std::string& ) const;
const ParserKeyword& getKeyword(const std::string& name) const;
bool isRecognizedKeyword(std::string_view deckKeywordName) const;
bool isBaseRecognizedKeyword(std::string_view deckKeywordName) const;
const ParserKeyword& getParserKeywordFromDeckName(const std::string_view& deckKeywordName) const;
std::vector<std::string> getAllDeckNames () const;
void loadKeywords(const Json::JsonObject& jsonKeywords);
bool loadKeywordFromFile(const std::filesystem::path& configFile);
void loadKeywordsFromDirectory(const std::filesystem::path& directory , bool recursive = true);
void applyUnitsToDeck(Deck& deck) const;
size_t size() const;
template <class T>
void addKeyword() {
addParserKeyword( T() );
}
static EclipseState parse(const Deck& deck, const ParseContext& context);
static EclipseState parse(const std::string &filename, const ParseContext& context, ErrorGuard& errors);
static EclipseState parseData(const std::string &data, const ParseContext& context, ErrorGuard& errors);
static EclipseGrid parseGrid(const std::string &filename,
const ParseContext& context,
ErrorGuard& errors);
static EclipseGrid parseGrid(const Deck& deck,
const ParseContext& context);
static EclipseGrid parseGridData(const std::string &data,
const ParseContext& context,
ErrorGuard& errors);
const std::vector<std::pair<std::string,std::string>> codeKeywords() const;
bool silent() const { return silentMode; }
void silent(bool newSilentMode) { silentMode = newSilentMode; }
static constexpr int SILENT_MODE_MIN_DEBUG_VERBOSITY_LEVEL {3}; // Debug level at which to emit silenced messeages to the debug log
private:
bool hasWildCardKeyword(const std::string& keyword) const;
bool silentMode {false}; // Silence information messages (warnings and errors are still emitted)
const ParserKeyword* matchingKeyword(const std::string_view& keyword) const;
void addDefaultKeywords();
// std::vector< std::unique_ptr< const ParserKeyword > > keyword_storage;
std::list<ParserKeyword> keyword_storage;
// associative map of deck names and the corresponding ParserKeyword object
std::map< std::string_view, const ParserKeyword* > m_deckParserKeywords;
// associative map of the parser internal names and the corresponding
// ParserKeyword object for keywords which match a regular expression
std::map< std::string_view, const ParserKeyword* > m_wildCardKeywords;
std::vector<std::pair<std::string,std::string>> code_keywords;
};
} // namespace Opm
#endif /* PARSER_H */
Json::JsonObject
Definition JsonObject.hpp:31
Opm::Deck
Definition Deck.hpp:46
Opm::EclipseGrid
About cell information and dimension: The actual grid information is held in a pointer to an ERT ecl_...
Definition EclipseGrid.hpp:61
Opm::EclipseState
Definition EclipseState.hpp:62
Opm::ErrorGuard
Definition ErrorGuard.hpp:30
Opm::ParseContext
Definition ParseContext.hpp:84
Opm::ParserKeyword
Definition ParserKeyword.hpp:85
Opm::Parser::parseGrid
static EclipseGrid parseGrid(const std::string &filename, const ParseContext &context, ErrorGuard &errors)
Parses the deck specified in filename.
Definition Parser.cpp:1559
Opm::Parser::addParserKeyword
void addParserKeyword(const Json::JsonObject &jsonKeyword)
Method to add ParserKeyword instances, these holding type and size information about the keywords and...
Definition Parser.cpp:1737
Opm::Parser::isBaseRecognizedKeyword
bool isBaseRecognizedKeyword(std::string_view deckKeywordName) const
Whether or not string is a valid keyword.
Definition Parser.cpp:1696
Opm::Parser::hasKeyword
bool hasKeyword(const std::string &) const
Returns whether the parser knows about a keyword.
Definition Parser.cpp:1741
Opm::Parser::parseGridData
static EclipseGrid parseGridData(const std::string &data, const ParseContext &context, ErrorGuard &errors)
Parses the provided deck string.
Definition Parser.cpp:1572
Opm::Parser::parseFile
Deck parseFile(const std::string &dataFile, const ParseContext &, ErrorGuard &errors, const std::vector< Opm::Ecl::SectionType > &sections={}) const
The starting point of the parsing process. The supplied file is parsed, and the resulting Deck is ret...
Definition Parser.cpp:1581
Opm::Parser::size
size_t size() const
Returns the approximate number of recognized keywords in decks.
Definition Parser.cpp:1667
Opm::Parser::isRecognizedKeyword
bool isRecognizedKeyword(std::string_view deckKeywordName) const
Whether or not string is a valid keyword.
Definition Parser.cpp:1686
Opm::RawKeyword
Definition RawKeyword.hpp:37
Opm
This class implements a small container which holds the transmissibility mulitpliers for all the face...
Definition Exceptions.hpp:30