Merge pull request #5009 from OPM/feature-replace-summary-case

Replace binary eclipse case and summary case feature.

Closes #4499 and #4987.

ApplicationCode/Commands/CMakeLists_files.cmake

@@ -66,8 +66,10 @@ ${CMAKE_CURRENT_LIST_DIR}/RicCloseSourSimDataFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicCommandFeature.h
 
 ${CMAKE_CURRENT_LIST_DIR}/RicReloadCaseFeature.h
+${CMAKE_CURRENT_LIST_DIR}/RicReplaceCaseFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicReloadSummaryCaseFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicReloadSummaryCasesFeature.h
+${CMAKE_CURRENT_LIST_DIR}/RicReplaceSummaryCaseFeature.h
 ${CMAKE_CURRENT_LIST_DIR}/RicFlyToObjectFeature.h
 
 ${CMAKE_CURRENT_LIST_DIR}/RicGridStatisticsDialog.h
@@ -149,7 +151,9 @@ ${CMAKE_CURRENT_LIST_DIR}/RicDeleteSummaryCaseCollectionFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicCloseSourSimDataFeature.cpp
 
 ${CMAKE_CURRENT_LIST_DIR}/RicReloadCaseFeature.cpp
+${CMAKE_CURRENT_LIST_DIR}/RicReplaceCaseFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicReloadSummaryCaseFeature.cpp
+${CMAKE_CURRENT_LIST_DIR}/RicReplaceSummaryCaseFeature.cpp
 ${CMAKE_CURRENT_LIST_DIR}/RicFlyToObjectFeature.cpp
 
 ${CMAKE_CURRENT_LIST_DIR}/RicGridStatisticsDialog.cpp

ApplicationCode/Commands/RicImportGeneralDataFeature.cpp

@@ -154,7 +154,7 @@ void RicImportGeneralDataFeature::setupActionLook( QAction* actionToSetup )
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-void RicImportGeneralDataFeature::openFileDialog( ImportFileType fileTypes )
+QStringList RicImportGeneralDataFeature::getEclipseFileNamesWithDialog( RiaDefines::ImportFileType fileTypes )
 {
     QString eclipseGridFilePattern( "*.GRID" );
     QString eclipseEGridFilePattern( "*.EGRID" );
@@ -170,14 +170,14 @@ void RicImportGeneralDataFeature::openFileDialog( ImportFileType fileTypes )
                                 .arg( eclipseInputFilePattern )
                                 .arg( eclipseSummaryFilePattern );
     }
-    if ( fileTypes & ECLIPSE_GRID_FILE )
-    {
-        filePatternTexts += QString( "Eclipse Grid Files (%1)" ).arg( eclipseGridFilePattern );
-    }
     if ( fileTypes & ECLIPSE_EGRID_FILE )
     {
         filePatternTexts += QString( "Eclipse EGrid Files (%1)" ).arg( eclipseEGridFilePattern );
     }
+    if ( fileTypes & ECLIPSE_GRID_FILE )
+    {
+        filePatternTexts += QString( "Eclipse Grid Files (%1)" ).arg( eclipseGridFilePattern );
+    }
     if ( fileTypes & ECLIPSE_INPUT_FILE )
     {
         filePatternTexts += QString( "Eclipse Input Files and Input Properties (%1)" ).arg( eclipseInputFilePattern );
@@ -195,7 +195,15 @@ void RicImportGeneralDataFeature::openFileDialog( ImportFileType fileTypes )
                                                            "Import Data File",
                                                            defaultDir,
                                                            fullPattern );
+    return fileNames;
+}
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicImportGeneralDataFeature::openFileDialog( ImportFileType fileTypes )
+{
+    QStringList fileNames = getEclipseFileNamesWithDialog( fileTypes );
     if ( fileNames.empty() ) return;
 
     if ( fileTypes == ANY_ECLIPSE_FILE )

ApplicationCode/Commands/RicImportGeneralDataFeature.h

@@ -48,6 +48,7 @@ public:
 
     static OpenCaseResults openEclipseFilesFromFileNames( const QStringList& fileNames, bool doCreateDefaultPlot );
     static QStringList     fileNamesFromCaseNames( const QStringList& caseNames );
+    static QStringList     getEclipseFileNamesWithDialog( RiaDefines::ImportFileType fileTypes );
 
 protected:
     // Overrides

ApplicationCode/Commands/RicReplaceCaseFeature.cpp

@@ -0,0 +1,131 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2015-     Statoil ASA
+//  Copyright (C) 2015-     Ceetron Solutions AS
+//
+//  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 "RicReplaceCaseFeature.h"
+
+#include "RiaGuiApplication.h"
+#include "RiaSummaryTools.h"
+
+#include "RicImportGeneralDataFeature.h"
+
+#include "RimEclipseCase.h"
+#include "RimEclipseResultCase.h"
+#include "RimGridSummaryCase.h"
+#include "RimReloadCaseTools.h"
+#include "RimSummaryCase.h"
+#include "RimSummaryCaseMainCollection.h"
+#include "RimSummaryPlot.h"
+#include "RimSummaryPlotCollection.h"
+#include "RimTimeStepFilter.h"
+
+#include "Riu3dSelectionManager.h"
+
+#include "cafPdmObject.h"
+#include "cafSelectionManager.h"
+
+#include <QAction>
+#include <QFileInfo>
+
+CAF_CMD_SOURCE_INIT( RicReplaceCaseFeature, "RicReplaceCaseFeature" );
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RicReplaceCaseFeature::isCommandEnabled()
+{
+    std::vector<caf::PdmObject*> selectedFormationNamesCollObjs;
+    caf::SelectionManager::instance()->objectsByType( &selectedFormationNamesCollObjs );
+    for ( caf::PdmObject* pdmObject : selectedFormationNamesCollObjs )
+    {
+        if ( dynamic_cast<RimEclipseResultCase*>( pdmObject ) )
+        {
+            return true;
+        }
+    }
+
+    return false;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicReplaceCaseFeature::onActionTriggered( bool isChecked )
+{
+    std::vector<RimEclipseResultCase*> selectedEclipseCases;
+    caf::SelectionManager::instance()->objectsByType( &selectedEclipseCases );
+
+    RiaGuiApplication::clearAllSelections();
+
+    const QStringList fileNames = RicImportGeneralDataFeature::getEclipseFileNamesWithDialog(
+        RiaDefines::ECLIPSE_RESULT_GRID );
+    if ( fileNames.isEmpty() ) return;
+
+    const QString fileName = fileNames[0];
+
+    for ( RimEclipseResultCase* selectedCase : selectedEclipseCases )
+    {
+        selectedCase->setGridFileName( fileName );
+        selectedCase->reloadEclipseGridFile();
+
+        std::vector<RimTimeStepFilter*> timeStepFilter;
+        selectedCase->descendantsIncludingThisOfType( timeStepFilter );
+        if ( timeStepFilter.size() == 1 )
+        {
+            timeStepFilter[0]->clearFilteredTimeSteps();
+        }
+
+        RimReloadCaseTools::reloadAllEclipseData( selectedCase );
+        selectedCase->updateConnectedEditors();
+
+        // Use the file base name as case user description
+        QFileInfo fi( fileName );
+        selectedCase->caseUserDescription = fi.baseName();
+
+        // Find and update attached grid summary cases.
+        RimSummaryCaseMainCollection* sumCaseColl = RiaSummaryTools::summaryCaseMainCollection();
+        if ( sumCaseColl )
+        {
+            RimGridSummaryCase* gridSummaryCase = dynamic_cast<RimGridSummaryCase*>(
+                sumCaseColl->findSummaryCaseFromEclipseResultCase( selectedCase ) );
+            if ( gridSummaryCase )
+            {
+                gridSummaryCase->setAssociatedEclipseCase( selectedCase );
+                gridSummaryCase->resetAutoShortName();
+                gridSummaryCase->createSummaryReaderInterface();
+                gridSummaryCase->createRftReaderInterface();
+
+                RimSummaryPlotCollection* summaryPlotColl = RiaSummaryTools::summaryPlotCollection();
+                for ( RimSummaryPlot* summaryPlot : summaryPlotColl->summaryPlots )
+                {
+                    summaryPlot->loadDataAndUpdate();
+                }
+            }
+        }
+    }
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicReplaceCaseFeature::setupActionLook( QAction* actionToSetup )
+{
+    actionToSetup->setText( "Replace" );
+    // TODO: icon?
+    // actionToSetup->setIcon( QIcon( ":/Refresh-32.png" ) );
+}

ApplicationCode/Commands/RicReplaceCaseFeature.h

@@ -0,0 +1,31 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2019-     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.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "cafCmdFeature.h"
+
+class RicReplaceCaseFeature : public caf::CmdFeature
+{
+    CAF_CMD_HEADER_INIT;
+
+protected:
+    bool isCommandEnabled() override;
+    void onActionTriggered( bool isChecked ) override;
+    void setupActionLook( QAction* actionToSetup ) override;
+};

ApplicationCode/Commands/RicReplaceSummaryCaseFeature.cpp

@@ -0,0 +1,83 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2019-     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 "RicReplaceSummaryCaseFeature.h"
+
+#include "RiaLogging.h"
+#include "RiaSummaryTools.h"
+
+#include "RicImportGeneralDataFeature.h"
+
+#include "RimFileSummaryCase.h"
+#include "RimSummaryCase.h"
+#include "RimSummaryCaseCollection.h"
+#include "RimSummaryCaseMainCollection.h"
+#include "RimSummaryPlot.h"
+#include "RimSummaryPlotCollection.h"
+
+#include "cafPdmObject.h"
+#include "cafSelectionManager.h"
+
+#include <QAction>
+
+CAF_CMD_SOURCE_INIT( RicReplaceSummaryCaseFeature, "RicReplaceSummaryCaseFeature" );
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+bool RicReplaceSummaryCaseFeature::isCommandEnabled()
+{
+    RimSummaryCase* rimSummaryCase = caf::SelectionManager::instance()->selectedItemOfType<RimFileSummaryCase>();
+    return rimSummaryCase != nullptr;
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicReplaceSummaryCaseFeature::onActionTriggered( bool isChecked )
+{
+    RimFileSummaryCase* summaryCase = caf::SelectionManager::instance()->selectedItemOfType<RimFileSummaryCase>();
+    if ( !summaryCase ) return;
+
+    const QStringList fileNames = RicImportGeneralDataFeature::getEclipseFileNamesWithDialog(
+        RiaDefines::ECLIPSE_SUMMARY_FILE );
+    if ( fileNames.isEmpty() ) return;
+
+    QString oldSummaryHeaderFilename = summaryCase->summaryHeaderFilename();
+    summaryCase->setSummaryHeaderFileName( fileNames[0] );
+    summaryCase->resetAutoShortName();
+    summaryCase->createSummaryReaderInterface();
+    summaryCase->createRftReaderInterface();
+    RiaLogging::info( QString( "Replaced summary data for %1" ).arg( oldSummaryHeaderFilename ) );
+
+    RimSummaryPlotCollection* summaryPlotColl = RiaSummaryTools::summaryPlotCollection();
+    for ( RimSummaryPlot* summaryPlot : summaryPlotColl->summaryPlots )
+    {
+        summaryPlot->loadDataAndUpdate();
+    }
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RicReplaceSummaryCaseFeature::setupActionLook( QAction* actionToSetup )
+{
+    actionToSetup->setText( "Replace" );
+    // TODO: get an icon?
+    // actionToSetup->setIcon( QIcon( ":/Refresh-32.png" ) );
+}

ApplicationCode/Commands/RicReplaceSummaryCaseFeature.h

@@ -0,0 +1,31 @@
+/////////////////////////////////////////////////////////////////////////////////
+//
+//  Copyright (C) 2019-     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.
+//
+/////////////////////////////////////////////////////////////////////////////////
+
+#pragma once
+
+#include "cafCmdFeature.h"
+
+class RicReplaceSummaryCaseFeature : public caf::CmdFeature
+{
+    CAF_CMD_HEADER_INIT;
+
+protected:
+    bool isCommandEnabled() override;
+    void onActionTriggered( bool isChecked ) override;
+    void setupActionLook( QAction* actionToSetup ) override;
+};

ApplicationCode/ProjectDataModel/RimContextCommandBuilder.cpp

@@ -847,6 +847,7 @@ caf::CmdFeatureMenuBuilder RimContextCommandBuilder::commandsFromSelection()
         menuBuilder << "RicImportObservedDataFeature";
         menuBuilder << "RicImportObservedFmuDataFeature";
         menuBuilder << "RicReloadSummaryCaseFeature";
+        menuBuilder << "RicReplaceSummaryCaseFeature";
         menuBuilder << "RicCreateSummaryCaseCollectionFeature";
         menuBuilder << "Separator";
         menuBuilder << "RicCutReferencesToClipboardFeature";
@@ -888,6 +889,7 @@ caf::CmdFeatureMenuBuilder RimContextCommandBuilder::commandsFromSelection()
         {
             menuBuilder << "RicAddEclipseInputPropertyFeature";
             menuBuilder << "RicReloadCaseFeature";
+            menuBuilder << "RicReplaceCaseFeature";
             createExecuteScriptForCasesFeatureMenu( menuBuilder );
             menuBuilder << "RicCloseSourSimDataFeature";
         }

ApplicationCode/ProjectDataModel/RimReloadCaseTools.cpp

@@ -117,6 +117,7 @@ void RimReloadCaseTools::updateAll3dViews( RimEclipseCase* eclipseCase )
     for ( RimEclipseView* reservoirView : eclipseCase->reservoirViews() )
     {
         CVF_ASSERT( reservoirView );
+        reservoirView->setEclipseCase( eclipseCase );
         reservoirView->loadDataAndUpdate();
         reservoirView->updateGridBoxData();
         reservoirView->updateAnnotationItems();

ApplicationCode/ProjectDataModel/Summary/RimSummaryCase.cpp

@@ -34,6 +34,8 @@
 
 CAF_PDM_ABSTRACT_SOURCE_INIT( RimSummaryCase, "SummaryCase" );
 
+const QString RimSummaryCase::DEFAULT_DISPLAY_NAME = "Display Name";
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
@@ -41,7 +43,7 @@ RimSummaryCase::RimSummaryCase()
 {
     CAF_PDM_InitObject( "Summary Case", ":/SummaryCase16x16.png", "", "" );
 
-    CAF_PDM_InitField( &m_shortName, "ShortName", QString( "Display Name" ), "Display Name", "", "", "" );
+    CAF_PDM_InitField( &m_shortName, "ShortName", QString( "Display Name" ), DEFAULT_DISPLAY_NAME, "", "", "" );
     CAF_PDM_InitField( &m_useAutoShortName, "AutoShortyName", false, "Use Auto Display Name", "", "", "" );
 
     CAF_PDM_InitFieldNoDefault( &m_summaryHeaderFilename, "SummaryHeaderFilename", "Summary Header File", "", "", "" );
@@ -231,10 +233,19 @@ void RimSummaryCase::updateAutoShortName()
 
         m_shortName = oilField->uniqueShortNameForCase( this );
     }
-    else if ( m_shortName() == QString( "Display Name" ) )
+    else if ( m_shortName() == DEFAULT_DISPLAY_NAME )
     {
         m_shortName = caseName();
     }
 
     updateTreeItemName();
 }
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+void RimSummaryCase::resetAutoShortName()
+{
+    m_shortName = DEFAULT_DISPLAY_NAME;
+    updateAutoShortName();
+}

ApplicationCode/ProjectDataModel/Summary/RimSummaryCase.h

@@ -50,6 +50,7 @@ public:
     RiaEclipseUnitTools::UnitSystemType unitsSystem();
 
     void updateAutoShortName();
+    void resetAutoShortName();
     void updateOptionSensitivity();
 
     virtual void                       createSummaryReaderInterface() = 0;
@@ -87,6 +88,8 @@ protected:
 
     std::shared_ptr<RigCaseRealizationParameters> m_crlParameters;
 
+    static const QString DEFAULT_DISPLAY_NAME;
+
 private:
     void initAfterRead() override;
 };