Schema Change Examples for PR #3972

[tjb-ltk]

Key Changes

The CompositionalMultiphaseWell and SinglePhaseWell keywords are replaced by WellManager. The WellManager defines the collection of wells and attributes valid for all wells. The WellControl keyword is replaced with CompositionalMultiphaseWell and SinglePhaseWell. These objects define the well and constraint handling is now explicitly object-based in the schema implementation: each constraint type is a dedicated child constraint object, instead of keeping most constraint state and other well definition directly on the well control object.

A conversion script with instructions (convertWellSchema.py) is provided in the GEOS/scripts directory. If there are conversion errors contact @tjb-ltk

Structured XML Migration Examples

1. Injector: BHP + Scheduled Total Volume Rate + Injection Stream

Old schema

<WellControls
  name="WATER.INJECTOR.CONTROL"
  type="injector"
  control="totalVolRate"
  useSurfaceConditions="0"
  surfacePressure="1.013250e+05"
  surfaceTemperature="288.71"
  enableCrossflow="0"
  targetBHP="4.5e7"
  referenceElevation="-2000.0"
  injectionStream="{ 0.0, 0.0, 1.0 }"
  injectionTemperature="349.15"
  targetTotalRateTableName="WATER.INJECTOR.RATE"/>

New schema

<CompositionalMultiphaseWell
  name="WATER.INJECTOR.CONTROL"
  type="injector"
  control="totalVolRate"
  useSurfaceConditions="0"
  surfacePressure="1.013250e+05"
  surfaceTemperature="288.71"
  enableCrossflow="0">

  <MaximumBHPConstraint
    name="maxbhp"
    targetBHP="4.5e7"
    referenceElevation="-2000.0"/>

  <InjectionVolumeRateConstraint
    name="maxvolrateinj"
    constraintScheduleTableName="WATER.INJECTOR.RATE"
    injectionStream="{ 0.0, 0.0, 1.0 }"
    injectionTemperature="349.15"/>

</CompositionalMultiphaseWell>

Migration notes

• targetTotalRateTableName moved to constraintScheduleTableName on the rate constraint.
• targetBHP and referenceElevation moved into explicit BHP constraint blocks.
• injectionStream and injectionTemperature moved to injection-specific constraint blocks.

---

2. Producer: BHP + Scheduled Phase Rate

Old schema

<WellControls
  name="PRODUCER.CONTROL"
  type="producer"
  control="BHP"
  useSurfaceConditions="0"
  surfacePressure="1.013250e+05"
  surfaceTemperature="288.71"
  targetPhaseName="gas"
  targetPhaseRateTableName="PRODUCER.RATE"
  targetBHP="1.95e7"
  referenceElevation="-2000"/>

New schema

<CompositionalMultiphaseWell
  name="PRODUCER.CONTROL"
  type="producer"
  control="BHP"
  useSurfaceConditions="0"
  surfacePressure="1.013250e+05"
  surfaceTemperature="288.71">

  <ProductionPhaseVolumeRateConstraint
    name="maxgasprod"
    phaseName="gas"
    constraintScheduleTableName="PRODUCER.RATE"/>

  <MinimumBHPConstraint
    name="minbhp"
    targetBHP="1.95e7"
    referenceElevation="-2000"/>

</CompositionalMultiphaseWell>

Migration notes

• targetPhaseName + targetPhaseRateTableName moved into ProductionPhaseVolumeRateConstraint.
• BHP moved into MinimumBHPConstraint for producer wells.

---

3. Single-Phase Producer: BHP + Constant Total Rate

Old schema

<WellControls
  name="wellControls1"
  type="producer"
  control="BHP"
  referenceElevation="2"
  targetBHP="5e5"
  targetTotalRate="1e-4"/>

New schema

<SinglePhaseWell
  name="wellControls1"
  type="producer"
  control="BHP">

  <MinimumBHPConstraint
    name="minbhp"
    targetBHP="5e5"
    referenceElevation="2"/>

  <ProductionVolumeRateConstraint
    name="maxvolrateprod"
    volumeRate="1e-4"/>

</SinglePhaseWell>

Migration notes

• targetTotalRate became volumeRate on ProductionVolumeRateConstraint.
• BHP moved to MinimumBHPConstraint.

---

4. Single-Phase Injector: BHP + Constant Total Rate

Old schema

<WellControls
  name="wellControls2"
  type="injector"
  control="totalVolRate"
  referenceElevation="2"
  targetBHP="1e7"
  targetTotalRate="1e-7"/>

New schema

<SinglePhaseWell
  name="wellControls2"
  type="injector"
  control="totalVolRate">

  <MaximumBHPConstraint
    name="maxbhp"
    targetBHP="1e7"
    referenceElevation="2"/>

  <InjectionVolumeRateConstraint
    name="maxvolrateinj"
    volumeRate="1e-7"/>

</SinglePhaseWell>

Migration notes

• targetTotalRate became volumeRate on InjectionVolumeRateConstraint.
• BHP moved to MaximumBHPConstraint for injector wells.

---

5. Generic New Structured Pattern

<WellManager name="WELL.SOLVER" targetRegions="{ ... }">

  <SinglePhaseWell|CompositionalMultiphaseWell
    name="..."
    type="producer|injector"
    control="BHP|totalVolRate|phaseVolRate|massRate"
    useSurfaceConditions="0|1"
    surfacePressure="..."
    surfaceTemperature="...">

    <MinimumBHPConstraint|MaximumBHPConstraint
      name="..."
      targetBHP="..."
      referenceElevation="..."/>

    <ProductionVolumeRateConstraint|InjectionVolumeRateConstraint
      name="..."
      volumeRate="..."
      constraintScheduleTableName="..."/>

    <ProductionPhaseVolumeRateConstraint|InjectionPhaseVolumeRateConstraint
      name="..."
      phaseName="..."
      phaseRate="..."
      constraintScheduleTableName="..."/>

    <ProductionMassRateConstraint|InjectionMassRateConstraint
      name="..."
      massRate="..."
      constraintScheduleTableName="..."/>

    <ProductionLiquidRateConstraint
      name="..."
      liquidRate="..."
      phaseNames="{ ... }"
      constraintScheduleTableName="..."/>

  </SinglePhaseWell|CompositionalMultiphaseWell>

</WellManager>