OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Use opm-common to read restart file from summary file

Browse Source 
Testing identified performance issues related to reading restart file name from summary files.

Make sure the reading of timesteps is done only when required in new function getFileInfoAndTimeSteps.

Add reading of restart file name using opm-common when opm-common is active. The performance of this reader is much better than resdata.
This commit is contained in:
Magne Sjaastad
2024-11-14 11:55:02 +01:00
parent acbf0ef15a
commit 664b082c81
7 changed files with 188 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
ApplicationLibCode/Commands/RicSummaryCaseRestartDialog.cpp
View File

@@ -234,7 +234,7 @@ RicSummaryCaseRestartDialogResult RicSummaryCaseRestartDialog::openDialog( const
RifRestartFileInfo currentFileInfo;
if ( !initialSummaryFile.isEmpty() )
{
currentFileInfo = RifEclipseSummaryTools::getFileInfo( initialSummaryFile );
currentFileInfo = RifEclipseSummaryTools::getFileInfoAndTimeSteps( initialSummaryFile );
if ( !currentFileInfo.valid() )
{
@@ -268,11 +268,11 @@ RicSummaryCaseRestartDialogResult RicSummaryCaseRestartDialog::openDialog( const
useFirstSummaryCaseAsTemplate || ( lastResult && lastResult->applyToAll ) );
}
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> originFileInfos = RifEclipseSummaryTools::getRestartFiles( initialSummaryFile, warnings );
std::vector<QString> warnings;
auto restartFileNames = RifEclipseSummaryTools::getRestartFileNames( initialSummaryFile, warnings );
// If no restart files are found and no warnings, do not show dialog
if ( originFileInfos.empty() && warnings.empty() )
if ( restartFileNames.empty() && warnings.empty() )
{
return RicSummaryCaseRestartDialogResult( RicSummaryCaseRestartDialogResult::SUMMARY_OK,
ImportOptions::NOT_IMPORT,
@@ -303,20 +303,22 @@ RicSummaryCaseRestartDialogResult RicSummaryCaseRestartDialog::openDialog( const
dialog.m_currentFilesGroup->setTitle( "Current Grid and Summary Files" );
currentFileInfos.push_back( RifRestartFileInfo( initialGridFile, currentFileInfo.startDate, currentFileInfo.endDate ) );
for ( const auto& ofi : originFileInfos )
for ( const auto& fileName : restartFileNames )
{
QString gridFile = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( ofi.fileName );
QString gridFile = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( fileName );
if ( QFileInfo( gridFile ).exists() )
{
originGridFileInfos.push_back( RifRestartFileInfo( gridFile, ofi.startDate, ofi.endDate ) );
auto fileInfoWithTime = RifEclipseSummaryTools::getFileInfoAndTimeSteps( fileName );
originGridFileInfos.push_back( RifRestartFileInfo( gridFile, fileInfoWithTime.startDate, fileInfoWithTime.endDate ) );
}
}
}
currentFileInfos.push_back( currentFileInfo );
for ( const auto& ofi : originFileInfos )
for ( const auto& fileName : restartFileNames )
{
originSummaryFileInfos.push_back( ofi );
originSummaryFileInfos.push_back( RifRestartFileInfo( fileName, 0, 0 ) );
}
if ( hideSplitCases )
@@ -409,9 +411,9 @@ RicSummaryCaseRestartDialogResult RicSummaryCaseRestartDialog::openDialog( const
dialogResult.summaryFiles.push_back( RiaFilePathTools::toInternalSeparator( initialSummaryFile ) );
if ( dialogResult.summaryImportOption == ImportOptions::SEPARATE_CASES )
{
for ( const auto& ofi : originFileInfos )
for ( const auto& fileName : restartFileNames )
{
dialogResult.summaryFiles.push_back( RiaFilePathTools::toInternalSeparator( ofi.fileName ) );
dialogResult.summaryFiles.push_back( RiaFilePathTools::toInternalSeparator( fileName ) );
}
}
@@ -421,9 +423,9 @@ RicSummaryCaseRestartDialogResult RicSummaryCaseRestartDialog::openDialog( const
if ( dialogResult.gridImportOption == ImportOptions::SEPARATE_CASES )
{
for ( const auto& ofi : originFileInfos )
for ( const auto& fileName : restartFileNames )
{
QString gridFile = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( ofi.fileName );
QString gridFile = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( fileName );
dialogResult.gridFiles.push_back( gridFile );
}
}

108
ApplicationLibCode/FileInterface/RifEclipseSummaryTools.cpp
View File

@@ -32,6 +32,8 @@
#include "ert/ecl/ecl_util.h"
#include "ert/ecl/smspec_node.hpp"
#include "opm/io/eclipse/EclFile.hpp"
#include <QDateTime>
#include <QDir>
#include <QString>
@@ -150,15 +152,23 @@ void RifEclipseSummaryTools::dumpMetaData( RifSummaryReaderInterface* readerEcli
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<RifRestartFileInfo> RifEclipseSummaryTools::getRestartFiles( const QString& headerFileName, std::vector<QString>& warnings )
std::vector<QString> RifEclipseSummaryTools::getRestartFileNames( const QString& headerFileName, std::vector<QString>& warnings )
{
std::vector<RifRestartFileInfo> restartFiles;
return getRestartFileNames( headerFileName, false, warnings );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<QString>
RifEclipseSummaryTools::getRestartFileNames( const QString& headerFileName, bool useOpmReader, std::vector<QString>& warnings )
{
std::vector<QString> restartFiles;
std::set<QString> restartFilesOpened;
RifRestartFileInfo currFile;
currFile.fileName = headerFileName;
while ( !currFile.fileName.isEmpty() )
QString currentFileName = headerFileName;
while ( !currentFileName.isEmpty() )
{
// Due to a weakness in resdata regarding restart summary header file selection,
// do some extra checking
@@ -167,14 +177,14 @@ std::vector<RifRestartFileInfo> RifEclipseSummaryTools::getRestartFiles( const Q
QString nonformattedHeaderExtension = ".SMSPEC";
QString formattedDataFileExtension = ".FUNSMRY";
if ( currFile.fileName.endsWith( nonformattedHeaderExtension, Qt::CaseInsensitive ) )
if ( currentFileName.endsWith( nonformattedHeaderExtension, Qt::CaseInsensitive ) )
{
QString formattedHeaderFile = currFile.fileName;
QString formattedHeaderFile = currentFileName;
formattedHeaderFile.replace( nonformattedHeaderExtension, formattedHeaderExtension, Qt::CaseInsensitive );
QString formattedDateFile = currFile.fileName;
QString formattedDateFile = currentFileName;
formattedDateFile.replace( nonformattedHeaderExtension, formattedDataFileExtension, Qt::CaseInsensitive );
QFileInfo nonformattedHeaderFileInfo = QFileInfo( currFile.fileName );
QFileInfo nonformattedHeaderFileInfo = QFileInfo( currentFileName );
QFileInfo formattedHeaderFileInfo = QFileInfo( formattedHeaderFile );
QFileInfo formattedDateFileInfo = QFileInfo( formattedDateFile );
if ( formattedHeaderFileInfo.lastModified() < nonformattedHeaderFileInfo.lastModified() &&
@@ -187,23 +197,31 @@ std::vector<RifRestartFileInfo> RifEclipseSummaryTools::getRestartFiles( const Q
break;
}
}
QString prevFile = currFile.fileName;
currFile = getRestartFile( currFile.fileName );
QString prevFileName = currentFileName;
if ( useOpmReader )
{
currentFileName = getRestartFileNameOpm( currentFileName );
}
else
{
currentFileName = getRestartFileName( currentFileName );
}
// Fix to stop potential infinite loop
if ( currFile.fileName == prevFile )
if ( currentFileName == prevFileName )
{
warnings.push_back( "RifReaderEclipseSummary: Restart file reference loop detected" );
break;
}
if ( restartFilesOpened.count( currFile.fileName ) != 0u )
if ( restartFilesOpened.count( currentFileName ) != 0u )
{
warnings.push_back( "RifReaderEclipseSummary: Same restart file being opened multiple times" );
}
restartFilesOpened.insert( currFile.fileName );
restartFilesOpened.insert( currentFileName );
}
if ( !currFile.fileName.isEmpty() ) restartFiles.push_back( currFile );
if ( !currentFileName.isEmpty() ) restartFiles.push_back( currentFileName );
}
return restartFiles;
}
@@ -211,7 +229,7 @@ std::vector<RifRestartFileInfo> RifEclipseSummaryTools::getRestartFiles( const Q
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifRestartFileInfo RifEclipseSummaryTools::getFileInfo( const QString& headerFileName )
RifRestartFileInfo RifEclipseSummaryTools::getFileInfoAndTimeSteps( const QString& headerFileName )
{
RifRestartFileInfo fileInfo;
ecl_sum_type* ecl_sum = openEclSum( headerFileName, false );
@@ -227,6 +245,14 @@ RifRestartFileInfo RifEclipseSummaryTools::getFileInfo( const QString& headerFil
return fileInfo;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<QString> RifEclipseSummaryTools::getRestartFileNamesOpm( const QString& headerFileName, std::vector<QString>& warnings )
{
return getRestartFileNames( headerFileName, true, warnings );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
@@ -261,7 +287,7 @@ void RifEclipseSummaryTools::findSummaryHeaderFileInfo( const QString& inputFile
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RifRestartFileInfo RifEclipseSummaryTools::getRestartFile( const QString& headerFileName )
QString RifEclipseSummaryTools::getRestartFileName( const QString& headerFileName )
{
ecl_sum_type* ecl_sum = openEclSum( headerFileName, true );
@@ -283,11 +309,52 @@ RifRestartFileInfo RifEclipseSummaryTools::getRestartFile( const QString& header
QString restartFileName = RiaFilePathTools::toInternalSeparator( RiaStringEncodingTools::fromNativeEncoded( smspec_header ) );
free( smspec_header );
return getFileInfo( restartFileName );
return restartFileName;
}
return RifRestartFileInfo();
return {};
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
QString RifEclipseSummaryTools::getRestartFileNameOpm( const QString& headerFileName )
{
try
{
Opm::EclIO::EclFile eclFile( headerFileName.toStdString() );
eclFile.loadData( "RESTART" );
std::string fullRestartFileName;
auto restartData = eclFile.get<std::string>( "RESTART" );
for ( const auto& string : restartData )
{
fullRestartFileName += string;
}
if ( fullRestartFileName.empty() ) return {};
QFileInfo sourceFileInfo( headerFileName );
QString suffix = sourceFileInfo.suffix();
QString filePath = sourceFileInfo.absolutePath() + RiaFilePathTools::separator() + QString::fromStdString( fullRestartFileName ) +
"." + suffix;
QFileInfo restartFileInfo( filePath );
QString restartFileName = RiaFilePathTools::toInternalSeparator( restartFileInfo.absoluteFilePath() );
return restartFileName;
}
catch ( ... )
{
}
return {};
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
std::vector<time_t> RifEclipseSummaryTools::getTimeSteps( ecl_sum_type* ecl_sum )
{
std::vector<time_t> timeSteps;
@@ -309,6 +376,9 @@ std::vector<time_t> RifEclipseSummaryTools::getTimeSteps( ecl_sum_type* ecl_sum
return timeSteps;
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
RiaDefines::EclipseUnitSystem RifEclipseSummaryTools::readUnitSystem( ecl_sum_type* ecl_sum )
{
ert_ecl_unit_enum eclUnitEnum = ecl_sum_get_unit_system( ecl_sum );

12
ApplicationLibCode/FileInterface/RifEclipseSummaryTools.h
View File

@@ -68,8 +68,10 @@ public:
static void dumpMetaData( RifSummaryReaderInterface* readerEclipseSummary );
static std::vector<RifRestartFileInfo> getRestartFiles( const QString& headerFileName, std::vector<QString>& warnings );
static RifRestartFileInfo getFileInfo( const QString& headerFileName );
static std::vector<QString> getRestartFileNames( const QString& headerFileName, std::vector<QString>& warnings );
static std::vector<QString> getRestartFileNamesOpm( const QString& headerFileName, std::vector<QString>& warnings );
static RifRestartFileInfo getFileInfoAndTimeSteps( const QString& headerFileName );
static void closeEclSum( ecl_sum_type* ecl_sum );
static ecl_sum_type* openEclSum( const QString& inHeaderFileName, bool includeRestartFiles );
@@ -77,8 +79,10 @@ public:
static std::vector<time_t> getTimeSteps( ecl_sum_type* ecl_sum );
private:
static void findSummaryFiles( const QString& inputFile, QString* headerFile, QStringList* dataFiles );
static RifRestartFileInfo getRestartFile( const QString& headerFileName );
static void findSummaryFiles( const QString& inputFile, QString* headerFile, QStringList* dataFiles );
static QString getRestartFileName( const QString& headerFileName );
static QString getRestartFileNameOpm( const QString& headerFileName );
static std::vector<QString> getRestartFileNames( const QString& headerFileName, bool useOpmReader, std::vector<QString>& warnings );
static void findSummaryHeaderFileInfo( const QString& inputFile, QString* headerFile, QString* path, QString* base, bool* isFormatted );
};

14
ApplicationLibCode/FileInterface/RifSummaryCaseRestartSelector.cpp
View File

@@ -287,11 +287,11 @@ void RifSummaryCaseRestartSelector::determineFilesToImportUsingPrefs( const std:
{
m_summaryFileInfos.push_back( RifSummaryCaseFileResultInfo( initialSummaryFile, false ) );
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> restartFileInfos = RifEclipseSummaryTools::getRestartFiles( initialSummaryFile, warnings );
for ( const auto& rfi : restartFileInfos )
std::vector<QString> warnings;
auto fileNames = RifEclipseSummaryTools::getRestartFileNames( initialSummaryFile, warnings );
for ( const auto& fileName : fileNames )
{
RifSummaryCaseFileResultInfo resultFileInfo( RiaFilePathTools::toInternalSeparator( rfi.fileName ), false );
RifSummaryCaseFileResultInfo resultFileInfo( RiaFilePathTools::toInternalSeparator( fileName ), false );
if ( !vectorContains( m_summaryFileInfos, resultFileInfo ) )
{
m_summaryFileInfos.push_back( resultFileInfo );
@@ -309,10 +309,10 @@ void RifSummaryCaseRestartSelector::determineFilesToImportUsingPrefs( const std:
{
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> restartFileInfos = RifEclipseSummaryTools::getRestartFiles( initialSummaryFile, warnings );
for ( const auto& rfi : restartFileInfos )
auto fileNames = RifEclipseSummaryTools::getRestartFileNames( initialSummaryFile, warnings );
for ( const auto& fileName : fileNames )
{
QString gridFileName = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( rfi.fileName );
QString gridFileName = RifEclipseSummaryTools::findGridCaseFileFromSummaryHeaderFile( fileName );
if ( !m_gridFiles.contains( gridFileName ) && QFileInfo( gridFileName ).exists() )
{
m_gridFiles.push_back( gridFileName );

18
ApplicationLibCode/ProjectDataModel/Summary/RimFileSummaryCase.cpp
View File

@@ -167,16 +167,24 @@ RifSummaryReaderInterface* RimFileSummaryCase::findRelatedFilesAndCreateReader(
{
if ( lookForRestartFiles )
{
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> restartFileInfos = RifEclipseSummaryTools::getRestartFiles( headerFileName, warnings );
std::vector<QString> warnings;
std::vector<QString> restartFileNames;
if ( RiaPreferencesSummary::current()->summaryDataReader() == RiaPreferencesSummary::SummaryReaderMode::OPM_COMMON )
{
restartFileNames = RifEclipseSummaryTools::getRestartFileNamesOpm( headerFileName, warnings );
}
else
{
restartFileNames = RifEclipseSummaryTools::getRestartFileNames( headerFileName, warnings );
}
if ( !restartFileInfos.empty() )
if ( !restartFileNames.empty() )
{
std::vector<std::string> summaryFileNames;
summaryFileNames.push_back( headerFileName.toStdString() );
for ( const auto& s : restartFileInfos )
for ( const auto& fileName : restartFileNames )
{
summaryFileNames.push_back( s.fileName.toStdString() );
summaryFileNames.push_back( fileName.toStdString() );
}
// The ordering in intended to be start of history first, so we reverse the ordering

26
ApplicationLibCode/UnitTests/RifReaderEclipseSummary-Test.cpp
View File

@@ -22,11 +22,11 @@
#include "RifEclipseSummaryTools.h"
#include "RifReaderEclipseSummary.h"
#include "RifSummaryReaderMultipleFiles.h"
#include <QDateTime>
#include <QDir>
#include "RifSummaryReaderMultipleFiles.h"
#include <memory>
//--------------------------------------------------------------------------------------------------
@@ -38,9 +38,9 @@ TEST( DISABLED_RifEclipseSummaryTest, TestRestartSummaryFileReferences_01 )
"courses/intro2020_data/reek_ensemble/3_r001_reek_50/realization-0/base_pred/eclipse/model/"
"3_R001_REEK-0.SMSPEC";
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> originFileInfos = RifEclipseSummaryTools::getRestartFiles( summaryFileName, warnings );
EXPECT_TRUE( originFileInfos.empty() );
std::vector<QString> warnings;
auto fileNames = RifEclipseSummaryTools::getRestartFileNames( summaryFileName, warnings );
EXPECT_TRUE( fileNames.empty() );
}
//--------------------------------------------------------------------------------------------------
@@ -50,16 +50,16 @@ TEST( DISABLED_RifEclipseSummaryTest, TestRestartSummaryFileReferences_02 )
{
QString summaryFileName = "e:/models/reek_ensemble/3_r001_reek_50/realization-0/base_pred/eclipse/model/3_R001_REEK-0.SMSPEC";
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> originFileInfos = RifEclipseSummaryTools::getRestartFiles( summaryFileName, warnings );
std::vector<QString> warnings;
auto fileNames = RifEclipseSummaryTools::getRestartFileNames( summaryFileName, warnings );
if ( !originFileInfos.empty() )
if ( !fileNames.empty() )
{
std::vector<std::string> smspecFilesNewFirst;
smspecFilesNewFirst.push_back( summaryFileName.toStdString() );
for ( const auto& s : originFileInfos )
for ( const auto& s : fileNames )
{
smspecFilesNewFirst.push_back( s.fileName.toStdString() );
smspecFilesNewFirst.push_back( s.toStdString() );
}
RifSummaryReaderMultipleFiles multipleSummaryFiles( smspecFilesNewFirst );
@@ -67,7 +67,7 @@ TEST( DISABLED_RifEclipseSummaryTest, TestRestartSummaryFileReferences_02 )
std::cout << ts.size();
}
EXPECT_TRUE( originFileInfos.empty() );
EXPECT_TRUE( fileNames.empty() );
}
//--------------------------------------------------------------------------------------------------
@@ -79,9 +79,9 @@ TEST( DISABLED_RifEclipseSummaryTest, BasicTestSetCurrentFolder )
QString summaryFileName = testDataRootFolder + "3_R001_REEK-1.SMSPEC";
std::vector<QString> warnings;
std::vector<RifRestartFileInfo> originFileInfos = RifEclipseSummaryTools::getRestartFiles( summaryFileName, warnings );
EXPECT_TRUE( originFileInfos.empty() );
std::vector<QString> warnings;
auto fileNames = RifEclipseSummaryTools::getRestartFileNames( summaryFileName, warnings );
EXPECT_TRUE( fileNames.empty() );
}
/*

43
ApplicationLibCode/UnitTests/opm-summary-Test.cpp
View File

@@ -1,8 +1,10 @@
#include "gtest/gtest.h"
#include "RiaLogging.h"
#include "RiaRftDefines.h"
#include "RiaTestDataDirectory.h"
#include "RifEclipseSummaryTools.h"
#include "RifOpmCommonSummary.h"
#include "RifReaderOpmRft.h"
@@ -20,6 +22,47 @@
static const QString H5_TEST_DATA_DIRECTORY = QString( "%1/h5-file/" ).arg( TEST_DATA_DIR );
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------
TEST( OpmSummaryTests, DISABLED_PerformanceReadOfRestartFilename )
{
// 2024-11-14
// This test is intended to measure the performance of reading restart filenames from a summary file
// Both resdata and opm-common are used, and for some cases resdata is much slower than opm-common
//
// Performance comparison
// BRENT-PRED_IAM_NSA_F - 100 iterations
// opm-common: 10 ms
// resdata: 10000 ms
QString filePath = H5_TEST_DATA_DIRECTORY + "NORNE_ATW2013_RFTPLT_V2.SMSPEC";
filePath = "C:/gitroot/ResInsight-regression-test/ModelData/ensemble_reek_with_params/realization-7/iter-0/eclipse/model/"
"3_R001_REEK-7.SMSPEC";
filePath = "c:/gitroot/ResInsight-regression-test/ModelData/TestCase_MultiCaseStatistics/SIMPLE_R1.SMSPEC";
filePath = "f:/Models/equinor_azure/Sum_File/BRENT-PRED_IAM_NSA_F.SMSPEC";
const int N = 100;
RiaLogging::resetTimer( "Starting opm-common" );
for ( int i = 0; i < N; i++ )
{
std::vector<QString> warnings;
auto restartFileInfos = RifEclipseSummaryTools::getRestartFileNamesOpm( filePath, warnings );
}
RiaLogging::logTimeElapsed( "Completed opm-common" );
RiaLogging::resetTimer( "Starting resdata" );
for ( int i = 0; i < N; i++ )
{
std::vector<QString> warnings;
auto restartFileInfos = RifEclipseSummaryTools::getRestartFileNames( filePath, warnings );
}
RiaLogging::logTimeElapsed( "Completed resdata" );
}
//--------------------------------------------------------------------------------------------------
///
//--------------------------------------------------------------------------------------------------