1161e1098c
With this commit the generation of built in keywords is completely
changed. The most important changes include:
1) We have autogenerated a class for each keyword in the new
ParserKeywords { ... } namespace.
2) The autogenerated classes derive from ParserKeyword, and the
default constructor will build of a fully initialized
ParserKeyword instance, i.e. the keyword used to parse the EQUIL
keyword can be instantiated as simple as:
ParserKeywords::EQUIL kw;
3) The generated keywords have built in static constants for keyword
and item names, and item default values. That way it should be
possible for the compiler to catch trivial errors like trying to
access the keyword "PoRO"; also the the access to default values
means that properties can be initialized without actually
insantiating a DeckKeyword.
4) Two new classes Generator/KeywordLoader and
Generator/KeywordGenerator have been created, with the help of
these classes the keyword generation code is significantly
simplified.
264 lines
10 KiB
C++
264 lines
10 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/>.
|
|
*/
|
|
|
|
#define BOOST_TEST_MODULE ParserIntegrationTests
|
|
#include <boost/test/unit_test.hpp>
|
|
#include <boost/test/test_tools.hpp>
|
|
|
|
#include <opm/parser/eclipse/Deck/Deck.hpp>
|
|
|
|
#include <opm/parser/eclipse/Parser/Parser.hpp>
|
|
#include <opm/parser/eclipse/Parser/ParserRecord.hpp>
|
|
#include <opm/parser/eclipse/Parser/ParserIntItem.hpp>
|
|
#include <opm/parser/eclipse/Parser/ParserStringItem.hpp>
|
|
|
|
#include <opm/parser/eclipse/Parser/ParserEnums.hpp>
|
|
|
|
using namespace Opm;
|
|
|
|
std::shared_ptr<ParserKeyword> createFixedSized(const std::string& kw , size_t size) {
|
|
std::shared_ptr<ParserKeyword> pkw = std::make_shared<ParserKeyword>(kw);
|
|
pkw->setFixedSize( size );
|
|
return pkw;
|
|
}
|
|
|
|
std::shared_ptr<ParserKeyword> createDynamicSized(const std::string& kw) {
|
|
std::shared_ptr<ParserKeyword> pkw = std::make_shared<ParserKeyword>(kw);
|
|
pkw->setSizeType(SLASH_TERMINATED);
|
|
return pkw;
|
|
}
|
|
|
|
|
|
|
|
static ParserPtr createWWCTParser() {
|
|
ParserKeywordPtr parserKeyword = createDynamicSized("WWCT");
|
|
{
|
|
std::shared_ptr<ParserRecord> record = std::make_shared<ParserRecord>();
|
|
record->addItem( ParserStringItemConstPtr(new ParserStringItem("WELL", ALL)) );
|
|
parserKeyword->addRecord( record );
|
|
}
|
|
ParserKeywordPtr summaryKeyword = createFixedSized("SUMMARY" , (size_t) 0);
|
|
|
|
ParserPtr parser(new Parser());
|
|
parser->addParserKeyword(parserKeyword);
|
|
parser->addParserKeyword(summaryKeyword);
|
|
return parser;
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithWWCTKeyword_deckReturned) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/wwct.data");
|
|
ParserPtr parser = createWWCTParser();
|
|
BOOST_CHECK( parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK( parser->isRecognizedKeyword("SUMMARY"));
|
|
BOOST_CHECK_NO_THROW( parser->parseFile(singleKeywordFile.string()) );
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_stringWithWWCTKeyword_deckReturned) {
|
|
const char *wwctString =
|
|
"SUMMARY\n"
|
|
"\n"
|
|
"-- Kommentar\n"
|
|
"WWCT\n"
|
|
" 'WELL-1' 'WELL-2' / -- Ehne mehne muh\n"
|
|
"/\n";
|
|
ParserPtr parser = createWWCTParser();
|
|
BOOST_CHECK( parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK( parser->isRecognizedKeyword("SUMMARY"));
|
|
BOOST_CHECK_NO_THROW(DeckPtr deck = parser->parseString(wwctString));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_streamWithWWCTKeyword_deckReturned) {
|
|
const char *wwctString =
|
|
"SUMMARY\n"
|
|
"\n"
|
|
"-- Kommentar\n"
|
|
"WWCT\n"
|
|
" 'WELL-1' 'WELL-2' / -- Rumpelstilzchen\n"
|
|
"/\n";
|
|
std::shared_ptr<std::istream> wwctStream(new std::istringstream(wwctString));
|
|
ParserPtr parser = createWWCTParser();
|
|
BOOST_CHECK( parser->isRecognizedKeyword("WWCT"));
|
|
BOOST_CHECK( parser->isRecognizedKeyword("SUMMARY"));
|
|
BOOST_CHECK_NO_THROW(DeckPtr deck = parser->parseStream(wwctStream));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithWWCTKeyword_deckHasWWCT) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/wwct.data");
|
|
ParserPtr parser = createWWCTParser();
|
|
DeckPtr deck = parser->parseFile(singleKeywordFile.string());
|
|
BOOST_CHECK(deck->hasKeyword("SUMMARY"));
|
|
BOOST_CHECK(deck->hasKeyword("WWCT"));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithWWCTKeyword_dataIsCorrect) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/wwct.data");
|
|
ParserPtr parser = createWWCTParser();
|
|
DeckPtr deck = parser->parseFile(singleKeywordFile.string());
|
|
BOOST_CHECK_EQUAL("WELL-1", deck->getKeyword("WWCT" , 0)->getRecord(0)->getItem(0)->getString(0));
|
|
BOOST_CHECK_EQUAL("WELL-2", deck->getKeyword("WWCT" , 0)->getRecord(0)->getItem(0)->getString(1));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parser_internal_name_vs_deck_name) {
|
|
ParserPtr parser(new Opm::Parser());
|
|
|
|
// the WELL_PROBE keyword is present by default
|
|
BOOST_CHECK(parser->hasInternalKeyword("WELL_PROBE"));
|
|
|
|
// the NONEXISTING_PROBE keyword is _not_ present by default
|
|
BOOST_CHECK(!parser->hasInternalKeyword("NONEXISTING_PROBE"));
|
|
|
|
// internal names cannot appear in the deck if the deck names and/or deck regular
|
|
// match expressions are given
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("WELL_PROBE"));
|
|
|
|
// an existing deck name
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WWPR"));
|
|
|
|
// a non-existing deck name
|
|
BOOST_CHECK(!parser->isRecognizedKeyword("WWPRFOO"));
|
|
|
|
// user defined quantity. (regex needs to be used.)
|
|
BOOST_CHECK(parser->isRecognizedKeyword("WUFOO"));
|
|
}
|
|
|
|
static ParserPtr createBPRParser() {
|
|
ParserKeywordPtr parserKeyword = createDynamicSized("BPR");
|
|
{
|
|
std::shared_ptr<ParserRecord> bprRecord = std::make_shared<ParserRecord>();
|
|
bprRecord->addItem(ParserIntItemConstPtr(new ParserIntItem("I", SINGLE)));
|
|
bprRecord->addItem(ParserIntItemConstPtr(new ParserIntItem("J", SINGLE)));
|
|
bprRecord->addItem(ParserIntItemConstPtr(new ParserIntItem("K", SINGLE)));
|
|
parserKeyword->addRecord( bprRecord );
|
|
}
|
|
ParserKeywordPtr summaryKeyword = createFixedSized("SUMMARY" , (size_t) 0);
|
|
ParserPtr parser(new Parser());
|
|
parser->addParserKeyword(parserKeyword);
|
|
parser->addParserKeyword(summaryKeyword);
|
|
return parser;
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithBPRKeyword_deckReturned) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/bpr.data");
|
|
ParserPtr parser = createBPRParser();
|
|
|
|
BOOST_CHECK_NO_THROW(parser->parseFile(singleKeywordFile.string()));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithBPRKeyword_DeckhasBRP) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/bpr.data");
|
|
|
|
ParserPtr parser = createBPRParser();
|
|
DeckPtr deck = parser->parseFile(singleKeywordFile.string());
|
|
|
|
BOOST_CHECK_EQUAL(true, deck->hasKeyword("BPR"));
|
|
}
|
|
|
|
BOOST_AUTO_TEST_CASE(parse_fileWithBPRKeyword_dataiscorrect) {
|
|
boost::filesystem::path singleKeywordFile("testdata/integration_tests/bpr.data");
|
|
|
|
ParserPtr parser = createBPRParser();
|
|
DeckPtr deck = parser->parseFile(singleKeywordFile.string());
|
|
|
|
DeckKeywordConstPtr keyword = deck->getKeyword("BPR" , 0);
|
|
BOOST_CHECK_EQUAL(2U, keyword->size());
|
|
|
|
DeckRecordConstPtr record1 = keyword->getRecord(0);
|
|
BOOST_CHECK_EQUAL(3U, record1->size());
|
|
|
|
DeckItemConstPtr I1 = record1->getItem(0);
|
|
BOOST_CHECK_EQUAL(1, I1->getInt(0));
|
|
I1 = record1->getItem("I");
|
|
BOOST_CHECK_EQUAL(1, I1->getInt(0));
|
|
|
|
DeckItemConstPtr J1 = record1->getItem(1);
|
|
BOOST_CHECK_EQUAL(2, J1->getInt(0));
|
|
J1 = record1->getItem("J");
|
|
BOOST_CHECK_EQUAL(2, J1->getInt(0));
|
|
|
|
DeckItemConstPtr K1 = record1->getItem(2);
|
|
BOOST_CHECK_EQUAL(3, K1->getInt(0));
|
|
K1 = record1->getItem("K");
|
|
BOOST_CHECK_EQUAL(3, K1->getInt(0));
|
|
|
|
|
|
DeckRecordConstPtr record2 = keyword->getRecord(0);
|
|
BOOST_CHECK_EQUAL(3U, record2->size());
|
|
|
|
I1 = record2->getItem(0);
|
|
BOOST_CHECK_EQUAL(1, I1->getInt(0));
|
|
I1 = record2->getItem("I");
|
|
BOOST_CHECK_EQUAL(1, I1->getInt(0));
|
|
|
|
J1 = record2->getItem(1);
|
|
BOOST_CHECK_EQUAL(2, J1->getInt(0));
|
|
J1 = record2->getItem("J");
|
|
BOOST_CHECK_EQUAL(2, J1->getInt(0));
|
|
|
|
K1 = record2->getItem(2);
|
|
BOOST_CHECK_EQUAL(3, K1->getInt(0));
|
|
K1 = record2->getItem("K");
|
|
BOOST_CHECK_EQUAL(3, K1->getInt(0));
|
|
}
|
|
|
|
|
|
/***************** Testing non-recognized keywords ********************/
|
|
BOOST_AUTO_TEST_CASE(parse_unknownkeyword_exceptionthrown) {
|
|
ParserPtr parser(new Parser());
|
|
BOOST_CHECK_THROW( parser->parseFile("testdata/integration_tests/someobscureelements.data"), std::invalid_argument);
|
|
}
|
|
|
|
/*********************Testing truncated (default) records ***************************/
|
|
|
|
|
|
// Datafile contains 3 RADFIN4 keywords. One fully specified, one with 2 out of 11 items, and one with no items.
|
|
BOOST_AUTO_TEST_CASE(parse_truncatedrecords_deckFilledWithDefaults) {
|
|
ParserPtr parser(new Parser());
|
|
DeckPtr deck = parser->parseFile("testdata/integration_tests/truncated_records.data");
|
|
BOOST_CHECK_EQUAL(3U, deck->size());
|
|
DeckKeywordConstPtr radfin4_0_full= deck->getKeyword("RADFIN4", 0);
|
|
DeckKeywordConstPtr radfin4_1_partial= deck->getKeyword("RADFIN4", 1);
|
|
|
|
// Specified in datafile
|
|
BOOST_CHECK_EQUAL("NAME", radfin4_0_full->getRecord(0)->getItem(0)->getString(0));
|
|
BOOST_CHECK_EQUAL("NAME", radfin4_1_partial->getRecord(0)->getItem(0)->getString(0));
|
|
|
|
// Specified in datafile
|
|
BOOST_CHECK_EQUAL(213, radfin4_0_full->getRecord(0)->getItem(1)->getInt(0));
|
|
BOOST_CHECK_EQUAL(213, radfin4_1_partial->getRecord(0)->getItem(1)->getInt(0));
|
|
|
|
const auto record_0 = radfin4_0_full->getRecord(0);
|
|
const auto lastItem_0 = record_0->getItem(record_0->size() - 1);
|
|
BOOST_CHECK(!lastItem_0->defaultApplied(0));
|
|
BOOST_CHECK_EQUAL(lastItem_0->getInt(0), 18);
|
|
|
|
const auto record_1 = radfin4_1_partial->getRecord(0);
|
|
const auto lastItem_1 = record_1->getItem(record_1->size() - 1);
|
|
BOOST_CHECK_EQUAL(213, radfin4_1_partial->getRecord(0)->getItem(1)->getInt(0));
|
|
BOOST_CHECK(lastItem_1->defaultApplied(0));
|
|
BOOST_CHECK_EQUAL(lastItem_1->getInt(0), 1);
|
|
|
|
ParserKeywordConstPtr parserKeyword = parser->getParserKeywordFromDeckName("RADFIN4");
|
|
ParserRecordConstPtr parserRecord = parserKeyword->getRecord(0);
|
|
ParserItemConstPtr nwmaxItem = parserRecord->get("NWMAX");
|
|
ParserIntItemConstPtr intItem = std::static_pointer_cast<const ParserIntItem>(nwmaxItem);
|
|
|
|
BOOST_CHECK_EQUAL(18, radfin4_0_full->getRecord(0)->getItem(10)->getInt(0));
|
|
BOOST_CHECK_EQUAL(intItem->getDefault(), radfin4_1_partial->getRecord(0)->getItem(10)->getInt(0));
|
|
}
|