Add WELL_THP_UPDATE schedule event

Raised when the well THP limit and/or VFP table is (re)specified: by
WCONPROD or WCONHIST, by WELTARG with THP or VFP control, or by WTMULT
with THP control. Unlike PRODUCTION_UPDATE it is raised also when the
entered values are unchanged, since re-specifying either input cancels
a THP limit imposed dynamically by the simulator (e.g. by network
balancing).

Author: GitPaean

opm/input/eclipse/Schedule/Events.hpp

@@ -47,7 +47,7 @@ namespace Opm
             NEW_GROUP = (UINT64_C(1) << 3),
 
             /// The PRODUCTION_UPDATE event is triggered by the WCONPROD,
-            /// WCONHIST, WELTARG, WEFAC keywords.  The event will be
+            /// WCONHIST, WELTARG, WTMULT keywords.  The event will be
             /// triggered if *any* of the elements in one of keywords is
             /// changed. Quite simlar for INJECTION_UPDATE and
             /// POLYMER_UPDATE.
@@ -113,6 +113,15 @@ namespace Opm
             /// request OPEN for an existing connection/completion (regardless of
             /// the recorded schedule state).
             REQUEST_OPEN_COMPLETION = (UINT64_C(1) << 24),
+
+            /// The well THP limit and/or VFP table has been (re)specified
+            /// by WCONPROD or WCONHIST for the named wells, by WELTARG with
+            /// THP or VFP control, or by WTMULT with THP control.  Unlike
+            /// PRODUCTION_UPDATE, the event is also triggered when the
+            /// entered values are unchanged, since re-specifying either
+            /// input cancels a THP limit imposed dynamically by the
+            /// simulator (e.g. by network balancing).
+            WELL_THP_UPDATE = (UINT64_C(1) << 25),
         };
     } // namespace ScheduleEvents
 

opm/input/eclipse/Schedule/Well/WellKeywordHandlers.cpp

@@ -188,6 +188,11 @@ void handleWCONHIST(HandlerContext& handlerContext)
                 update_well = true;
             }
 
+            // The VFP table (item 7) is re-specified by every WCONHIST,
+            // whether or not any value changed.
+            handlerContext.state().events().addEvent( ScheduleEvents::WELL_THP_UPDATE );
+            handlerContext.state().wellgroup_events().addEvent( well2.name(), ScheduleEvents::WELL_THP_UPDATE);
+
             if (update_well) {
                 handlerContext.state().events().addEvent( ScheduleEvents::PRODUCTION_UPDATE );
                 handlerContext.state().wellgroup_events().addEvent( well2.name(), ScheduleEvents::PRODUCTION_UPDATE);
@@ -437,6 +442,11 @@ void handleWCONPROD(HandlerContext& handlerContext)
                 update_well = true;
             }
 
+            // The THP limit and VFP table (items 10 and 11) are re-specified
+            // by every WCONPROD, whether or not any value changed.
+            handlerContext.state().events().addEvent( ScheduleEvents::WELL_THP_UPDATE );
+            handlerContext.state().wellgroup_events().addEvent( well2.name(), ScheduleEvents::WELL_THP_UPDATE);
+
             if (update_well) {
                 handlerContext.state().events().addEvent( ScheduleEvents::PRODUCTION_UPDATE );
                 handlerContext.state().wellgroup_events().addEvent( well2.name(), ScheduleEvents::PRODUCTION_UPDATE);
@@ -834,6 +844,15 @@ void handleWELTARG(HandlerContext& handlerContext)
                 }
             }
 
+            // The THP limit or VFP table is re-specified, whether or not
+            // the value changed.
+            if (well2.isProducer() &&
+                (cmode == Well::WELTARGCMode::THP || cmode == Well::WELTARGCMode::VFP))
+            {
+                handlerContext.state().events().addEvent( ScheduleEvents::WELL_THP_UPDATE );
+                handlerContext.state().wellgroup_events().addEvent( well_name, ScheduleEvents::WELL_THP_UPDATE);
+            }
+
             if (update) {
                 if (well2.isProducer()) {
                     handlerContext.state().wellgroup_events().addEvent( well_name, ScheduleEvents::PRODUCTION_UPDATE);

opm/input/eclipse/Schedule/Well/WellPropertiesKeywordHandlers.cpp

@@ -633,6 +633,17 @@ void handleWTMULT(HandlerContext& handlerContext)
                 properties->handleWTMULT(cmode, factor.get<double>());
 
                 well.updateProduction(properties);
+
+                // The THP limit is re-specified (multiplied).
+                if (cmode == Well::WELTARGCMode::THP) {
+                    handlerContext.state().events()
+                        .addEvent(ScheduleEvents::WELL_THP_UPDATE);
+
+                    handlerContext.state().wellgroup_events()
+                        .addEvent(well_name, ScheduleEvents::WELL_THP_UPDATE);
+
+                }
+
                 if (update_well) {
                     handlerContext.state().events()
                         .addEvent(ScheduleEvents::PRODUCTION_UPDATE);

tests/parser/ScheduleTests.cpp

@@ -7232,3 +7232,91 @@ END
         BOOST_CHECK_CLOSE(s->width(), 1819.202122, 1.0e-8);
     }
 }
+
+BOOST_AUTO_TEST_CASE(WellTHPUpdateEvent) {
+    const auto schedule = make_schedule(R"(
+RUNSPEC
+OIL
+WATER
+GAS
+
+START
+8 MAR 1998 /
+
+SCHEDULE
+
+WELSPECS
+    'P1' 'G1'  1 1 2500 'OIL' /
+/
+WCONPROD
+    'P1' 'OPEN' 'ORAT' 1000 4* 50.0 /
+/
+
+DATES        -- 1
+ 10 JUN 1998 /
+/
+
+WCONPROD     -- identical to the current well controls
+    'P1' 'OPEN' 'ORAT' 1000 4* 50.0 /
+/
+
+DATES        -- 2
+ 10 JUL 1998 /
+/
+
+WELTARG
+    'P1' 'ORAT' 500 /
+/
+
+DATES        -- 3
+ 10 AUG 1998 /
+/
+
+WELTARG
+    'P1' 'THP' 60 /
+/
+
+DATES        -- 4
+ 10 SEP 1998 /
+/
+
+WELTARG      -- unchanged VFP table number
+    'P1' 'VFP' 0 /
+/
+
+DATES        -- 5
+ 10 OKT 1998 /
+/
+
+WTMULT
+    'P1' 'THP' 2.0 /
+/
+
+DATES        -- 6
+ 10 NOV 1998 /
+/
+
+WCONHIST
+    'P1' 'OPEN' 'ORAT' 100 0 0 /
+/
+)");
+
+    // Initial WCONPROD specifies the THP limit and VFP table
+    BOOST_CHECK( schedule[0].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    // A WCONPROD with unchanged values re-specifies the THP limit and VFP
+    // table without triggering PRODUCTION_UPDATE
+    BOOST_CHECK( schedule[1].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    BOOST_CHECK(!schedule[1].wellgroup_events().hasEvent("P1", ScheduleEvents::PRODUCTION_UPDATE));
+    // WELTARG ORAT does not touch the THP limit or VFP table
+    BOOST_CHECK(!schedule[2].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    BOOST_CHECK( schedule[2].wellgroup_events().hasEvent("P1", ScheduleEvents::PRODUCTION_UPDATE));
+    // WELTARG THP re-specifies the THP limit
+    BOOST_CHECK( schedule[3].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    // WELTARG VFP re-specifies the VFP table, also for an unchanged value
+    BOOST_CHECK( schedule[4].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    BOOST_CHECK(!schedule[4].wellgroup_events().hasEvent("P1", ScheduleEvents::PRODUCTION_UPDATE));
+    // WTMULT with THP control re-specifies (multiplies) the THP limit
+    BOOST_CHECK( schedule[5].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+    // WCONHIST re-specifies the VFP table
+    BOOST_CHECK( schedule[6].wellgroup_events().hasEvent("P1", ScheduleEvents::WELL_THP_UPDATE));
+}