feat: feature/byer3/well constraints by tjb-ltk · Pull Request #3862 · GEOS-DEV/GEOS

tjb-ltk · 2025-10-13T18:52:48Z

feat: Formalize definition of well constraints to

allow more than 2 constraints per well
minimize restrictions on rate type
allow production/injection constraints for one well (future capability)
improve code for constraint processing in general and also needed for well estimator
current implementation requires schema changes, script provided scripts/convert_well_schema.py

ToDo

add validation based on current implementation rules
add control switch logging
organized constraint hpp and cpp so all methods are in similar order
submit new input files

Subsequent PR's based on this PR

New constraint activation/test models (Liquid, needs phase name validation, single phase mass rate, ...)
change balance equation scaling, should be current rate?, not constraint rate, this will change results but will clean up residual check code
well estimator
well head pressure constraint

…broken

…aint class hierachy , 3) Remove all old constraint handling methods/variables, 4) it compiles ...

…lephase still needs testing

…t compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml

… to fixed and inputFiles regenerated

…d convert compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml" This reverts commit fa61ab1.

MelReyCG · 2025-12-16T13:32:29Z

@tjb-ltk Is it ready for review?

…dual check to include all wells (bug)

codecov · 2026-02-09T17:34:10Z

Codecov Report

❌ Patch coverage is 51.38889% with 560 lines in your changes missing coverage. Please review.
✅ Project coverage is 58.64%. Comparing base (2acb3ef) to head (aec6453).
⚠️ Report is 9 commits behind head on develop.

Files with missing lines	Patch %	Lines
...physicsSolvers/fluidFlow/wells/SinglePhaseWell.cpp	52.40%	168 Missing ⚠️
...s/CompositionalMultiphaseWellConstraintKernels.hpp	18.71%	152 Missing ⚠️
...wells/kernels/SinglePhaseWellConstraintKernels.hpp	0.00%	45 Missing ⚠️
...ts/physicsSolvers/fluidFlow/wells/WellControls.cpp	69.15%	33 Missing ⚠️
...lls/kernels/CompositionalMultiphaseWellKernels.cpp	48.93%	24 Missing ⚠️
...lvers/fluidFlow/wells/WellLiquidRateConstraint.cpp	0.00%	21 Missing ⚠️
...Solvers/fluidFlow/wells/WellMassRateConstraint.cpp	0.00%	18 Missing ⚠️
...nels/ThermalCompositionalMultiphaseWellKernels.hpp	5.55%	17 Missing ⚠️
...lls/kernels/CompositionalMultiphaseWellKernels.hpp	0.00%	16 Missing ⚠️
...icsSolvers/fluidFlow/wells/WellConstraintsBase.cpp	63.33%	11 Missing ⚠️
... and 16 more

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3862      +/-   ##
===========================================
- Coverage    58.87%   58.64%   -0.23%     
===========================================
  Files         1353     1371      +18     
  Lines       112953   113762     +809     
===========================================
+ Hits         66504    66719     +215     
- Misses       46449    47043     +594

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dkachuma · 2026-02-05T15:35:47Z

inputFiles/compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml

+
+    <CompositionalTwoPhaseFluidPhillipsBrine
+      name="FLUID"
+      phaseNames="{ oil, gas }"


Suggested change

phaseNames="{ oil, gas }"

phaseNames="{ water, gas }"

Unrelated to this PR but this was the intent for these cases.

dkachuma · 2026-02-05T15:36:48Z

inputFiles/compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml

+        enableCrossflow="0"
+        logLevel="0"
+        control="totalVolRate">
+        <InjectionPhaseVolumeRateConstraint


I'm confused here. I expected the actual rate constraint i.e. a value. What's the use of a constraint with no value?

The control specification here is to identify which constraint should the simulator start with first. This is for backwards compatibility and a useful option, 1) when the user knows for example that the well is far from being in decline and says I know this well can produce at a fixed rate, or just option to try if the well is having problems with initial guess.

dkachuma · 2026-02-05T17:10:16Z

...s/compositionalMultiphaseWell/benchmarks/Class09Pb3/class09_pb3_drainageOnly_direct_base.xml

      fieldName="globalCompFraction"
      component="1"
      scale="0.999999"/>
-    <!-- SPHINX_BC_END -->


Make sure this is not used in the doc build.

not sure what you mean .. not something the PR introduced

dkachuma · 2026-02-05T17:19:18Z

src/coreComponents/physicsSolvers/fluidFlow/wells/WellConstraintsBase.hpp

+    static constexpr char const * constraintScheduleTableNameString() { return "constraintScheduleTableName"; }
+
+    /// String key for the well constraint value
+    static constexpr char const * constraintValueString() { return "constraintValue"; }


Suggested change

static constexpr char const * constraintValueString() { return "constraintValue"; }

static constexpr char const * constraintValueString() { return "value"; }

Just value?

dkachuma · 2026-02-05T17:23:17Z

src/coreComponents/physicsSolvers/fluidFlow/wells/WellConstraintsBase.cpp

+    setRTTypeName( rtTypes::CustomTypes::groupNameRef ).
+    setInputFlag( InputFlags::OPTIONAL ).
+    setDescription( "Name of the well constraint schedule table when the constraint value  is a time dependent function. \n" );
+


No wrapper for m_constraintValue?

dkachuma · 2026-02-05T17:31:13Z

src/coreComponents/physicsSolvers/fluidFlow/wells/WellBHPConstraints.hpp

+ * @class BHPConstraint
+ * @brief This class describes a minimum pressure constraint used to control a injection well.
+ */
+class BHPConstraint : public WellConstraintBase


Suggested change

class BHPConstraint : public WellConstraintBase

enum class BHPType : integer

{

MINIMUM,

MAXIMUM

};

template <BHPType TYPE>

class BHPConstraint : public WellConstraintBase;

{

};

using MinimumBHPConstraint = BHPConstraint<MINIMUM>;

using MaximumBHPConstraint = BHPConstraint<MAXIMUM>;

Instead of duplicating 2 types that are almost the same.

good point... will change

dkachuma · 2026-02-09T22:33:13Z

...coreComponents/physicsSolvers/fluidFlow/wells/kernels/CompositionalMultiphaseWellKernels.hpp

          if( m_currentControl == WellControls::Control::MASSRATE )
          {
-            normalizer = m_dt * LvArray::math::abs( m_targetMassRate/  m_totalDens_n[iwelem][0] );
+            normalizer = m_dt * LvArray::math::abs( m_constraintValue/  m_totalDens_n[iwelem][0] );


I've encountered some divide by zero cases here. We need some protection.

the constraint value is fixed in well manager branch that superceeds this pr

dkachuma · 2026-02-09T22:42:31Z

src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp

+
+  WellControls const & wellControls = getWellControls( subRegion );
+
+  if( wellControls.isWellOpen( ) )


I had this on a separate PR.

dkachuma

@tjb-ltk Can you please comment on the empty constraint.

tjb-ltk added 10 commits September 29, 2025 16:50

1) new constraint schema, 2) resturcture well jac assem loops

f9db9fd

fix merge errors

a9cd276

fix integrate errors

c59b1a6

rel mode fix

48aabd4

1) remove old code, 2) test different constraint org, 3) singlephase …

a85ee1d

…broken

1) SinglePhaseWell adopts new constraint convention, 2) Change constr…

8366922

…aint class hierachy , 3) Remove all old constraint handling methods/variables, 4) it compiles ...

fix constraint sign and normalizers

4f49bf1

1) compositional_multiphase_wells_1d.xml matches geos branch, 2) sing…

2e82b49

…lephase still needs testing

compressible_single_phase_wells_1d.xml matches geos branch

6281018

improve naming conventions for well constriant files and classes

205889f

tjb-ltk requested review from CusiniM, OmarDuran, castelletto1, dkachuma, herve-gross, jhuang2601, paveltomin, rasimHZ and rrsettgast as code owners October 13, 2025 18:52

tjb-ltk self-assigned this Oct 13, 2025

tjb-ltk marked this pull request as draft October 13, 2025 18:53

fix reference to 'internal' is ambiguous error

b6ae5ef

herve-gross approved these changes Oct 14, 2025

View reviewed changes

tjb-ltk and others added 6 commits October 14, 2025 06:47

1) well constraint schema script, 2) converted xmls, 3) Failed conver…

fa61ab1

…t compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml

schema

292c90f

1)fixes for catalogue registration, 2) xml convert script still needs…

d4eb504

… to fixed and inputFiles regenerated

fix liq rate schema

bd3d0cf

Revert "1) well constraint schema script, 2) converted xmls, 3) Faile…

723c2bc

…d convert compositionalMultiphaseFlow/soreideWhitson/1D_100cells/1D_benchmark.xml" This reverts commit fa61ab1.

xml with new constraint schema, try 2

e39ccf1

tjb-ltk added the ci: run integrated tests Allows to run the integrated tests in GEOS CI label Oct 24, 2025

tjb-ltk added 9 commits November 5, 2025 09:24

see if this helps the problematic clang build

dff8951

disable clang

b1eb90c

fix schema input, zero out constraint qtys if well shut, fix error msh

ea002fc

remove unused schema

0aeb071

Merge branch 'develop' into feature/byer3/well_constraints

e056fec

merge fixes

f9f7f32

mods to match old constraint behavior, almost

4917a5d

convert constraint schema

8fd0b6b

Merge branch 'develop' into feature/byer3/well_constraints

72e5ec2

tjb-ltk added 4 commits December 17, 2025 08:46

use sep props in constraint calc, fixes integrated test

a7e0a80

make 1) rate initialization consistent with develop and 2) force resi…

f03a9cf

…dual check to include all wells (bug)

Merge branch 'develop' into feature/byer3/well_constraints

6128876

cleanup comments

6f56f1e

tjb-ltk added type: feature New feature or request ci: run CUDA builds Allows to triggers (costly) CUDA jobs flag: requires rebaseline Requires rebaseline branch in integratedTests changes XML input ci: run code coverage enables running of the code coverage CI jobs labels Jan 14, 2026

paveltomin removed request for CusiniM, Guotong-Ren, matteofrigo5, paveltomin and rasimHZ January 26, 2026 16:22

Merge branch 'develop' into feature/byer3/well_constraints

aec6453

dkachuma reviewed Feb 9, 2026

View reviewed changes

tjb-ltk mentioned this pull request Feb 10, 2026

feat: feature/byer3/well manager #3971

Open

tjb-ltk closed this Feb 13, 2026

	static constexpr char const * constraintValueString() { return "constraintValue"; }
	static constexpr char const * constraintValueString() { return "value"; }

-class BHPConstraint : public WellConstraintBase
+enum class BHPType : integer
+{
+  MINIMUM,
+  MAXIMUM
+};
+template <BHPType TYPE>
+class BHPConstraint : public WellConstraintBase;
+{
+};
+using MinimumBHPConstraint = BHPConstraint<MINIMUM>;
+using MaximumBHPConstraint = BHPConstraint<MAXIMUM>;


		WellControls const & wellControls = getWellControls( subRegion );

		if( wellControls.isWellOpen( ) )

Conversation

tjb-ltk commented Oct 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MelReyCG commented Dec 16, 2025

Uh oh!

codecov bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

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!

dkachuma left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tjb-ltk commented Oct 13, 2025 •

edited

Loading

codecov bot commented Feb 9, 2026 •

edited

Loading