Merge pull request #5280 from OPM/improve-formations

Formations : Add const and simplify access

ApplicationCode/GeoMech/GeoMechDataModel/RigFemPartResultsCollection.cpp

@@ -139,7 +139,20 @@ void RigFemPartResultsCollection::setActiveFormationNames( RigFormationNames* ac
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-RigFormationNames* RigFemPartResultsCollection::activeFormationNames()
+std::vector<QString> RigFemPartResultsCollection::formationNames() const
+{
+    if ( activeFormationNames() )
+    {
+        return activeFormationNames()->formationNames();
+    }
+
+    return {};
+}
+
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+const RigFormationNames* RigFemPartResultsCollection::activeFormationNames() const
 {
     return m_activeFormationNamesData.p();
 }
@@ -2037,7 +2050,7 @@ RigFemScalarResultFrames* RigFemPartResultsCollection::calculateFormationIndices
     float  inf      = std::numeric_limits<float>::infinity();
     dstFrameData.resize( valCount, inf );
 
-    RigFormationNames* activeFormNames = m_activeFormationNamesData.p();
+    const RigFormationNames* activeFormNames = m_activeFormationNamesData.p();
 
     frameCountProgress.incrementProgress();
 

ApplicationCode/GeoMech/GeoMechDataModel/RigFemPartResultsCollection.h

@@ -56,7 +56,7 @@ public:
     ~RigFemPartResultsCollection() override;
 
     void                 setActiveFormationNames( RigFormationNames* activeFormationNames );
-    RigFormationNames* activeFormationNames();
+    std::vector<QString> formationNames() const;
 
     void                             addElementPropertyFiles( const std::vector<QString>& filenames );
     std::vector<RigFemResultAddress> removeElementPropertyFiles( const std::vector<QString>& filenames );
@@ -157,12 +157,14 @@ private:
     RigFemScalarResultFrames* calculateGamma( int partIndex, const RigFemResultAddress& resVarAddr );
     RigFemScalarResultFrames* calculateFormationIndices( int partIndex, const RigFemResultAddress& resVarAddr );
 
+    const RigFormationNames* activeFormationNames() const;
+
 private:
     cvf::Collection<RigFemPartResults>  m_femPartResults;
     cvf::ref<RifGeoMechReaderInterface> m_readerInterface;
     cvf::ref<RifElementPropertyReader>  m_elementPropertyReader;
     cvf::cref<RigFemPartCollection>     m_femParts;
-    cvf::ref<RigFormationNames>         m_activeFormationNamesData;
+    cvf::cref<RigFormationNames>        m_activeFormationNamesData;
 
     double m_cohesion;
     double m_frictionAngleRad;

ApplicationCode/ProjectDataModel/GridCrossPlots/RimGridCrossPlotDataSet.cpp

@@ -1001,10 +1001,7 @@ void RimGridCrossPlotDataSet::updateLegendRange()
                 RimEclipseCase* eclipseCase = dynamic_cast<RimEclipseCase*>( m_case() );
                 if ( eclipseCase )
                 {
-                    RigFormationNames* formationNames = eclipseCase->eclipseCaseData()->activeFormationNames();
+                    const std::vector<QString> categoryNames = eclipseCase->eclipseCaseData()->formationNames();
-                    if ( formationNames )
-                    {
-                        const std::vector<QString>& categoryNames = formationNames->formationNames();
                     if ( !categoryNames.empty() )
                     {
                         legendConfig()->setNamedCategoriesInverse( categoryNames );
@@ -1012,7 +1009,6 @@ void RimGridCrossPlotDataSet::updateLegendRange()
                     }
                 }
             }
-            }
             else if ( m_grouping() == GROUP_BY_TIME )
             {
                 QStringList          timeStepNames = m_case->timeStepStrings();

ApplicationCode/ProjectDataModel/RimEclipsePropertyFilter.cpp

@@ -403,15 +403,10 @@ void RimEclipsePropertyFilter::computeResultValueRange()
                     if ( m_resultDefinition->resultType() == RiaDefines::FORMATION_NAMES )
                     {
                         CVF_ASSERT( parentContainer()->reservoirView()->eclipseCase()->eclipseCaseData() );
-                        CVF_ASSERT(
-                            parentContainer()->reservoirView()->eclipseCase()->eclipseCaseData()->activeFormationNames() );
 
-                        const std::vector<QString>& fnVector = parentContainer()
+                        const std::vector<QString> fnVector =
-                                                                   ->reservoirView()
+                            parentContainer()->reservoirView()->eclipseCase()->eclipseCaseData()->formationNames();
-                                                                   ->eclipseCase()
+
-                                                                   ->eclipseCaseData()
-                                                                   ->activeFormationNames()
-                                                                   ->formationNames();
                         setCategoryNames( fnVector );
                     }
                     else if ( m_resultDefinition->resultVariable() == RiaDefines::completionTypeResultName() )

ApplicationCode/ProjectDataModel/RimEclipseResultDefinition.cpp

@@ -1882,14 +1882,14 @@ void RimEclipseResultDefinition::updateRangesForExplicitLegends( RimRegularLegen
             {
                 if ( this->resultType() == RiaDefines::FORMATION_NAMES )
                 {
-                    const std::vector<QString>& fnVector = eclipseCaseData->activeFormationNames()->formationNames();
+                    std::vector<QString> fnVector = eclipseCaseData->formationNames();
                     legendConfigToUpdate->setNamedCategoriesInverse( fnVector );
                 }
                 else if ( this->resultType() == RiaDefines::ALLEN_DIAGRAMS )
                 {
                     if ( this->resultVariable() == RiaDefines::formationAllenResultName() )
                     {
-                        const std::vector<QString>& fnVector = eclipseCaseData->activeFormationNames()->formationNames();
+                        const std::vector<QString> fnVector = eclipseCaseData->formationNames();
                         std::vector<int>           fnameIdxes;
                         for ( int i = static_cast<int>( fnVector.size() ); i > 0; --i )
                             fnameIdxes.push_back( i - 1 );

ApplicationCode/ProjectDataModel/RimEclipseView.cpp

@@ -1252,7 +1252,7 @@ void RimEclipseView::onUpdateLegends()
                     }
                     else
                     {
-                        const std::vector<QString>& fnVector = eclipseCase->activeFormationNames()->formationNames();
+                        const std::vector<QString> fnVector = eclipseCase->formationNames();
                         cellEdgeResult()->legendConfig()->setNamedCategoriesInverse( fnVector );
                     }
                 }

ApplicationCode/ProjectDataModel/RimGeoMechPropertyFilter.cpp

@@ -269,11 +269,7 @@ void RimGeoMechPropertyFilter::computeResultValueRange()
     {
         if ( resultDefinition->hasCategoryResult() )
         {
-            std::vector<QString> fnVector;
+            std::vector<QString> fnVector = resultDefinition->ownerCaseData()->femPartResults()->formationNames();
-            if ( resultDefinition->ownerCaseData()->femPartResults()->activeFormationNames() )
-            {
-                fnVector = resultDefinition->ownerCaseData()->femPartResults()->activeFormationNames()->formationNames();
-            }
             setCategoryNames( fnVector );
         }
         else

ApplicationCode/ProjectDataModel/RimGeoMechResultDefinition.cpp

@@ -697,11 +697,7 @@ void RimGeoMechResultDefinition::updateLegendTextAndRanges( RimRegularLegendConf
 
     if ( this->hasCategoryResult() )
     {
-        std::vector<QString> fnVector;
+        std::vector<QString> fnVector = gmCase->femPartResults()->formationNames();
-        if ( gmCase->femPartResults()->activeFormationNames() )
-        {
-            fnVector = gmCase->femPartResults()->activeFormationNames()->formationNames();
-        }
         legendConfigToUpdate->setNamedCategoriesInverse( fnVector );
     }
 

ApplicationCode/ProjectDataModel/RimWellLogTrack.cpp

@@ -2027,17 +2027,11 @@ std::vector<QString> RimWellLogTrack::formationNamesVector( RimCase* rimCase )
 
     if ( eclipseCase )
     {
-        if ( eclipseCase->eclipseCaseData()->activeFormationNames() )
+        return eclipseCase->eclipseCaseData()->formationNames();
-        {
-            return eclipseCase->eclipseCaseData()->activeFormationNames()->formationNames();
-        }
     }
     else if ( geoMechCase )
     {
-        if ( geoMechCase->geoMechData()->femPartResults()->activeFormationNames() )
+        return geoMechCase->geoMechData()->femPartResults()->formationNames();
-        {
-            return geoMechCase->geoMechData()->femPartResults()->activeFormationNames()->formationNames();
-        }
     }
 
     return std::vector<QString>();

ApplicationCode/ReservoirDataModel/RigCaseCellResultsData.cpp

@@ -2890,7 +2890,7 @@ void RigCaseCellResultsData::setActiveFormationNames( RigFormationNames* activeF
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-RigFormationNames* RigCaseCellResultsData::activeFormationNames()
+const RigFormationNames* RigCaseCellResultsData::activeFormationNames() const
 {
     return m_activeFormationNamesData.p();
 }

ApplicationCode/ReservoirDataModel/RigCaseCellResultsData.h

@@ -58,7 +58,7 @@ public:
     const RifReaderInterface* readerInterface() const;
     void                      setHdf5Filename( const QString& hdf5SourSimFilename );
     void                      setActiveFormationNames( RigFormationNames* activeFormationNames );
-    RigFormationNames*        activeFormationNames();
+    const RigFormationNames*  activeFormationNames() const;
     RigAllenDiagramData*      allenDiagramData();
 
     void                     setMainGrid( RigMainGrid* ownerGrid );
@@ -197,7 +197,7 @@ private:
 
 private:
     cvf::ref<RifReaderInterface>  m_readerInterface;
-    cvf::ref<RigFormationNames>   m_activeFormationNamesData;
+    cvf::cref<RigFormationNames>  m_activeFormationNamesData;
     cvf::ref<RigAllenDiagramData> m_allenDiagramData;
 
     std::vector<std::vector<std::vector<double>>>

ApplicationCode/ReservoirDataModel/RigEclipseCaseData.cpp

@@ -727,11 +727,24 @@ void RigEclipseCaseData::setActiveFormationNamesAndUpdatePlots( RigFormationName
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------
-RigFormationNames* RigEclipseCaseData::activeFormationNames()
+const RigFormationNames* RigEclipseCaseData::activeFormationNames() const
 {
     return m_matrixModelResults->activeFormationNames();
 }
 
+//--------------------------------------------------------------------------------------------------
+///
+//--------------------------------------------------------------------------------------------------
+const std::vector<QString> RigEclipseCaseData::formationNames() const
+{
+    if ( activeFormationNames() )
+    {
+        return activeFormationNames()->formationNames();
+    }
+
+    return {};
+}
+
 //--------------------------------------------------------------------------------------------------
 ///
 //--------------------------------------------------------------------------------------------------

ApplicationCode/ReservoirDataModel/RigEclipseCaseData.h

@@ -91,7 +91,8 @@ public:
 
     void                       setActiveFormationNames( RigFormationNames* activeFormationNames );
     void                       setActiveFormationNamesAndUpdatePlots( RigFormationNames* activeFormationNames );
-    RigFormationNames*   activeFormationNames();
+    const RigFormationNames*   activeFormationNames() const;
+    const std::vector<QString> formationNames() const;
     RigAllenDiagramData*       allenDiagramData();
 
     void                                   setSimWellData( const cvf::Collection<RigSimWellData>& data );

ApplicationCode/ReservoirDataModel/RigEclipseCrossPlotDataExtractor.cpp

@@ -47,8 +47,6 @@ RigEclipseCrossPlotResult
     RigCaseCellResultsData* resultData = caseData->results( RiaDefines::MATRIX_MODEL );
     if ( !resultData ) return result;
 
-    RigFormationNames* activeFormationNames = resultData->activeFormationNames();
-
     const std::vector<std::vector<double>>* catValuesForAllSteps = nullptr;
 
     if ( xAddress.isValid() && yAddress.isValid() )
@@ -136,6 +134,8 @@ RigEclipseCrossPlotResult
                 }
                 else if ( groupingType == GROUP_BY_FORMATION )
                 {
+                    const RigFormationNames* activeFormationNames = resultData->activeFormationNames();
+
                     if ( activeFormationNames )
                     {
                         int    category = 0;

ApplicationCode/ReservoirDataModel/RigFormationNames.h

@@ -29,7 +29,7 @@ public:
     RigFormationNames();
     ~RigFormationNames() override;
 
-    int formationIndexFromKLayerIdx( size_t Kidx )
+    int formationIndexFromKLayerIdx( size_t Kidx ) const
     {
         if ( Kidx >= m_nameIndexPrKLayer.size() ) return -1;
         return m_nameIndexPrKLayer[Kidx];

ApplicationCode/UserInterface/RiuResultTextBuilder.cpp

@@ -490,16 +490,15 @@ QString RiuResultTextBuilder::nncResultText()
                                 eclipseCase->allenDiagramData()->formationIndexCombinationFromCategory(
                                     ( *nncValues )[m_nncIndex] );
 
-                            RigFormationNames* fmNames = eclipseCase->activeFormationNames();
+                            std::vector<QString> fmNames = eclipseCase->formationNames();
                             // clang-format off
-                            if ( fmNames && 
+                            if ( fmIndexPair.first >= 0 && 
-                                 fmIndexPair.first >= 0 && 
                                  fmIndexPair.second >= 0 &&
-                                 fmNames->formationNames().size() > fmIndexPair.first &&
+                                 fmNames.size() > fmIndexPair.first &&
-                                 fmNames->formationNames().size() > fmIndexPair.second )
+                                 fmNames.size() > fmIndexPair.second )
                             {
-                                resultValueText = fmNames->formationNames()[fmIndexPair.first] + " - " +
+                                resultValueText = fmNames[fmIndexPair.first] + " - " +
-                                                  fmNames->formationNames()[fmIndexPair.second];
+                                                  fmNames[fmIndexPair.second];
                             }
                             // clang-format on
                         }