parsing for the keyword WELDRAW by GitPaean · Pull Request #5305 · OPM/opm-common

GitPaean · 2026-08-21T10:34:00Z

Adds the WELDRAW keyword, which sets a maximum allowable drawdown for production wells.

WELDRAW
  'PROD1' 50.0 2* AVG /
/

The record is parsed into a WELDRAW object on the Well: the maximum drawdown (a UDA), the target phase of item 3, and the mode of item 5. A defaulted target phase resolves to the well's preferred phase.

A well held back by its drawdown limit reports control mode 12 in WMCTL. The limit is stored in item 34 of SWEL and restored when a well is built from a restart file, so a restarted run applies the same limit as an uninterrupted one; the target phase is not stored and is resolved from the preferred phase.

The conversion of the limit into a rate is in OPM/opm-simulators#7346.
Test cases in OPM/opm-tests#1571.

Copilot

Pull request overview

Adds schedule parsing and state support for WELDRAW limits, including serialization and control-mode reporting.

Changes:

Introduces WELDRAW parsing, storage, UDA evaluation, and well integration.
Reports drawdown-limited producers through WMCTL.
Adds serialization and schedule parsing coverage plus restart warnings.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
`CMakeLists_files.cmake`	Registers WELDRAW sources and headers.
`opm/input/eclipse/Schedule/ScheduleDeck.cpp`	Warns when restart processing skips WELDRAW.
`opm/input/eclipse/Schedule/Well/WELDRAW.cpp`	Implements WELDRAW parsing and evaluation.
`opm/input/eclipse/Schedule/Well/WELDRAW.hpp`	Defines the WELDRAW state API.
`opm/input/eclipse/Schedule/Well/Well.cpp`	Stores and exposes WELDRAW state.
`opm/input/eclipse/Schedule/Well/Well.hpp`	Declares WELDRAW integration.
`opm/input/eclipse/Schedule/Well/WellPropertiesKeywordHandlers.cpp`	Handles WELDRAW schedule records.
`opm/output/data/Wells.hpp`	Adds dynamic drawdown-control status.
`opm/output/eclipse/Summary.cpp`	Reports drawdown as the active control mode.
`opm/output/eclipse/VectorItems/well.hpp`	Defines the drawdown control code.
`tests/parser/ScheduleSerializeTest.cpp`	Enables WELDRAW schedule serialization coverage.
`tests/parser/ScheduleTests.cpp`	Tests parsed WELDRAW properties.
`tests/test_Serialization.cpp`	Adds WELDRAW serialization coverage.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Copilot

Pull request overview

Copilot reviewed 16 out of 16 changed files in this pull request and generated no new comments.

Suppressed comments (1)

opm/input/eclipse/Schedule/eval_uda.cpp:71

If the UDQ is absent, output_value remains the undefined sentinel and is then pressure-converted. In non-SI unit systems this changes the sentinel, so callers can no longer recognize it with SummaryState::is_undefined_value(). Return udq_default directly when neither lookup succeeds, and convert only resolved UDQ values.

    return value.get_dim().convertRawToSi(output_value);

GitPaean · 2026-08-21T11:02:18Z

jenkins build this please

GitPaean · 2026-08-21T15:52:21Z

jenkins build this opm-simulators=7346 please

GitPaean · 2026-08-22T11:16:35Z

jenkins build this opm-simulators=7346 please

bska · 2026-08-22T20:27:33Z

jenkins build this opm-simulators=7346 please

GitPaean · 2026-08-24T12:38:42Z

jenkins build this opm-simulators=7346 failure_report please

GitPaean · 2026-08-24T14:09:59Z

jenkins build this opm-simulators=7346 failure_report please

GitPaean · 2026-08-24T19:10:28Z

I am marking this PR and also the downstream OPM/opm-simulators#7346 as ready for review to invite reviewers.

akva2

Only some nitpickery found, plus confusing around missing cc.

GitPaean · 2026-08-25T08:11:47Z

making this to be draft to amend the PR for agreed behavoir when the default item 2 is used. We should not support it.

GitPaean · 2026-08-25T08:57:56Z

the WELDRAW regression cases will not run before OPM/opm-tests#1573 getting merged.

GitPaean · 2026-08-25T09:49:23Z

As the expected the regression tests with the WELDRAW keywords emits the following error message,

https://ci.opm-project.org/job/opm-common-PR-builder/10203/

Error: Problem with keyword WELDRAW
In /build/deps/opm-tests/weldraw/WELDRAW-01.DATA line 441
Item 2 of WELDRAW is defaulted for D-1H.  The item has no default and the maximum allowable drawdown must be given explicitly.

Error: Unrecoverable errors while loading input:
Problem with keyword WELDRAW
In /build/deps/opm-tests/weldraw/WELDRAW-01.DATA line 441
Item 2 of WELDRAW is defaulted for D-1H.  The item has no default and the maximum allowable drawdown must be given explicitly.
Failed to create valid EclipseState object.
Problem with keyword WELDRAW
In /build/deps/opm-tests/weldraw/WELDRAW-01.DATA line 441
Item 2 of WELDRAW is defaulted for D-1H.  The item has no default and the maximum allowable drawdown must be given explicitly.
CUDA ERROR (code = 34, CUDA driver is a stub library) at /tmp/opm/hypre/src/utilities/general.c:330

GitPaean · 2026-08-25T12:28:47Z

jenkins build this opm-simulators=7346 failure_report please

bska · 2026-08-25T16:26:13Z

jenkins build this failure_report please

GitPaean · 2026-08-25T17:01:17Z

To make the PR build standalone needs to add WELDRAW.hpp to Well.hpp. It is needed in the serializer() in FlowGenericVanguard.cpp.

GitPaean · 2026-08-25T18:07:45Z

To make the PR build standalone needs to add WELDRAW.hpp to Well.hpp. It is needed in the serializer() in FlowGenericVanguard.cpp.

But it will break the forward declaration pattern in the file. Please let me know if it is wanted.

bska

I finally looked at the details here and I think it's fine for the most part. I do have a couple of reservations that should be addressed in some way before we merge this.

As for

To make the PR build standalone needs to add WELDRAW.hpp to Well.hpp. It is needed in the serializer() in FlowGenericVanguard.cpp.

Right. In the past we've "just" added the requisite headers, e.g., WDFAC.hpp, to FlowGenericVanguard.cpp and ParallelSerialization.cpp. I think I'd prefer that we continue to do that. I haven't looked at the details of the downstream changes yet. Maybe that's exactly what it does.

bska

Thanks a lot for the updates. This is getting close to ready as far as I can tell. The only remaining issue is the first-time construction of WELDRAW within a Well object created from WELSPECS or similar, i.e., not from a restart file.

bska · 2026-08-26T15:39:43Z

There should probably be an explicit WELDRAW::WELDRAW(const Dimension&) constructor too which properly constructs the UDAValue data member. That way, the normal Well constructor can use its UnitSystem argument to properly define the WELDRAW dimension from the start. The current initialisation in terms of the default constructor will not have appropriate unit conversion support configured from the start.

The constructor used at simulation restart is fine.

GitPaean · 2026-08-26T22:12:24Z

jenkins build this opm-simulators=7346 failure_report please

Store the per-well maximum drawdown (value, target phase, AVG/MAX mode) on the Well object. A defaulted phase resolves from the preferred phase. The mode and use-in-potentials properties are retained for input round tripping even though OPM Flow rejects their non-default values at deck load.

A producer held back by its maximum allowable drawdown is under drawdown control, which is control mode 12, and not under the rate control which carries the converted limit. Add that mode to the well control mode values and a flag on the dynamic control record for the simulator to raise, and report it from WMCTL.

eval_well_uda() raises a symbolic value to at least the epsilon limit before converting it, because a zero rate target means no limit and a negative one is meaningless. Neither applies to the maximum allowable drawdown, which is a pressure, and where a non-positive value is how the caller is told that no limit applies. Evaluated through eval_well_uda(), a UDQ drawdown limit of zero became 1e-20 Pascal instead and all but shut the well. Add an evaluation which keeps the value as it is and use it for WELDRAW. Also make the CurrentControl serialization test object a producer, so that the round trip of the drawdown limited flag is covered rather than skipped by the injector branch of the comparison, and check the reported control mode of a drawdown limited well in the summary tests.

A restarted run discards the SCHEDULE keywords preceding the restart date and builds its wells from the restart file, so a WELDRAW limit set before that date was lost and the well produced at a higher rate than in an uninterrupted run until the next WELDRAW keyword. Write the maximum allowable drawdown to item 34 of SWEL and restore it when a well is built from the restart file. Zero records that no limit applies, which is also how a limit removed by defaulting item 2 is stored. The target phase is not part of the restart file and is resolved from the well's preferred phase, as a defaulted item 3 is, so a phase given explicitly is not recovered.

Item 2 has no default, so a record which leaves it out has no maximum allowable drawdown to apply. Reject it rather than guessing at what was meant.

GitPaean · 2026-08-26T22:48:30Z

jenkins build this opm-simulators=7346 failure_report please

bska

Thanks a lot for the updates. This looks good to me now. I'll review the downstream companion PR before deciding how to proceed.

bska · 2026-08-27T07:28:36Z

I'll review the downstream companion PR before deciding how to proceed.

The downstream looks good so I'll create reference solutions for the new regression test cases and then I'll merge this and its companion PR.

bska · 2026-08-27T07:28:51Z

jenkins build this opm-simulators=7346 update_data please

bska · 2026-08-27T07:41:27Z

jenkins build this opm-simulators=7346 opm-tests=1577 please

PR OPM/opm-simulators#7346 Reason: PR OPM/opm-common#5305 PR OPM/opm-simulators#7346 opm-common = d673cf5d0a5f7cee3008860ebcd1f929503ef3c9 opm-grid = 0f95d633d61058184576a2d795cd76482ef96daa opm-simulators = 8a20b18fa72b9198220b3027e5059d84c094d55f ### Changed Tests ### * weldraw_02_gas * weldraw_01 * weldraw_01_msw

…simulators_7346 Automatic Reference Data Update for PR OPM/opm-common#5305

bska · 2026-08-27T08:59:10Z

Reference solutions for the new regression test cases have been installed on the CI system. I'll merge this and its downstream companion PR into the master branch.

GitPaean · 2026-08-27T11:04:01Z

Some comments for the manual. @gdfldm

WELDRAW is now supported in Flow. The behaviour, item by item:

Item 2 (maximum drawdown) has no default and must be given explicitly.
A record that leaves it defaulted is rejected with an error pointing at
the offending record. A non-positive value means no limit, so the limit
can be removed by giving a negative value. The item accepts a UDA (restarting
not supported yet).
Item 3 (target phase) accepts LIQ or GAS. When defaulted it is taken
from the well's preferred phase in WELSPECS: GAS for a gas well, LIQ
otherwise.
Item 4 (use in well potentials) must be NO, which is the default. YES is
not supported and will be rejected at load.
Item 5 (grid blocks) must be AVG, which is the default. MAX is not supported
and will be rejected at load.

The limit is converted at each time step into a maximum production rate
for the target phase. A well held on its drawdown limit reports WMCTL =
12. The limit is preserved across a restart.

GitPaean added the manual:new-feature This is a new feature and should be described in the manual label Aug 21, 2026

GitPaean requested a balanced review from Copilot August 21, 2026 10:34

Copilot started reviewing on behalf of GitPaean August 21, 2026 10:34 View session

Copilot AI reviewed Aug 21, 2026

View reviewed changes

Comment thread opm/input/eclipse/Schedule/Well/WELDRAW.cpp Outdated

Comment thread opm/output/data/Wells.hpp Outdated

Comment thread opm/output/eclipse/Summary.cpp

GitPaean requested a balanced review from Copilot August 21, 2026 10:53

Copilot started reviewing on behalf of GitPaean August 21, 2026 10:53 View session

Copilot AI reviewed Aug 21, 2026

View reviewed changes

GitPaean mentioned this pull request Aug 21, 2026

supporting the WELDRAW keyword from the simulator side. OPM/opm-simulators#7346

Merged

GitPaean force-pushed the add-weldraw branch from be4524d to 6457454 Compare August 24, 2026 09:49

GitPaean force-pushed the add-weldraw branch from 7b7dbc9 to 6f8789b Compare August 24, 2026 13:50

GitPaean mentioned this pull request Aug 24, 2026

specifying explicitly the item 2 of WELDRAW, we do not allow default item 2 in WELDRAW OPM/opm-tests#1573

Merged

GitPaean marked this pull request as ready for review August 24, 2026 19:10

GitPaean requested review from akva2 and bska August 24, 2026 19:11

GitPaean force-pushed the add-weldraw branch from 287a7bc to bfbf056 Compare August 25, 2026 07:25

akva2 approved these changes Aug 25, 2026

View reviewed changes

Comment thread opm/input/eclipse/Schedule/Well/WELDRAW.cpp Outdated

Comment thread opm/input/eclipse/Schedule/Well/WELDRAW.hpp Outdated

Comment thread opm/input/eclipse/Schedule/eval_uda.cpp Outdated

Comment thread opm/input/eclipse/Schedule/Well/WELDRAW.hpp

GitPaean force-pushed the add-weldraw branch from bfbf056 to 0a25bc3 Compare August 25, 2026 07:46

GitPaean marked this pull request as draft August 25, 2026 08:11

akva2 reviewed Aug 25, 2026

View reviewed changes

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

GitPaean force-pushed the add-weldraw branch 2 times, most recently from b8c48a1 to 81beb6d Compare August 25, 2026 08:50

GitPaean force-pushed the add-weldraw branch from 81beb6d to 2f264bd Compare August 25, 2026 10:21

bska reviewed Aug 26, 2026

View reviewed changes

Comment thread opm/io/eclipse/rst/well.cpp Outdated

Comment thread opm/input/eclipse/Schedule/Well/WELDRAW.hpp Outdated

GitPaean force-pushed the add-weldraw branch 2 times, most recently from 3ea2e29 to 3f0fa8b Compare August 26, 2026 13:26

bska reviewed Aug 26, 2026

View reviewed changes

GitPaean force-pushed the add-weldraw branch from 3f0fa8b to 82cf0ad Compare August 26, 2026 16:17

GitPaean added 5 commits August 27, 2026 00:21

Reject a defaulted item 2 of WELDRAW

9868c60

Item 2 has no default, so a record which leaves it out has no maximum allowable drawdown to apply. Reject it rather than guessing at what was meant.

GitPaean force-pushed the add-weldraw branch from 82cf0ad to 9868c60 Compare August 26, 2026 22:32

bska approved these changes Aug 27, 2026

View reviewed changes

jenkins4opm mentioned this pull request Aug 27, 2026

Automatic Reference Data Update for PR https://github.com/OPM/opm-common/pull/5305 OPM/opm-tests#1577

Merged

bska added a commit to OPM/opm-tests that referenced this pull request Aug 27, 2026

Merge pull request #1577 from jenkins4opm/update_opm-common_5305_opm-…

4457ba4

…simulators_7346 Automatic Reference Data Update for PR OPM/opm-common#5305

bska merged commit 14f7a78 into OPM:master Aug 27, 2026
2 checks passed

GitPaean deleted the add-weldraw branch August 27, 2026 09:05

Conversation

GitPaean commented Aug 21, 2026 • edited by bska Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

GitPaean commented Aug 21, 2026

Uh oh!

GitPaean commented Aug 21, 2026

Uh oh!

GitPaean commented Aug 22, 2026

Uh oh!

bska commented Aug 22, 2026

Uh oh!

GitPaean commented Aug 24, 2026

Uh oh!

GitPaean commented Aug 24, 2026

Uh oh!

GitPaean commented Aug 24, 2026

Uh oh!

akva2 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GitPaean commented Aug 25, 2026

Uh oh!

Uh oh!

GitPaean commented Aug 25, 2026

Uh oh!

GitPaean commented Aug 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GitPaean commented Aug 25, 2026

Uh oh!

bska commented Aug 25, 2026

Uh oh!

GitPaean commented Aug 25, 2026

Uh oh!

GitPaean commented Aug 25, 2026

Uh oh!

bska left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

bska left a comment

Choose a reason for hiding this comment

Uh oh!

bska Aug 26, 2026

Choose a reason for hiding this comment

Uh oh!

GitPaean commented Aug 26, 2026

Uh oh!

GitPaean commented Aug 26, 2026

Uh oh!

bska left a comment

Choose a reason for hiding this comment

Uh oh!

bska commented Aug 27, 2026

Uh oh!

bska commented Aug 27, 2026

Uh oh!

bska commented Aug 27, 2026

Uh oh!

bska commented Aug 27, 2026

Uh oh!

Uh oh!

GitPaean commented Aug 21, 2026 •

edited by bska

Loading

GitPaean commented Aug 25, 2026 •

edited

Loading