mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
f00553d399
Do not try to create ESMRY file if there are no time steps in the summary data Do not try to read "TIME" record if no time steps are present
445 lines
17 KiB
C++
445 lines
17 KiB
C++
/////////////////////////////////////////////////////////////////////////////////
|
|
//
|
|
// Copyright (C) 2021- Equinor ASA
|
|
//
|
|
// ResInsight 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.
|
|
//
|
|
// ResInsight 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 at <http://www.gnu.org/licenses/gpl.html>
|
|
// for more details.
|
|
//
|
|
/////////////////////////////////////////////////////////////////////////////////
|
|
|
|
#include "RifOpmCommonSummary.h"
|
|
|
|
#include "RiaFilePathTools.h"
|
|
#include "RiaLogging.h"
|
|
#include "RiaStdStringTools.h"
|
|
|
|
#ifdef _MSC_VER
|
|
// Disable warning from external library to make sure treat warnings as error works
|
|
#pragma warning( disable : 4267 )
|
|
#endif
|
|
#include "opm/io/eclipse/ESmry.hpp"
|
|
#include "opm/io/eclipse/ExtESmry.hpp"
|
|
|
|
#include <QFileInfo>
|
|
|
|
size_t RifOpmCommonEclipseSummary::sm_createdEsmryFileCount = 0;
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RifOpmCommonEclipseSummary::RifOpmCommonEclipseSummary()
|
|
: m_useEsmryFiles( false )
|
|
, m_createEsmryFiles( false )
|
|
{
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RifOpmCommonEclipseSummary::~RifOpmCommonEclipseSummary() = default;
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RifOpmCommonEclipseSummary::useEnhancedSummaryFiles( bool enable )
|
|
{
|
|
m_useEsmryFiles = enable;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RifOpmCommonEclipseSummary::createEnhancedSummaryFiles( bool enable )
|
|
{
|
|
m_createEsmryFiles = enable;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RifOpmCommonEclipseSummary::resetEnhancedSummaryFileCount()
|
|
{
|
|
sm_createdEsmryFileCount = 0;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
size_t RifOpmCommonEclipseSummary::numberOfEnhancedSummaryFileCreated()
|
|
{
|
|
return sm_createdEsmryFileCount;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RifOpmCommonEclipseSummary::open( const QString& fileName, bool includeRestartFiles, RiaThreadSafeLogger* threadSafeLogger )
|
|
{
|
|
if ( m_createEsmryFiles )
|
|
{
|
|
auto candidateEsmryFileName = enhancedSummaryFilename( fileName );
|
|
|
|
// Make sure to check the smspec file name, as it is supported to import ESMRY files without any SMSPEC data
|
|
auto smspecFileName = smspecSummaryFilename( fileName );
|
|
|
|
if ( QFile::exists( candidateEsmryFileName ) && QFile::exists( smspecFileName ) &&
|
|
RiaFilePathTools::isFirstOlderThanSecond( candidateEsmryFileName.toStdString(), smspecFileName.toStdString() ) )
|
|
{
|
|
QString root = QFileInfo( smspecFileName ).canonicalPath();
|
|
|
|
const QString smspecFileNameShort = QFileInfo( smspecFileName ).fileName();
|
|
const QString esmryFileNameShort = QFileInfo( candidateEsmryFileName ).fileName();
|
|
|
|
RiaLogging::debug(
|
|
QString( " %3 : %1 is older than %2, recreating %1." ).arg( esmryFileNameShort ).arg( smspecFileNameShort ).arg( root ) );
|
|
|
|
std::filesystem::remove( candidateEsmryFileName.toStdString() );
|
|
}
|
|
|
|
if ( !QFile::exists( candidateEsmryFileName ) && QFile::exists( smspecFileName ) )
|
|
{
|
|
try
|
|
{
|
|
auto temporarySummaryFile = std::make_unique<Opm::EclIO::ESmry>( smspecFileName.toStdString(), includeRestartFiles );
|
|
|
|
if ( temporarySummaryFile->numberOfTimeSteps() > 0 )
|
|
{
|
|
temporarySummaryFile->make_esmry_file();
|
|
}
|
|
|
|
RifOpmCommonEclipseSummary::increaseEsmryFileCount();
|
|
}
|
|
catch ( std::exception& )
|
|
{
|
|
if ( threadSafeLogger )
|
|
{
|
|
QString txt = QString( "Warning, could not open summary file : %1" ).arg( smspecFileName );
|
|
threadSafeLogger->warning( txt );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !openFileReader( fileName, includeRestartFiles, threadSafeLogger ) ) return false;
|
|
|
|
if ( !m_standardReader && !m_enhancedReader ) return false;
|
|
|
|
buildMetaData();
|
|
|
|
return true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::vector<time_t> RifOpmCommonEclipseSummary::timeSteps( const RifEclipseSummaryAddress& resultAddress ) const
|
|
{
|
|
return m_timeSteps;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::pair<bool, std::vector<double>> RifOpmCommonEclipseSummary::values( const RifEclipseSummaryAddress& resultAddress ) const
|
|
{
|
|
auto it = m_summaryAddressToKeywordMap.find( resultAddress );
|
|
if ( it != m_summaryAddressToKeywordMap.end() )
|
|
{
|
|
std::vector<double> values;
|
|
auto keyword = it->second;
|
|
if ( m_enhancedReader )
|
|
{
|
|
auto fileValues = m_enhancedReader->get( keyword );
|
|
values.insert( values.begin(), fileValues.begin(), fileValues.end() );
|
|
}
|
|
else if ( m_standardReader )
|
|
{
|
|
auto fileValues = m_standardReader->get( keyword );
|
|
values.insert( values.begin(), fileValues.begin(), fileValues.end() );
|
|
}
|
|
return { true, values };
|
|
}
|
|
|
|
return { false, {} };
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::string RifOpmCommonEclipseSummary::unitName( const RifEclipseSummaryAddress& resultAddress ) const
|
|
{
|
|
std::string nameString;
|
|
auto it = m_summaryAddressToKeywordMap.find( resultAddress );
|
|
if ( it != m_summaryAddressToKeywordMap.end() )
|
|
{
|
|
auto keyword = it->second;
|
|
if ( m_enhancedReader )
|
|
{
|
|
nameString = m_enhancedReader->get_unit( keyword );
|
|
}
|
|
else if ( m_standardReader )
|
|
{
|
|
nameString = m_standardReader->get_unit( keyword );
|
|
}
|
|
}
|
|
|
|
return RiaStdStringTools::trimString( nameString );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
RiaDefines::EclipseUnitSystem RifOpmCommonEclipseSummary::unitSystem() const
|
|
{
|
|
// TODO: Not implemented
|
|
return RiaDefines::EclipseUnitSystem::UNITS_UNKNOWN;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RifOpmCommonEclipseSummary::buildMetaData()
|
|
{
|
|
std::vector<std::string> keywords;
|
|
Opm::time_point startOfSimulation;
|
|
std::vector<float> daysSinceStartOfSimulation;
|
|
|
|
if ( m_enhancedReader )
|
|
{
|
|
keywords = m_enhancedReader->keywordList();
|
|
startOfSimulation = m_enhancedReader->startdate();
|
|
|
|
if ( m_enhancedReader->numberOfTimeSteps() > 0 )
|
|
{
|
|
daysSinceStartOfSimulation = m_enhancedReader->get( "TIME" );
|
|
}
|
|
}
|
|
else if ( m_standardReader )
|
|
{
|
|
keywords = m_standardReader->keywordList();
|
|
startOfSimulation = m_standardReader->startdate();
|
|
if ( m_standardReader->numberOfTimeSteps() > 0 )
|
|
{
|
|
daysSinceStartOfSimulation = m_standardReader->get( "TIME" );
|
|
}
|
|
}
|
|
|
|
const auto startAsTimeT = std::chrono::system_clock::to_time_t( startOfSimulation );
|
|
const double secondsInOneDay = 24 * 3600;
|
|
for ( const auto& days : daysSinceStartOfSimulation )
|
|
{
|
|
m_timeSteps.push_back( startAsTimeT + days * secondsInOneDay );
|
|
}
|
|
|
|
auto [addresses, addressMap] = RifOpmCommonSummaryTools::buildAddressesAndKeywordMap( keywords );
|
|
|
|
m_allResultAddresses = addresses;
|
|
m_summaryAddressToKeywordMap = addressMap;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
bool RifOpmCommonEclipseSummary::openFileReader( const QString& fileName, bool includeRestartFiles, RiaThreadSafeLogger* threadSafeLogger )
|
|
{
|
|
// Make sure to check the SMSPEC file name, as it is supported to import ESMRY files without any SMSPEC data.
|
|
auto smspecFileName = smspecSummaryFilename( fileName );
|
|
|
|
if ( m_useEsmryFiles )
|
|
{
|
|
try
|
|
{
|
|
auto candidateEsmryFileName = enhancedSummaryFilename( fileName );
|
|
|
|
if ( QFile::exists( candidateEsmryFileName ) )
|
|
{
|
|
bool isValidEsmryFile = false;
|
|
|
|
if ( !QFile::exists( smspecFileName ) )
|
|
{
|
|
// No SMSPEC file present, OK to import ESMRY file
|
|
isValidEsmryFile = true;
|
|
}
|
|
else if ( RiaFilePathTools::isFirstOlderThanSecond( smspecFileName.toStdString(), candidateEsmryFileName.toStdString() ) )
|
|
{
|
|
isValidEsmryFile = true;
|
|
}
|
|
else
|
|
{
|
|
QString root = QFileInfo( smspecFileName ).canonicalPath();
|
|
|
|
const QString smspecFileNameShort = QFileInfo( smspecFileName ).fileName();
|
|
const QString esmryFileNameShort = QFileInfo( candidateEsmryFileName ).fileName();
|
|
|
|
RiaLogging::warning( QString( " %3 : %1 is older than %2, importing data from newest file %2." )
|
|
.arg( esmryFileNameShort )
|
|
.arg( smspecFileNameShort )
|
|
.arg( root ) );
|
|
}
|
|
|
|
if ( isValidEsmryFile )
|
|
{
|
|
m_enhancedReader = std::make_unique<Opm::EclIO::ExtESmry>( candidateEsmryFileName.toStdString(), includeRestartFiles );
|
|
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
catch ( ... )
|
|
{
|
|
// Do not do anything here, try to open the file using standard esmy reader
|
|
}
|
|
}
|
|
|
|
try
|
|
{
|
|
// The standard reader will import data from SMSPEC and UNSMRY files
|
|
if ( QFile::exists( smspecFileName ) )
|
|
{
|
|
m_standardReader = std::make_unique<Opm::EclIO::ESmry>( smspecFileName.toStdString(), includeRestartFiles );
|
|
}
|
|
}
|
|
catch ( std::exception& e )
|
|
{
|
|
QString txt = QString( "Optimized Summary Reader error : %1" ).arg( e.what() );
|
|
|
|
if ( threadSafeLogger ) threadSafeLogger->error( txt );
|
|
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
void RifOpmCommonEclipseSummary::increaseEsmryFileCount()
|
|
{
|
|
// This function can be called from a parallel loop, make it thread safe
|
|
#pragma omp critical
|
|
sm_createdEsmryFileCount++;
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QString RifOpmCommonEclipseSummary::enhancedSummaryFilename( const QString& fileName )
|
|
{
|
|
QString s( fileName );
|
|
return s.replace( ".SMSPEC", ".ESMRY" );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
QString RifOpmCommonEclipseSummary::smspecSummaryFilename( const QString& fileName )
|
|
{
|
|
QString s( fileName );
|
|
return s.replace( ".ESMRY", ".SMSPEC" );
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::tuple<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, size_t>, std::map<RifEclipseSummaryAddress, std::string>>
|
|
RifOpmCommonSummaryTools::buildAddressesSmspecAndKeywordMap( const Opm::EclIO::ESmry* summaryFile )
|
|
{
|
|
std::set<RifEclipseSummaryAddress> addresses;
|
|
std::map<RifEclipseSummaryAddress, size_t> addressToSmspecIndexMap;
|
|
std::map<RifEclipseSummaryAddress, std::string> addressToKeywordMap;
|
|
|
|
if ( summaryFile )
|
|
{
|
|
auto keywords = summaryFile->keywordList();
|
|
for ( const auto& keyword : keywords )
|
|
{
|
|
auto eclAdr = RifEclipseSummaryAddress::fromEclipseTextAddress( keyword );
|
|
if ( !eclAdr.isValid() )
|
|
{
|
|
// If a category is not found, use the MISC category
|
|
eclAdr = RifEclipseSummaryAddress::miscAddress( keyword );
|
|
}
|
|
|
|
if ( eclAdr.isValid() )
|
|
{
|
|
addresses.insert( eclAdr );
|
|
size_t smspecIndex = summaryFile->getSmspecIndexForKeyword( keyword );
|
|
addressToSmspecIndexMap[eclAdr] = smspecIndex;
|
|
addressToKeywordMap[eclAdr] = keyword;
|
|
}
|
|
}
|
|
}
|
|
|
|
return { addresses, addressToSmspecIndexMap, addressToKeywordMap };
|
|
}
|
|
|
|
//--------------------------------------------------------------------------------------------------
|
|
///
|
|
//--------------------------------------------------------------------------------------------------
|
|
std::pair<std::set<RifEclipseSummaryAddress>, std::map<RifEclipseSummaryAddress, std::string>>
|
|
RifOpmCommonSummaryTools::buildAddressesAndKeywordMap( const std::vector<std::string>& keywords )
|
|
{
|
|
std::set<RifEclipseSummaryAddress> addresses;
|
|
std::map<RifEclipseSummaryAddress, std::string> addressToKeywordMap;
|
|
|
|
std::vector<std::string> invalidKeywords;
|
|
|
|
#pragma omp parallel
|
|
{
|
|
std::set<RifEclipseSummaryAddress> threadAddresses;
|
|
std::map<RifEclipseSummaryAddress, std::string> threadAddressToKeywordMap;
|
|
std::vector<std::string> threadInvalidKeywords;
|
|
|
|
#pragma omp for
|
|
for ( int index = 0; index < (int)keywords.size(); index++ )
|
|
{
|
|
auto keyword = keywords[index];
|
|
|
|
auto eclAdr = RifEclipseSummaryAddress::fromEclipseTextAddress( keyword );
|
|
if ( !eclAdr.isValid() )
|
|
{
|
|
threadInvalidKeywords.push_back( keyword );
|
|
|
|
// If a category is not found, use the MISC category
|
|
eclAdr = RifEclipseSummaryAddress::miscAddress( keyword );
|
|
}
|
|
|
|
if ( eclAdr.isValid() )
|
|
{
|
|
threadAddresses.insert( eclAdr );
|
|
threadAddressToKeywordMap[eclAdr] = keyword;
|
|
}
|
|
}
|
|
|
|
#pragma omp critical
|
|
{
|
|
addresses.insert( threadAddresses.begin(), threadAddresses.end() );
|
|
addressToKeywordMap.insert( threadAddressToKeywordMap.begin(), threadAddressToKeywordMap.end() );
|
|
invalidKeywords.insert( invalidKeywords.end(), threadInvalidKeywords.begin(), threadInvalidKeywords.end() );
|
|
}
|
|
|
|
// DEBUG code
|
|
// Used to print keywords not being categorized correctly
|
|
/*
|
|
for ( const auto& kw : invalidKeywords )
|
|
{
|
|
RiaLogging::warning( QString::fromStdString( kw ) );
|
|
}
|
|
*/
|
|
}
|
|
|
|
return { addresses, addressToKeywordMap };
|
|
}
|