Fix bugs in well_state *RateSI() unit conversion by eivindjahren · Pull Request #1212 · equinor/resdata

eivindjahren · 2026-06-26T07:23:11Z

The rates would be off due to a macro expansion bug. Also, in ebd5ddd, the unit_system is now initialized in RSTHead, so prior to that commit, SI units were always equal to the raw units.

Resolves #1213

berland · 2026-06-26T08:43:43Z

+LAB_UNITS = 3
+
+# Unit conversion constants
+INCH = 0.0254


For readability, append # meters

berland · 2026-06-26T08:43:56Z

+LITER = 0.001
+MILLI_LITER = LITER * 0.001
+GAS_FIELD = (FEET**3) * 1_000_000
+HOUR = 3600


append # seconds

berland · 2026-06-26T08:44:26Z

+FEET = 12 * INCH
+GALLON = 231 * INCH**3
+BARREL = GALLON * 42
+LITER = 0.001


Append # m^3

berland · 2026-06-26T09:32:53Z

+BARREL = GALLON * 42
+LITER = 0.001
+MILLI_LITER = LITER * 0.001
+GAS_FIELD = (FEET**3) * 1_000_000


Suggest to rename this variable to MMCF

berland · 2026-06-26T12:29:50Z

-    # The reservoir volume rate is unit-independent and equals its SI value.
+
+    # The reservoir volume rate is implemented as being unit-independent,
+    # I have not confirmed that this is correct


this is understood now?

berland · 2026-06-26T13:02:26Z

 #ifdef __cplusplus
 }
+
+inline double liquid_conversion_rate(ert_rd_unit_enum unit_system) {


rename to liquid_conversion_factor?

berland · 2026-06-26T13:02:47Z

+    double conversion_factor = 1;
+
+    if (unit_system == RD_METRIC_UNITS)
+        conversion_factor = 1.0 / RD_UNITS_TIME_DAY;


(I guess you could return directly in each if-statement)

berland · 2026-06-26T13:02:57Z

+    return conversion_factor;
+}
+
+inline double gas_conversion_rate(ert_rd_unit_enum unit_system) {


rate -> factor

berland

merge at will (friday-deployday!)

Copilot

Pull request overview

This PR corrects SI unit conversion for well and connection rate accessors (*RateSI()) by fixing conversion-factor handling (including a macro expansion precedence issue) and by ensuring the declared restart-file unit system is used when computing SI rates. It also replaces an Equinor-data-based test with self-contained restart-file writer tests to validate rate conversions across unit systems.

Changes:

Fix SI conversions for well-state and well-connection rates (including reservoir volume rates) based on the restart file’s unit system.
Add unit-system-aware restart writer utilities/tests (XWEL + XCON) to validate SI scaling for METRIC/FIELD/LAB.
Refactor/centralize C++ conversion factors and correct XWEL index constants used for oil/water/gas rates.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
tests/well_tests/test_rd_well3.py	Removes legacy Equinor dataset-based rate assertions.
tests/test_well.py	Adds unit-system-aware restart writing (INTEHEAD unit system + XCON) and new parametrized SI conversion tests.
python/resdata/well/well_state.py	Documents raw-vs-SI semantics for rate getters.
lib/resdata/well_state.cpp	Uses shared conversion helpers for SI rates and applies conversion to `volume_rate_si`; fixes XWEL oil index usage via constant update.
lib/resdata/well_conn.cpp	Stores unit system on connections and applies SI conversions to connection rates.
lib/resdata/tests/well_segment_conn.cpp	Updates test allocations to pass unit system.
lib/resdata/tests/well_conn.cpp	Updates test allocations to pass unit system.
lib/include/resdata/well/well_const.hpp	Corrects `XWEL_RES_ORAT_ITEM` index.
lib/include/resdata/well/well_conn.hpp	Extends allocation API to accept `unit_system`.
lib/include/resdata/rd_units.hpp	Fixes macro precedence with parentheses and adds shared conversion-factor helpers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

There were a number of bugs with the *RateSI() function 1. The conversion rates would be off due to a macro expansion bug. 2 in ebd5ddd, the unit_system is now initialized in RSTHead, so prior to that commit, SI units were always equal to the raw units. 3) by outputting the WVPR with OPM flow, which should correspond to volumeRate, we have confirmed that volumeRate should have the same conversion factor as oil. Before the conversion rate was always 1.0. 4) by looking at a well with one connection we got values in XCON that matched XWEL with OPM flow. Which confirms that these values have the same units and the corresponding conversion should be done for rateSI() in WellConnection. Before the raw value was used.

eivindjahren force-pushed the fix_si_units_test branch 2 times, most recently from af6352b to 7bcccc8 Compare June 26, 2026 07:26

eivindjahren self-assigned this Jun 26, 2026

eivindjahren added this to SCOUT Jun 26, 2026

eivindjahren moved this to Fast Track in SCOUT Jun 26, 2026

berland reviewed Jun 26, 2026

View reviewed changes

eivindjahren force-pushed the fix_si_units_test branch from 7bcccc8 to cabdbfe Compare June 26, 2026 10:39

berland reviewed Jun 26, 2026

View reviewed changes

eivindjahren force-pushed the fix_si_units_test branch from cabdbfe to a5c1fb7 Compare June 26, 2026 12:55

eivindjahren changed the title ~~Fix a bug in well_state *RateSI() unit conversion~~ Fix bugs in well_state *RateSI() unit conversion Jun 26, 2026

eivindjahren force-pushed the fix_si_units_test branch from a5c1fb7 to b1f6d51 Compare June 26, 2026 12:57

berland reviewed Jun 26, 2026

View reviewed changes

berland approved these changes Jun 26, 2026

View reviewed changes

github-project-automation Bot moved this from Fast Track to Reviewed in SCOUT Jun 26, 2026

eivindjahren force-pushed the fix_si_units_test branch from b1f6d51 to 2884d99 Compare June 26, 2026 14:02

eivindjahren requested a review from Copilot June 26, 2026 14:03

Copilot started reviewing on behalf of eivindjahren June 26, 2026 14:03 View session

Copilot AI reviewed Jun 26, 2026

View reviewed changes

Comment thread lib/resdata/well_conn.cpp

Comment thread lib/resdata/well_conn.cpp

Comment thread lib/include/resdata/rd_units.hpp

Comment thread lib/include/resdata/well/well_conn.hpp

eivindjahren force-pushed the fix_si_units_test branch from 2884d99 to 177fbe6 Compare June 26, 2026 14:07

eivindjahren merged commit ebfff13 into main Jun 26, 2026
12 checks passed

eivindjahren deleted the fix_si_units_test branch June 26, 2026 15:39

github-project-automation Bot moved this from Reviewed to Done in SCOUT Jun 26, 2026

Uh oh!

Conversation

eivindjahren commented Jun 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

berland left a comment

Choose a reason for hiding this comment

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!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

eivindjahren commented Jun 26, 2026 •

edited

Loading