New SummaryNode implementation

CMakeLists_files.cmake

@@ -41,6 +41,7 @@ list (APPEND MAIN_SOURCE_FILES
 )
 if(ENABLE_ECL_INPUT)
   list(APPEND MAIN_SOURCE_FILES
+    src/opm/io/eclipse/SummaryNode.cpp
     src/opm/json/JsonObject.cpp
     src/opm/parser/eclipse/Deck/Deck.cpp
     src/opm/parser/eclipse/Deck/DeckItem.cpp
@@ -239,6 +240,7 @@ if(ENABLE_ECL_OUTPUT)
           src/opm/io/eclipse/ERst.cpp
           src/opm/io/eclipse/ESmry.cpp
           src/opm/io/eclipse/OutputStream.cpp
+          src/opm/io/eclipse/SummaryNode.cpp
           src/opm/io/eclipse/rst/connection.cpp
           src/opm/io/eclipse/rst/group.cpp
           src/opm/io/eclipse/rst/header.cpp
@@ -500,6 +502,7 @@ list( APPEND PUBLIC_HEADER_FILES
 )
 if(ENABLE_ECL_INPUT)
   list(APPEND PUBLIC_HEADER_FILES
+       opm/io/eclipse/SummaryNode.hpp
        opm/json/JsonObject.hpp
        opm/parser/eclipse/Utility/Stringview.hpp
        opm/parser/eclipse/Utility/Functional.hpp
@@ -719,6 +722,7 @@ if(ENABLE_ECL_OUTPUT)
         opm/io/eclipse/ESmry.hpp
         opm/io/eclipse/PaddedOutputString.hpp
         opm/io/eclipse/OutputStream.hpp
+        opm/io/eclipse/SummaryNode.hpp
         opm/io/eclipse/rst/connection.hpp
         opm/io/eclipse/rst/group.hpp
         opm/io/eclipse/rst/header.hpp
@@ -763,3 +767,9 @@ if(ENABLE_ECL_OUTPUT)
         opm/output/OutputWriter.hpp
         )
 endif()
+
+if(ENABLE_ECL_INPUT OR ENABLE_ECL_OUTPUT)
+  list(APPEND TEST_SOURCE_FILES
+      tests/test_SummaryNode.cpp
+)
+endif()

opm/io/eclipse/SummaryNode.hpp

@@ -0,0 +1,58 @@
+/*
+   Copyright 2020 Equinor 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 <http://www.gnu.org/licenses/>.
+   */
+
+#include <string>
+
+namespace Opm::EclIO {
+
+struct SummaryNode {
+    enum class Category {
+        Well,
+        Group,
+        Field,
+        Region,
+        Block,
+        Connection,
+        Segment,
+        Miscellaneous,
+    };
+
+    enum class Type {
+        Rate,
+        Total,
+        Ratio,
+        Pressure,
+        Count,
+        Mode,
+        Undefined,
+    };
+
+    const std::string keyword;
+    const Category category;
+    const Type type;
+    const std::string wgname;
+    const int number;
+
+    constexpr static int default_number { std::numeric_limits<int>::min() };
+
+    std::string unique_key() const;
+    bool is_user_defined() const;
+};
+
+} // namespace Opm::EclIO

opm/parser/eclipse/EclipseState/Schedule/Group/Group.hpp

@@ -21,8 +21,9 @@
 #define GROUP2_HPP
 
 
-#include <string>
 #include <map>
+#include <optional>
+#include <string>
 
 #include <opm/parser/eclipse/Deck/UDAValue.hpp>
 #include <opm/parser/eclipse/EclipseState/Util/IOrderSet.hpp>
@@ -221,8 +222,8 @@ struct ProductionControls {
 
     // [[deprecated("use Group::control_group() or Group::flow_group()")]]
     const std::string& parent() const;
-    const std::string& control_group() const;
-    const std::string& flow_group() const;
+    std::optional<std::string> control_group() const;
+    std::optional<std::string> flow_group() const;
 
     bool updateParent(const std::string& parent);
     bool updateInjection(const GroupInjectionProperties& injection);

opm/parser/eclipse/EclipseState/SummaryConfig/SummaryConfig.hpp

@@ -26,6 +26,7 @@
 #include <string>
 #include <vector>
 
+#include <opm/io/eclipse/SummaryNode.hpp>
 #include <opm/common/OpmLog/Location.hpp>
 
 namespace Opm {
@@ -38,17 +39,8 @@ namespace Opm {
 
     class SummaryConfigNode {
     public:
-        enum class Category {
-            Well, Group, Field,
-            Region, Block,
-            Connection, Segment,
-            Miscellaneous,
-        };
-
-        enum class Type {
-            Rate, Total, Ratio, Pressure, Count, Mode,
-            Undefined,
-        };
+        using Category = Opm::EclIO::SummaryNode::Category;
+        using Type = Opm::EclIO::SummaryNode::Type;
 
         SummaryConfigNode() = default;
         explicit SummaryConfigNode(std::string keyword, const Category cat, Location loc_arg);
@@ -68,6 +60,10 @@ namespace Opm {
         std::string uniqueNodeKey() const;
         const Location& location( ) const { return this->loc; }
 
+        operator Opm::EclIO::SummaryNode() const {
+            return { keyword_, category_, type_, name_, number_ };
+        }
+
         template<class Serializer>
         void serializeOp(Serializer& serializer)
         {

src/opm/io/eclipse/SummaryNode.cpp

@@ -0,0 +1,113 @@
+/*
+   Copyright 2020 Equinor 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 <http://www.gnu.org/licenses/>.
+   */
+
+#include <numeric>
+#include <regex>
+#include <string>
+#include <unordered_set>
+#include <vector>
+
+#include <opm/io/eclipse/SummaryNode.hpp>
+
+namespace {
+
+constexpr bool use_number(Opm::EclIO::SummaryNode::Category category) {
+    switch (category) {
+    case Opm::EclIO::SummaryNode::Category::Block:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Connection:    [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Region:        [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Segment:
+        return true;
+    case Opm::EclIO::SummaryNode::Category::Field:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Group:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Miscellaneous: [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Well:
+        return false;
+    }
+}
+
+constexpr bool use_name(Opm::EclIO::SummaryNode::Category category) {
+    switch (category) {
+    case Opm::EclIO::SummaryNode::Category::Connection:    [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Group:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Segment:       [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Well:
+        return true;
+    case Opm::EclIO::SummaryNode::Category::Block:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Field:         [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Miscellaneous: [[fallthrough]];
+    case Opm::EclIO::SummaryNode::Category::Region:
+        return false;
+    }
+}
+
+};
+
+std::string Opm::EclIO::SummaryNode::unique_key() const {
+    std::vector<std::string> key_parts { keyword } ;
+
+    if (use_name(category))
+        key_parts.emplace_back(wgname);
+
+    if (use_number(category))
+        key_parts.emplace_back(std::to_string(number));
+
+    auto compose_key = [](std::string& key, const std::string& key_part) -> std::string {
+        constexpr auto delimiter { ':' } ;
+        return key.empty() ? key_part : key + delimiter + key_part;
+    };
+
+    return std::accumulate(std::begin(key_parts), std::end(key_parts), std::string(), compose_key);
+}
+
+bool Opm::EclIO::SummaryNode::is_user_defined() const {
+    static const std::unordered_set<std::string> udq_blacklist {
+        "AUTOCOAR",
+        "AUTOREF",
+        "FULLIMP",
+        "GUIDECAL",
+        "GUIDERAT",
+        "GUPFREQ",
+        "RUNSPEC",
+        "RUNSUM",
+        "SUMMARY",
+        "SUMTHIN",
+        "SURF",
+        "SURFACT",
+        "SURFACTW",
+        "SURFADDW",
+        "SURFADS",
+        "SURFCAPD",
+        "SURFESAL",
+        "SURFNUM",
+        "SURFOPTS",
+        "SURFROCK",
+        "SURFST",
+        "SURFSTES",
+        "SURFVISC",
+        "SURFWNUM",
+    } ;
+
+    static const std::regex user_defined_regex { "[ABCFGRSW]U[A-Z]+" } ;
+
+    const bool matched     { std::regex_match(keyword, user_defined_regex) } ;
+    const bool blacklisted { udq_blacklist.find(keyword) != udq_blacklist.end() } ;
+
+    return matched && !blacklisted;
+}