Flow compositional by hnil · Pull Request #7049 · OPM/opm-simulators

hnil · 2026-05-13T12:24:49Z

This is work on making a compositional simulator more similar to flow.

The pullrequest also do:

added flow_comp variants + test aginst the flowexp_comp executable
it still remain some renaming to make things more consistent
renamed and refactored BlackoilModel.hpp to NonlinearSystem +++

since now the SimulatorFullyImplicitBlackoil + BlackoilModel.hpp is simulator an nonlinear system for more general systems.

GitPaean · 2026-05-15T12:15:39Z

jenkins build this please

Copilot

Pull request overview

This PR generalizes Flow’s fully implicit simulator path so compositional variants can share more of the standard Flow infrastructure, while renaming/refactoring the black-oil nonlinear model into a more generic nonlinear-system structure.

Changes:

Renames/refactors SimulatorFullyImplicitBlackoil/BlackoilModel concepts into generic SimulatorFullyImplicit and nonlinear-system classes.
Adds compositional Flow executable variants and comparison/regression test wiring.
Extends compositional output/well-model glue and parameter hiding behavior to fit the shared Flow driver.

Reviewed changes

Copilot reviewed 76 out of 76 changed files in this pull request and generated 8 comments.

Show a summary per file

File	Description
`CMakeLists.txt`	Adds compositional Flow/FlowExp executable test targets.
`CMakeLists_files.cmake`	Updates source/header registration for renamed and new simulator files.
`compareECLFiles.cmake`	Adds reference simulator arguments for comparison helpers.
`comparisonTests.cmake`	Adds compositional Flow vs FlowExp comparison tests.
`regressionTests.cmake`	Switches compositional regression to new Flow compositional variant with reference simulator.
`flow/flow_blackoil.cpp`	Updates simulator include.
`flow/flow_blackoil_legacyassembly.cpp`	Updates simulator include.
`flow/flow_blackoil_nohyst.cpp`	Updates simulator include.
`flow/flow_blackoil_temp.cpp`	Updates simulator include.
`flow/flow_biofilm.cpp`	Updates simulator include.
`flow/flow_brine.cpp`	Updates simulator include.
`flow/flow_brine_precsalt_vapwat.cpp`	Updates simulator include.
`flow/flow_brine_saltprecipitation.cpp`	Updates simulator include.
`flow/flow_energy.cpp`	Updates simulator include.
`flow/flow_extbo.cpp`	Updates simulator include.
`flow/flow_foam.cpp`	Updates simulator include.
`flow/flow_gasoil.cpp`	Updates simulator include.
`flow/flow_gasoil_energy.cpp`	Updates simulator include.
`flow/flow_gasoildiffuse.cpp`	Updates simulator include.
`flow/flow_gaswater.cpp`	Updates simulator include.
`flow/flow_gaswater_brine.cpp`	Updates simulator include.
`flow/flow_gaswater_dissolution.cpp`	Updates simulator include.
`flow/flow_gaswater_dissolution_diffuse.cpp`	Updates simulator include.
`flow/flow_gaswater_energy.cpp`	Updates simulator include.
`flow/flow_gaswater_saltprec_energy.cpp`	Updates simulator include.
`flow/flow_gaswater_saltprec_vapwat.cpp`	Updates simulator include.
`flow/flow_gaswater_solvent.cpp`	Updates simulator include.
`flow/flow_micp.cpp`	Updates simulator include.
`flow/flow_oilwater.cpp`	Updates simulator include.
`flow/flow_oilwater_brine.cpp`	Updates simulator include.
`flow/flow_oilwater_polymer.cpp`	Updates simulator include.
`flow/flow_oilwater_polymer_injectivity.cpp`	Updates simulator include.
`flow/flow_polymer.cpp`	Updates simulator include.
`flow/flow_solvent.cpp`	Updates simulator include.
`flow/flow_solvent_foam.cpp`	Updates simulator include.
`flowexperimental/comp/flow_comp.cpp`	Adds dynamic compositional Flow entry point.
`flowexperimental/comp/flow_comp.hpp`	Adds Flow compositional type tag/properties and Newton method.
`flowexperimental/comp/flow_comp2_2p.cpp`	Adds fixed 2-component two-phase Flow compositional executable.
`flowexperimental/comp/flow_comp3_2p.cpp`	Adds fixed 3-component two-phase Flow compositional executable.
`flowexperimental/comp/flowexp_comp2_2p_main.cpp`	Adds fixed FlowExp compositional main.
`flowexperimental/comp/flowexp_comp3_2p_main.cpp`	Adds fixed FlowExp compositional main.
`flowexperimental/comp/wells/CompWellModel.hpp`	Adds Flow-driver compatibility methods/state to compositional well model.
`flowexperimental/comp/wells/CompWellModel_impl.hpp`	Captures report-step well/group events.
`flowexperimental/comp/wells/CompWell_impl.hpp`	Adds well-control diagnostic logging.
`opm/models/utils/parametersystem.cpp`	Adds `HideIfRegistered_`.
`opm/models/utils/parametersystem.hpp`	Exposes `HideIfRegistered`.
`opm/simulators/flow/BlackoilModelNldd.hpp`	Updates model type references and convergence helper use.
`opm/simulators/flow/BlackoilModelParameters.hpp`	Updates comment terminology.
`opm/simulators/flow/BlackoilModelTPSA.hpp`	Updates inheritance to renamed nonlinear system.
`opm/simulators/flow/FlowGenericProblem.cpp`	Adds compositional fluid-system instantiations.
`opm/simulators/flow/FlowMain.hpp`	Switches FlowMain to generic fully implicit simulator.
`opm/simulators/flow/FlowProblemBlackoilProperties.hpp`	Updates black-oil nonlinear-system property.
`opm/simulators/flow/FlowProblemComp.hpp`	Adds report/final-output hooks needed by generic driver.
`opm/simulators/flow/FlowProblemCompProperties.hpp`	Wires compositional problem to new nonlinear system.
`opm/simulators/flow/FlowUtils.cpp`	Hides optional VTK/well parameters only if registered.
`opm/simulators/flow/NonlinearSystem.hpp`	Adds shared nonlinear-system base helpers.
`opm/simulators/flow/NonlinearSystemBlackOilReservoir.hpp`	Renames/refactors black-oil model class onto shared base.
`opm/simulators/flow/NonlinearSystemBlackOilReservoir_impl.hpp`	Moves shared nonlinear logic to base and updates renamed class implementation.
`opm/simulators/flow/NonlinearSystemCompositional.hpp`	Adds compositional nonlinear-system interface.
`opm/simulators/flow/NonlinearSystemCompositional_impl.hpp`	Adds compositional nonlinear-system implementation.
`opm/simulators/flow/OutputCompositionalModule.hpp`	Adds parameter registration and FIP/RESV log output hooks.
`opm/simulators/flow/SimulatorFullyImplicit.cpp`	Switches implementation include to generic simulator header.
`opm/simulators/flow/SimulatorFullyImplicit.hpp`	Adds generic fully implicit simulator header.
`opm/simulators/flow/SimulatorFullyImplicit_impl.hpp`	Adds generic fully implicit simulator implementation.
`opm/simulators/flow/SimulatorFullyImplicitBlackoil.hpp`	Renames class in legacy black-oil header.
`opm/simulators/flow/SimulatorFullyImplicitBlackoil_impl.hpp`	Renames implementation symbols in legacy black-oil impl header.
`opm/simulators/flow/rescoup/ReservoirCouplingMaster.cpp`	Updates renamed simulator reference in comment.
`opm/simulators/timestepping/AdaptiveTimeStepping.hpp`	Updates renamed simulator references in comments.
`opm/simulators/timestepping/AdaptiveTimeStepping_impl.hpp`	Updates renamed simulator references in comments.
`opm/simulators/timestepping/ConvergenceReport.hpp`	Updates renamed convergence comment reference.
`opm/simulators/utils/ComponentName.cpp`	Extends component naming to compositional fluid systems.
`opm/simulators/wells/rescoup/RescoupProxy.hpp`	Updates renamed owner comment.
`tests/rescoup/test_chopstep.cpp`	Updates nonlinear-system include.
`tests/run-comparison.sh`	Supports comparing two simulator executables/output directories.
`tests/run-regressionTest.sh`	Supports reference simulator directory override.
`tests/test_wellmodel.cpp`	Updates nonlinear-system include.

Comments suppressed due to low confidence (1)

flowexperimental/comp/wells/CompWellModel.hpp:137

This stub is now used by the generic adaptive time-stepping failure path, which asks the well model to shut failing wells before retrying a substep. Always returning false disables that recovery path for compositional wells, so well convergence failures that black-oil can recover from by shutting a well will instead keep chopping/failing.

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

hnil · 2026-06-03T11:04:31Z

+     const std::map<std::string, double>& wellOpenTimes() const { return well_open_times_; }
+     const std::map<std::string, double>& wellCloseTimes() const { return well_close_times_; }


For now this is not relevant I think.

Copilot

Pull request overview

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

+    status = other.status;
+    bhp = other.bhp;
+    surface_phase_rates = other.surface_phase_rates;
+    phase_fractions = other.phase_fractions;
+    reservoir_phase_rates = other.reservoir_phase_rates;
+    total_molar_fractions = other.total_molar_fractions;
+    phase_molar_fractions = other.phase_molar_fractions;
+    injection_cmode = other.injection_cmode;
+    production_cmode = other.production_cmode;


hnil · 2026-05-15T13:22:40Z

@copilot apply changes based on the comments in this thread

hnil · 2026-05-15T13:25:32Z

One could probably remove even more code. But some of the changes will will change reference. So better to uniform the code when fixes is applied to the main code i.e. blackoil.

Copilot

Pull request overview

Copilot reviewed 84 out of 84 changed files in this pull request and generated 7 comments.

+    status = other.status;
+    bhp = other.bhp;
+    surface_phase_rates = other.surface_phase_rates;
+    phase_fractions = other.phase_fractions;
+    reservoir_phase_rates = other.reservoir_phase_rates;
+    total_molar_fractions = other.total_molar_fractions;
+    phase_molar_fractions = other.phase_molar_fractions;
+    injection_cmode = other.injection_cmode;
+    production_cmode = other.production_cmode;


GitPaean · 2026-05-19T09:28:39Z

@hnil , I am looking into the PR now and it needs to be rebased.

GitPaean · 2026-05-20T13:21:18Z

jenkins build this failure_report please

GitPaean · 2026-05-20T14:36:43Z

jenkins build this failure_report please

hnil · 2026-05-21T07:00:24Z

Converted to draft. Need to be fixed after rebase and review comments.

GitPaean · 2026-05-21T14:10:13Z

yeah, the same compilation error showed up in my rebased PR from this PR when compiling the float version of the simulator.

GitPaean · 2026-05-21T21:44:34Z

jenkins build this opm-common=5178 please

hnil · 2026-05-26T12:19:37Z

Move this for review again. More tests on making flowexp and flow equal is in #7088 which is draft.

hnil · 2026-05-26T12:56:58Z

rebased and removed tests agains old solver (which had to fail)

bska · 2026-05-26T15:21:24Z

jenkins build this please

GitPaean · 2026-05-27T08:01:12Z

jenkins build this opm-common=5178 please

hnil · 2026-05-27T08:03:01Z

Comment: flow_comp flowexp_comp both fails bad with no input. This is a separate question and not related to this pullrequest.

hnil · 2026-05-27T08:04:35Z

Comment: It is no test here since it will fail with given reference and trying to get flow flowexp to run equal made to much changes se #7088

GitPaean · 2026-05-27T08:42:03Z

jenkins build this opm-common=5178 please

GitPaean · 2026-05-27T11:04:46Z

#7062 this version compiles on Jenkins, but there are three regression failures. Will have a look later today or tomorrow.

https://ci.opm-project.org/job/opm-simulators-PR-builder/9992/

-- added flow_comp variants

-- compilation of flow_comp -- removed test

hnil requested review from GitPaean and atgeirr May 13, 2026 12:25

hnil marked this pull request as draft May 13, 2026 12:25

hnil added the manual:irrelevant This PR is a minor fix and should not appear in the manual label May 13, 2026

hnil force-pushed the genneral_flow_comp branch from c856087 to bd365b1 Compare May 15, 2026 07:38

GitPaean requested a review from Copilot May 15, 2026 12:15

Copilot started reviewing on behalf of GitPaean May 15, 2026 12:16 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

hnil force-pushed the genneral_flow_comp branch from bd365b1 to ac8aab5 Compare May 15, 2026 12:33

GitPaean requested a review from Copilot May 15, 2026 12:54

Copilot started reviewing on behalf of GitPaean May 15, 2026 12:54 View session

Copilot AI reviewed May 15, 2026

View reviewed changes

hnil requested a review from Copilot May 15, 2026 13:22

Copilot started reviewing on behalf of hnil May 15, 2026 13:22 View session

hnil marked this pull request as ready for review May 15, 2026 13:24

Copilot AI reviewed May 15, 2026

View reviewed changes

GitPaean mentioned this pull request May 19, 2026

[testing] Hnil genneral flow comp #7062

Draft

hnil force-pushed the genneral_flow_comp branch from ac8aab5 to 4d353ed Compare May 20, 2026 12:32

hnil marked this pull request as draft May 21, 2026 06:59

GitPaean mentioned this pull request May 21, 2026

converting std::vector<double> to std::vector<float> for BIC coefficients in GenericOilGasWaterFluidSystem OPM/opm-common#5178

Merged

hnil force-pushed the genneral_flow_comp branch from 4d353ed to 1c0aa22 Compare May 26, 2026 12:17

hnil marked this pull request as ready for review May 26, 2026 12:19

hnil force-pushed the genneral_flow_comp branch from 1c0aa22 to 5f623ca Compare May 26, 2026 12:55

hnil added 4 commits June 3, 2026 13:00

-- renamed and refactored BlackoilModel.hpp to NonlinearSystem +++

266e7bf

-- added flow_comp variants

added need GPL tings + a missing header

2dfe30e

-- removed extra debug output (changed tag)

327eba2

-- compilation of flow_comp -- removed test

fixed rebase

7f9478d

hnil force-pushed the genneral_flow_comp branch from 33d072e to 7f9478d Compare June 3, 2026 11:22

hnil requested review from totto82 and removed request for atgeirr June 3, 2026 12:05

		const std::map<std::string, double>& wellOpenTimes() const { return well_open_times_; }
		const std::map<std::string, double>& wellCloseTimes() const { return well_close_times_; }

Conversation

hnil commented May 13, 2026 • edited by bska Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

GitPaean commented May 15, 2026

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!

hnil Jun 3, 2026

Choose a reason for hiding this comment

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!

Uh oh!

Uh oh!

Uh oh!

hnil commented May 15, 2026

Uh oh!

hnil commented May 15, 2026 • edited 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

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

GitPaean commented May 19, 2026

Uh oh!

GitPaean commented May 20, 2026

Uh oh!

GitPaean commented May 20, 2026

Uh oh!

hnil commented May 21, 2026

Uh oh!

GitPaean commented May 21, 2026

Uh oh!

GitPaean commented May 21, 2026

Uh oh!

hnil commented May 26, 2026 • edited by bska Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hnil commented May 26, 2026

Uh oh!

bska commented May 26, 2026

Uh oh!

GitPaean commented May 27, 2026

Uh oh!

hnil commented May 27, 2026

Uh oh!

hnil commented May 27, 2026

Uh oh!

GitPaean commented May 27, 2026

Uh oh!

GitPaean commented May 27, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

hnil commented May 13, 2026 •

edited by bska

Loading

hnil commented May 15, 2026 •

edited

Loading

hnil commented May 26, 2026 •

edited by bska

Loading