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

tjb-ltk · 2026-02-10T16:51:58Z

feat: Formalize definition of well constraints (this replaces #3862 feat: feature/byer3/well constraints)

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

Schema changes / refactoring
WellManager replaces CompositionalMultiphaseWell and SinglePhaseWell, well manager implements physic solver interfaces and iterates over wells to fill coupled Jacobin.

WellControl is now either CompositionalMultiphaseWell or SinglePhaseWell, which implements WellControl interfaces . WellControl should be renamed to "Well"

WellControl provides methods independent of fluid model. CompositionalMulitphasewell /singlephasewell are only kept as owners of Jacobian generation kernels. These could be placed in wellcontrol with simple iscompo check, maybe later.

Subsequent PR's based on this PR

wmwe. - well manager PR with well estimator

wmwe + wellhead 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.

…well initialization vagaries assoiated with useSurfaceConditions=0

dkachuma

It's rather a large PR. Is there anyway we could split it up? For instance do the constraints only for now and leave the element rearrangement for the next step.

dkachuma · 2026-04-20T19:51:17Z

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


Instead of declaring almost the same class twice I would just use a template parameter e.g.

template <WellTypes WELL_TYPE> class BHPConstraint : public WellConstraintBase { // ... static string catalogName() { if constexpr (WELL_TYPE == WellControls::Type::PRODUCER) { return "MinimumBHPConstraint"; } else { return "MaximumBHPConstraint"; } } // ... }; using MinimumBHPConstraint = BHPConstraint<WellTypes::PRODUCER>; using MaximumBHPConstraint = BHPConstraint<WellTypes::INJECTOR>;

Done and committed

In terms of splitting the PR... I think it would probably take at least a month and not sure why go this route.

dkachuma · 2026-04-20T19:53:21Z

+   * Either producer or injector
   */
  enum class Type : integer
  {


We now have WellTypes defined in WellConstants.cpp. Maybe now we can remove this.

dkachuma · 2026-04-20T19:54:55Z

+{
+  this->setInputFlags( InputFlags::OPTIONAL_NONUNIQUE );
+
+  this->registerWrapper( viewKeyStruct::massRateString(), &this->m_constraintValue ).


We need to deregister the "value" wrapper before we can register this. Otherwise the object will have two wrappers that point to the same data.

I removed the this->. But not sure what is meant by deregister. The above code follows pattern in many classes...

dkachuma · 2026-04-20T19:56:01Z

+    setInputFlag( InputFlags::OPTIONAL ).
+    setDescription( "Name of the well constraint schedule table when the constraint value  is a time dependent function. \n" );
+
+  registerWrapper( viewKeyStruct::constraintValueString(), &m_constraintValue ).


Most of the sub-classes reregister this value under a different name. Before that we need to ensure that this is deregistered to avoid multiple wrapper names referring to the same data.

dkachuma · 2026-04-20T19:58:42Z

+  // Quantities computed from well constraint solve with this boundary condition
+
+  // botton hole pressure
+  real64 m_BHP;
+
+  // phase rates
+  array1d< real64 >  m_phaseVolumeRates;
+
+  // liquid rate
+  real64 m_liquidRate;
+
+  // total volume rate
+  real64 m_totalVolumeRate;
+
+  // mass rate
+  real64 m_massRate;
+
+  /// Rate sign. +1 for injector, -1 for producer
+  real64 m_rateSign;


These variables seem specific to some of the sub classes. Do they need to appear in the base class?

When a constraint is solved using the estimator these quantities define the state of the solve, which is then used to compare constraints to determine limiting constraint. I struggled with how to best associate a state with each constraint, so decided to keep it simple and just store what is needed for compo and single phase in base class. Open to suggestions

dkachuma · 2026-04-20T20:37:18Z

+
      // set the reference well element where the BHP control is applied
-      wellControls.setReferenceGravityCoef( refElev * gravVector[2] );
+      wellControls.setReferenceGravityCoef( refElev * gravVector[2] );  // tjb remove


Should this not be size 3

Suggested change

wellControls.setReferenceGravityCoef( refElev * gravVector[2] ); // tjb remove

wellControls.setReferenceGravityCoef( refElev * gravVector[3] ); // tjb remove

dkachuma · 2026-04-20T20:44:42Z

+//struct ConstraintHelper< NC, IS_THERMAL   > {};
+
+template< integer NC, integer IS_THERMAL, typename CONSTRAINT = BHPConstraint >
+struct ConstraintHelper


This file looks like it might be difficult to compile. Can we use the kernelSpecs.json to generate instantiations?

dkachuma · 2026-04-20T20:49:49Z

+        control="totalVolRate"
+        maxRelativePressureChange="0.5"
+        maxCompFractionChange="0.5"
+        useMass="0">


Are we going to be specifying this per well?

dkachuma · 2026-04-20T20:50:22Z

+        <InjectionPhaseVolumeRateConstraint
+          name="inj"
+          phaseName="water"/>


Suggested change

<InjectionPhaseVolumeRateConstraint

name="inj"

phaseName="water"/>

Not sure we need these empty constraints.

dkachuma · 2026-04-20T21:10:03Z


  /// Number of bits in mask storage
-  static constexpr int NUM_BITS = internal::roundToNextPowerOfTwo( MAX_COMP );
+  static constexpr int NUM_BITS = geos::internal::roundToNextPowerOfTwo( MAX_COMP );


I don't think we need changes to this file.

…alization

tjb-ltk and others added 30 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

fix reference to 'internal' is ambiguous error

b6ae5ef

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

merge devel

d0fcf79

remove extra ;

8b21d69

remove :

470a7ff

fix constraint schema, phase name on totalvol constraint not allowed

b8a90f4

update well constraint schema

94fc9ad

1) expose method for unit tests, 2) update unittests accordingly

17047bd

schema change

c6a349f

1) remove unused vars , add missing constriant type in selector

1c03220

reintroduce control keyword option to be consistent with previous in …

b5f6c5d

…well initialization vagaries assoiated with useSurfaceConditions=0

updated schema

c43657e

add back control keyword

e78ef18

add control schema to unit tests

b000ed4

uncrustify should be automated

a319e0e

cleanup

7c17469

tjb-ltk mentioned this pull request Feb 13, 2026

feat: well_manager + well estimator #3972

Open

tjb-ltk added the flag: ready for review label Feb 13, 2026

tjb-ltk and others added 10 commits February 13, 2026 09:16

Merge branch 'develop' into feature/byer3/well_manager

d603bf9

merge fixes

3c12552

uncrustify

5718eb7

convert to new schema

e33ed8d

now that dev has same fix

fe5f1a1

cleanup

d61beb8

cleanup

634ab88

remove dead code

2d992aa

Merge branch 'develop' into feature/byer3/well_manager

885d9f0

Merge branch 'develop' into feature/byer3/well_manager

a68c79f

dkachuma requested review from bd713 and jafranc as code owners April 9, 2026 14:39

dkachuma and others added 2 commits April 9, 2026 11:28

Merge branch 'develop' into feature/byer3/well_manager

2dce1a3

Merge develop

af34276

dkachuma reviewed Apr 20, 2026

View reviewed changes

dkachuma self-requested a review April 20, 2026 21:12

Byer and others added 9 commits April 27, 2026 14:28

template BHP constraint class on min/max to remove the need for speci…

500524e

…alization

fix gpu compile error

a100da0

fix type error

c173d8f

cleanup

87372e1

cleanup setting of useMass

552518a

Merge branch 'develop' into feature/byer3/well_manager

f8e8e9b

move useMass user field from WellControl to WellManager

0eea6a8

change mixtureConnectionRate to connectionRate

673e438

update well schema

a7fcc14

rrsettgast removed ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI labels May 4, 2026

	wellControls.setReferenceGravityCoef( refElev * gravVector[2] ); // tjb remove
	wellControls.setReferenceGravityCoef( refElev * gravVector[3] ); // tjb remove

	<InjectionPhaseVolumeRateConstraint
	name="inj"
	phaseName="water"/>

Conversation

tjb-ltk commented Feb 10, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dkachuma left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

tjb-ltk commented Feb 10, 2026 •

edited

Loading

dkachuma left a comment •

edited

Loading