feat: well_manager + well estimator by tjb-ltk · Pull Request #3972 · GEOS-DEV/GEOS

tjb-ltk · 2026-02-13T15:09:34Z

Replaces PR #3735 and extends PR #3971

Overview

This PR introduces

An improved well schema layout and code refactor better suited for well modeling. The previous implementation primarily targeted Jacobian generation requirements for the coupled reservoir and well system.
The well estimator is used to select the active well constraint by solving the well system assuming fixed reservoir conditions and selecting the constraint with the highest or lowest well flowing pressure.
- the estimator is applied at beginning of Jacobian assembly of the coupled system
- frequency determined via input setting
- estimator is a data member of WellControl and a tailed version of PhysicsSolver for wells
- logic underpins future capability to replace the segmented well model with other formulations

This is a breaking change, detailed migration instructions and migration script are posted at #4081

…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

victorapm · 2026-07-17T00:34:40Z

+  string const bhp_type = isProducerWell ? MinimumBHPConstraint::catalogName() : MaximumBHPConstraint::catalogName();
+  bool const no_match_found = std::none_of( constraints.begin(), constraints.end(), [&bhp_type]( const auto & constraint_tuple )
+  {
+    return std::get< 1 >( constraint_tuple ) == bhp_type;
+  } );
+  GEOS_THROW_IF( no_match_found,


When the sole BHP or rate constraint has constraintActive=0, these existence checks still accept it, while getBHPConstraint and the rate-list helpers filter it out. Subsequent selection either dereferences null or erases an end() iterator because the current constraint is absent from the active list.

Not sure if this address your comment... for all current models constraintActive = 1. The addition of this flag was needed for 2 workflows, wellheadpressure, where the simulator can impose an "internal constraint" and the underpinning of future functionality where a well can be assigned producer and injection constraints, which then come into consideration when only the well type changes, versus the need to define 2 wells with same perforation information. For either the code will need to ensure that an active pressure and rate constraint are present.

jafranc · 2026-07-17T16:12:11Z

+  m_useMass( false ),
+  m_useTotalMassEquation( 1 ),
+  m_isThermal( 0 ),
+  m_isCompositional( true ),


should'nt it be an integer and registered for restart ? what happen if we want to restard a non-compositional well ?

The variable is an internal flag set for initial and restart runs. I'm guessing the integratedTests would fail if it was set for restarts.

jafranc · 2026-07-17T16:26:25Z

+  array1d< real64 > localResidualNorm, wellResidalNorm;
+  array1d< real64 > localResidualNormalizer;
+
+  if( isThermal() )


Sticking to conventionm shouldn't it be set by NDOF or so ?

Yes, it would add the volume balance.. I will create a separate PR so any changes are associated with a specific change.

jafranc · 2026-07-17T16:32:38Z

+          if( wellResidalNorm[i] > localResidualNorm[i] )
+          {
+            localResidualNorm[i] = wellResidalNorm[i];
+          }


Suggested change

if( wellResidalNorm[i] > localResidualNorm[i] )

{

localResidualNorm[i] = wellResidalNorm[i];

}

localResidualNorm[i] = LvArray::math::max( localResidualNorm[i], wellResidualNorm[i] );

jhuang2601

@tjb-ltk Great job!

Please update the branch with latest develop repo, which will fix the following failures for readthedoc build:

WARNING: Error, no command xref target from index:QuickStart
WARNING: Error, no command xref target from index:Tutorials
WARNING: Error, no command xref target from index:BasicExamples
WARNING: Error, no command xref target from index:AdvancedExamples
WARNING: Error, no command xref target from index:UserGuide

jhuang2601 · 2026-07-21T14:05:24Z

+    std::cout << " Well: " << subRegion.getName() << "   Est Attempt: " << dtAttempt
+              << ", ConfigurationIter: " << configurationLoopIter
+              << ", NewtonIter: " << newtonIter
+              << ", Residual Norm: " << residualNorm << std::endl;


This is inside a Newton iteration loop and will spam output every iteration.
Remove it? or guard by a log level?

jhuang2601 · 2026-07-21T14:07:18Z

+#include "fileIO/Outputs/OutputBase.hpp"
+#include "physicsSolvers/fluidFlow/wells/WellFields.hpp"

+#include "functions/FunctionManager.hpp"


Suggested change

#include "functions/FunctionManager.hpp"

remove this duplicate, as it has already been added in line 37

jhuang2601 · 2026-07-21T14:12:29Z

+    setApplyDefaultValue( 0 ).
    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Name of the BHP table when the rate is a time dependent function" );
+    setDescription( "Flag to esitmate well solution prior to coupled reservoir and well solve." );


Suggested change

setDescription( "Flag to esitmate well solution prior to coupled reservoir and well solve." );

setDescription( "Flag to estimate well solution prior to coupled reservoir and well solve." );

jhuang2601 · 2026-07-21T15:33:21Z

@@ -345,8 +401,6 @@
      scale="0.1"/>
  </FieldSpecifications>


Suggested change

</FieldSpecifications>

</FieldSpecifications>

jhuang2601 · 2026-07-21T15:33:31Z


-  <!-- SPHINX_TUT_DEAD_OIL_EGG_FIELD_SPECS_END -->
-  <!-- SPHINX_TUT_DEAD_OIL_EGG_OUTPUTS -->
  <Outputs>


Suggested change

<Outputs>



<Outputs>

jhuang2601 · 2026-07-21T15:33:46Z

    <Restart
      name="restartOutput"/>
-
  </Outputs>


Suggested change

</Outputs>

</Outputs>

jhuang2601 · 2026-07-21T15:33:58Z


-  <!-- SPHINX_TUT_DEAD_OIL_EGG_OUTPUTS_END -->
-  <!-- SPHINX_TUT_DEAD_OIL_EGG_TASKS -->
  <Tasks>


Suggested change

<Tasks>



<Tasks>

jhuang2601 · 2026-07-21T15:34:10Z

      objectPath="ElementRegions/wellRegion4/wellRegion4UniqueSubRegion"
-      fieldName="wellElementMixtureConnectionRate"/>
+      fieldName="wellElementConnectionRate"/>
  </Tasks>


Suggested change

</Tasks>

</Tasks>

jhuang2601

@tjb-ltk Great job!

Please update the branch with latest develop repo, which will fix the following failures for readthedoc build:

WARNING: Error, no command xref target from index:QuickStart
WARNING: Error, no command xref target from index:Tutorials
WARNING: Error, no command xref target from index:BasicExamples
WARNING: Error, no command xref target from index:AdvancedExamples
WARNING: Error, no command xref target from index:UserGuide

…computed, no changes in results

…eature/byer3/wm_we

dkachuma · 2026-05-13T20:11:23Z

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


To clarify the comment, the base class WellConstraintBase registers the data member m_constraintValue using the string "value" (WellConstraintBase::viewKeyStruct::constraintValueString()). This means the user will have two field options "value" and "massRate" to set the same value. So we need to deregister the first string before we can attach this one. This applies to the other derived types from WellConstraintBase.

removed registration from base class

dkachuma · 2026-05-20T19:24:05Z

+        control="totalVolRate"
+        maxRelativePressureChange="0.5"
+        maxCompFractionChange="0.5">
+        <InjectionPhaseVolumeRateConstraint


Remove undefined constraint?

dkachuma · 2026-06-23T18:18:51Z

+		<!--massRate => Maximum mass rate (kg/s)-->
+		<xsd:attribute name="massRate" type="real64" default="0" />
+		<!--value => Constraint value. 
+-->
+		<xsd:attribute name="value" type="groupNameRef" default="0" />


For instance, here "value" and "massRate" refer to the same piece of data.

I removed registration in the base constraint class

dkachuma · 2026-06-23T18:23:20Z


-  <!-- SPHINX_TUT_DEAD_OIL_EGG_EVENTS_END -->
-  <!-- SPHINX_TUT_DEAD_OIL_EGG_NUMERICAL_METHODS -->
  <NumericalMethods>


The SPHINX anchors may be used in the documentation build.

these were added back

victorapm

Looks great, thanks for all the work, Tom!

MelReyCG

The PR is a big improvement in architecture and in feature scalability (classes per constraints), thanks for your work Tom!
I have a some concerns on code quality, but i will submit a PR or an issue later, thanks to not delete the branch.

MelReyCG · 2026-07-31T09:02:19Z

We are lacking an approval from @OmarDuran, @bd713, @jafranc, @rrsettgast, and/or @wrtobin for the src/coreComponents/mesh folder.

MelReyCG · 2026-07-31T10:04:57Z

I reverted the changes, we will apply them back later in another (smaller) PR. I left some TODO.

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

victorapm reviewed Jul 17, 2026

View reviewed changes

Comment thread src/coreComponents/physicsSolvers/fluidFlow/wells/WellControls.cpp

victorapm reviewed Jul 17, 2026

View reviewed changes

Comment thread src/coreComponents/physicsSolvers/fluidFlow/wells/WellManager.cpp

victorapm reviewed Jul 17, 2026

View reviewed changes

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

victorapm reviewed Jul 17, 2026

View reviewed changes

Comment thread src/coreComponents/physicsSolvers/fluidFlow/wells/WellLiquidRateConstraint.cpp

jafranc reviewed Jul 17, 2026

View reviewed changes

tjb-ltk added 2 commits July 20, 2026 14:14

changes for PR review comments

473bced

roll back well residal fix to test impact on baselines

a7b9ea3

jhuang2601 approved these changes Jul 21, 2026

View reviewed changes

tjb-ltk and others added 7 commits July 22, 2026 08:26

Merge branch 'develop' into feature/byer3/wm_we

d3c6c9e

review changes, update baseline, internal quantity now conditionally …

36e5f2c

…computed, no changes in results

relmod compiler errors and schema update

3a11131

add SPHINX back

949cca3

add SPHINX back

de42fee

Merge branch 'feature/byer3/wm_we' of github.com:GEOS-DEV/GEOS into f…

c73dd7a

…eature/byer3/wm_we

doc test

ae7a514

dkachuma reviewed Jul 28, 2026

View reviewed changes

tjb-ltk added 4 commits July 28, 2026 15:54

remove duplicate variable registration

316e6d8

rebaseline due to schema - removed duplicate variable registration

86aa3da

remove #if 0 code

0fa68a6

remove wm_we branch update history

193fdc5

victorapm approved these changes Jul 31, 2026

View reviewed changes

MelReyCG approved these changes Jul 31, 2026

View reviewed changes

⏪ revert un-critical changes on /src/coreComponents/mesh folder

fb75717

MelReyCG merged commit 0f9c572 into develop Jul 31, 2026
22 checks passed

MelReyCG deleted the feature/byer3/wm_we branch July 31, 2026 11:57

MelReyCG restored the feature/byer3/wm_we branch July 31, 2026 11:57

	setDescription( "Flag to esitmate well solution prior to coupled reservoir and well solve." );
	setDescription( "Flag to estimate well solution prior to coupled reservoir and well solve." );

	</FieldSpecifications>
	</FieldSpecifications>
	<!-- SPHINX_TUT_DEAD_OIL_EGG_FIELD_SPECS_END -->

	</Outputs>
	</Outputs>
	<!-- SPHINX_TUT_DEAD_OIL_EGG_OUTPUTS_END -->

Uh oh!

Conversation

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

Uh oh!

Overview

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

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!

Uh oh!

Uh oh!

jhuang2601 left a comment

Choose a reason for hiding this comment

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!

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!

jhuang2601 left a comment

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

tjb-ltk commented Feb 13, 2026 •

edited

Loading