/*
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 .
*/
#include
#include
#include
#define BOOST_TEST_MODULE TimeMapTests
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
BOOST_AUTO_TEST_CASE(CreateTimeMap_InvalidThrow) {
boost::gregorian::date startDate;
BOOST_CHECK_THROW(Opm::TimeMap(boost::posix_time::ptime(startDate)) , std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(CreateTimeMapFromTimeT) {
std::time_t startDate = time(0);
Opm::TimeMap timeMap(startDate);
BOOST_CHECK_EQUAL(1U , timeMap.size());
}
BOOST_AUTO_TEST_CASE(CreateTimeMapFromPTime) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap((boost::posix_time::ptime(startDate)));
BOOST_CHECK_EQUAL(1U , timeMap.size());
}
BOOST_AUTO_TEST_CASE(AddDateBeforeThrows) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap((boost::posix_time::ptime(startDate)));
BOOST_CHECK_THROW( timeMap.addTime( boost::posix_time::ptime(boost::gregorian::date(2009,boost::gregorian::Feb,2))),
std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(GetStartDate) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
boost::posix_time::ptime startTime(startDate);
Opm::TimeMap timeMap(startTime);
BOOST_CHECK_EQUAL( Opm::TimeMap::mkdate(2010, 1, 1) , timeMap.getStartTime(/*timeStepIdx=*/0));
}
BOOST_AUTO_TEST_CASE(AddDateAfterSizeCorrect) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap((boost::posix_time::ptime(startDate)));
timeMap.addTime( boost::posix_time::ptime(boost::gregorian::date(2010,boost::gregorian::Feb,2)));
BOOST_CHECK_EQUAL( 2U , timeMap.size());
}
BOOST_AUTO_TEST_CASE(AddDateNegativeTimeTStepThrows) {
const std::time_t startDate = time(0);
Opm::TimeMap timeMap(startDate);
BOOST_CHECK_THROW(timeMap.addTStep(static_cast(-1)) , std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(AddDateNegativePTimeStepThrows) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap((boost::posix_time::ptime(startDate)));
BOOST_CHECK_THROW( timeMap.addTStep( boost::posix_time::hours(-1)) , std::invalid_argument);
}
BOOST_AUTO_TEST_CASE(AddTimeTStepSizeCorrect) {
const std::time_t startDate = Opm::TimeMap::mkdate(2010, 1, 1);
Opm::TimeMap timeMap{startDate};
timeMap.addTStep(static_cast(1 * 60 * 60));
timeMap.addTStep(static_cast(23 * 60 * 60));
BOOST_CHECK_EQUAL(3U, timeMap.size());
BOOST_CHECK_THROW(timeMap[3] , std::invalid_argument );
BOOST_CHECK_EQUAL(timeMap[0] , Opm::TimeMap::mkdate(2010, 1, 1 ));
BOOST_CHECK_EQUAL(timeMap[2] , Opm::TimeMap::mkdate(2010, 1, 2 ));
}
BOOST_AUTO_TEST_CASE(AddPTimeStepSizeCorrect) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap{ boost::posix_time::ptime(boost::posix_time::ptime(startDate)) };
timeMap.addTStep( boost::posix_time::hours(1));
timeMap.addTStep( boost::posix_time::hours(23));
BOOST_CHECK_EQUAL( 3U , timeMap.size());
BOOST_CHECK_THROW( timeMap[3] , std::invalid_argument );
BOOST_CHECK_EQUAL( timeMap[0] , Opm::TimeMap::mkdate(2010, 1, 1 ));
BOOST_CHECK_EQUAL( timeMap[2] , Opm::TimeMap::mkdate(2010, 1, 2 ));
}
BOOST_AUTO_TEST_CASE( dateFromEclipseThrowsInvalidRecord ) {
Opm::DeckRecord startRecord;
Opm::DeckItem dayItem("DAY", int() );
Opm::DeckItem monthItem("MONTH", std::string() );
Opm::DeckItem yearItem("YEAR", int() );
Opm::DeckItem timeItem("TIME", std::string() );
Opm::DeckItem extraItem("EXTRA", int() );
dayItem.push_back( 10 );
yearItem.push_back(1987 );
monthItem.push_back("FEB");
timeItem.push_back("00:00:00.000");
BOOST_CHECK_THROW( Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
startRecord.addItem( dayItem );
BOOST_CHECK_THROW( Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
startRecord.addItem( monthItem );
BOOST_CHECK_THROW( Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
startRecord.addItem( yearItem );
BOOST_CHECK_THROW(Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
startRecord.addItem( timeItem );
BOOST_CHECK_NO_THROW(Opm::TimeMap::timeFromEclipse( startRecord ));
startRecord.addItem( extraItem );
BOOST_CHECK_THROW( Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
}
BOOST_AUTO_TEST_CASE( dateFromEclipseInvalidMonthThrows ) {
Opm::DeckRecord startRecord;
Opm::DeckItem dayItem( "DAY", int() );
Opm::DeckItem monthItem( "MONTH", std::string() );
Opm::DeckItem yearItem( "YEAR", int() );
dayItem.push_back( 10 );
yearItem.push_back(1987 );
monthItem.push_back("XXX");
startRecord.addItem( dayItem );
startRecord.addItem( monthItem );
startRecord.addItem( yearItem );
BOOST_CHECK_THROW( Opm::TimeMap::timeFromEclipse( startRecord ) , std::invalid_argument );
}
BOOST_AUTO_TEST_CASE( timeFromEclipseCheckMonthNames ) {
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Jan , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "JAN" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Feb , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "FEB" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Mar , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "MAR" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Apr , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "APR" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::May , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "MAI" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::May , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "MAY" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Jun , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "JUN" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Jul , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "JUL" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Jul , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "JLY" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Aug , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "AUG" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Sep , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "SEP" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Oct , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "OKT" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Oct , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "OCT" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Nov , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "NOV" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Dec , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "DEC" , 2000));
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 2000 , boost::gregorian::Dec , 1 )) , Opm::TimeMap::timeFromEclipse( 1 , "DES" , 2000));
}
BOOST_AUTO_TEST_CASE( timeFromEclipseInputRecord ) {
Opm::DeckRecord startRecord;
Opm::DeckItem dayItem( "DAY", int() );
Opm::DeckItem monthItem( "MONTH", std::string() );
Opm::DeckItem yearItem("YEAR", int() );
Opm::DeckItem timeItem("TIME", std::string() );
dayItem.push_back( 10 );
yearItem.push_back( 1987 );
monthItem.push_back("JAN");
timeItem.push_back("00:00:00.000");
startRecord.addItem( std::move( dayItem ) );
startRecord.addItem( std::move( monthItem ) );
startRecord.addItem( std::move( yearItem ) );
startRecord.addItem( std::move( timeItem ) );
BOOST_CHECK_EQUAL( boost::posix_time::ptime(boost::gregorian::date( 1987 , boost::gregorian::Jan , 10 )) , Opm::TimeMap::timeFromEclipse( startRecord ));
}
BOOST_AUTO_TEST_CASE( addDATESFromWrongKeywordThrows ) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
Opm::TimeMap timeMap((boost::posix_time::ptime(startDate)));
Opm::DeckKeyword deckKeyword("NOTDATES");
BOOST_CHECK_THROW( timeMap.addFromDATESKeyword( deckKeyword ) , std::invalid_argument );
}
BOOST_AUTO_TEST_CASE( addTSTEPFromWrongKeywordThrows ) {
boost::gregorian::date startDate( 2010 , boost::gregorian::Jan , 1);
boost::posix_time::ptime ptime(startDate);
Opm::TimeMap timeMap(ptime);
Opm::DeckKeyword deckKeyword("NOTTSTEP");
BOOST_CHECK_THROW( timeMap.addFromTSTEPKeyword( deckKeyword ) , std::invalid_argument );
}
BOOST_AUTO_TEST_CASE(TimeStepsCorrect) {
const char *deckData =
"START\n"
" 21 MAY 1981 /\n"
"\n"
"TSTEP\n"
" 1 2 3 4 5 /\n"
"\n"
"DATES\n"
" 1 JAN 1982 /\n"
" 1 JAN 1982 13:55:44 /\n"
" 3 JAN 1982 14:56:45.123 /\n"
"/\n"
"\n"
"TSTEP\n"
" 6 7 /\n";
Opm::Parser parser( true );
auto deck = parser.parseString(deckData, Opm::ParseContext());
Opm::TimeMap tmap(deck);
BOOST_CHECK_EQUAL(tmap.getStartTime(0),Opm::TimeMap::mkdate( 1981 , 5 , 21 ));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(0), 1*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimePassedUntil(1), 1.0*24*60*60);
BOOST_CHECK_EQUAL(tmap.getStartTime(1),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1981 , 5 , 21 ) , 3600*24));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(1), 2*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimePassedUntil(2), (1.0 + 2.0)*24*60*60);
BOOST_CHECK_EQUAL(tmap.getStartTime(2),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1981 , 5 , 21 ) , 3*24*3600));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(2), 3*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimePassedUntil(3), (1.0 + 2.0 + 3.0)*24*60*60);
BOOST_CHECK_EQUAL(tmap.getStartTime(3),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1981 , 5 , 21 ) , 6*3600*24));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(3), 4*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimePassedUntil(4), (1.0 + 2.0 + 3.0 + 4.0)*24*60*60);
BOOST_CHECK_EQUAL(tmap.getStartTime(4),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1981 , 5 , 21 ) , 10*3600*24));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(4), 5*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimePassedUntil(5), (1.0 + 2.0 + 3.0 + 4.0 + 5.0)*24*60*60);
BOOST_CHECK_EQUAL(tmap.getStartTime(5),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1981 , 5 , 21 ) , 15*3600*24));
// timestep 5 is the period between the last step specified using
// of the TIMES keyword and the first record of DATES
BOOST_CHECK_EQUAL(tmap.getStartTime(6),
Opm::TimeMap::mkdate( 1982 , 1 , 1 ));
BOOST_CHECK_EQUAL(tmap.getStartTime(7),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1982 , 1 , 1 ) , 13,55,44 ));
BOOST_CHECK_EQUAL(tmap.getStartTime(8),
Opm::TimeMap::forward( Opm::TimeMap::mkdate( 1982 , 1 , 3 ) , 14,56,45));
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(8), 6*24*60*60);
BOOST_CHECK_EQUAL(tmap.getTimeStepLength(9), 7*24*60*60);
}
BOOST_AUTO_TEST_CASE(initTimestepsYearsAndMonths) {
const char *deckData =
"START\n"
" 21 MAY 1981 /\n"
"\n"
"TSTEP\n"
" 1 2 3 4 5 /\n"
"\n"
"DATES\n"
" 5 JUL 1981 /\n"
" 6 JUL 1981 /\n"
" 5 AUG 1981 /\n"
" 5 SEP 1981 /\n"
" 1 OCT 1981 /\n"
" 1 NOV 1981 /\n"
" 1 DEC 1981 /\n"
" 1 JAN 1982 /\n"
" 1 JAN 1982 13:55:44 /\n"
" 3 JAN 1982 14:56:45.123 /\n"
"/\n"
"\n"
"TSTEP\n"
" 6 7 /\n";
Opm::Parser parser;
auto deck = parser.parseString(deckData, Opm::ParseContext());
const Opm::TimeMap tmap(deck);
/*deckData timesteps:
0 21 may 1981 START
1 22 may 1981
2 24 may 1981
3 27 may 1981
4 31 may 1981
5 5 jun 1981
6 5 jul 1981
7 6 jul 1981
8 5 aug 1981
9 5 sep 1981
10 1 oct 1981
11 1 nov 1981
12 1 dec 1981
13 1 jan 1982
14 1 jan 1982
15 3 jan 1982
16 9 jan 1982
17 16 jan 1982*/
for (size_t timestep = 0; timestep <= 17; ++timestep) {
if ((5 == timestep) || (6 == timestep) || (8 == timestep) || (9 == timestep) ||
(10 == timestep) || (11 == timestep) || (12 == timestep) || (13 == timestep)) {
BOOST_CHECK_EQUAL(true, tmap.isTimestepInFirstOfMonthsYearsSequence(timestep, false, true));
} else {
BOOST_CHECK_EQUAL(false, tmap.isTimestepInFirstOfMonthsYearsSequence(timestep, false, true));
}
}
for (size_t timestep = 0; timestep <= 17; ++timestep) {
if (13 == timestep) {
BOOST_CHECK_EQUAL(true, tmap.isTimestepInFirstOfMonthsYearsSequence(timestep, true, false));
} else {
BOOST_CHECK_EQUAL(false, tmap.isTimestepInFirstOfMonthsYearsSequence(timestep, true, false));
}
}
}
BOOST_AUTO_TEST_CASE(mkdate) {
BOOST_CHECK_THROW( Opm::TimeMap::mkdate( 2010 , 0 , 0 ) , std::invalid_argument);
std::time_t t0 = Opm::TimeMap::mkdate( 2010 , 1, 1);
std::time_t t1 = Opm::TimeMap::forward( t0 , 24*3600);
int year, day, month;
util_set_date_values_utc( t1, &day , &month, &year);
BOOST_CHECK_EQUAL( year , 2010 );
BOOST_CHECK_EQUAL( month , 1 );
BOOST_CHECK_EQUAL( day , 2 );
t1 = Opm::TimeMap::forward( t1 , -24*3600);
util_set_date_values_utc( t1, &day , &month, &year);
BOOST_CHECK_EQUAL( year , 2010 );
BOOST_CHECK_EQUAL( month , 1 );
BOOST_CHECK_EQUAL( day , 1 );
t1 = Opm::TimeMap::forward( t0 , 23, 55 , 300);
util_set_date_values_utc( t1, &day , &month, &year);
BOOST_CHECK_EQUAL( year , 2010 );
BOOST_CHECK_EQUAL( month , 1 );
BOOST_CHECK_EQUAL( day , 2 );
}