feat: feature/byer3/well constraints

inputFiles/compositionalMultiphaseWell/benchmarks/Class09Pb3/class09_pb3_drainageOnly_direct_base.xml

@@ -1,8 +1,6 @@
 <?xml version="1.0" ?>
 
 <Problem>
-
-  <!-- SPHINX_FIELD_CASE_Co2_SOLVER -->
   <Solvers>
     <CompositionalMultiphaseReservoir
       name="coupledFlowAndWells"
@@ -35,19 +33,24 @@
       <WellControls
         name="wellControls"
         type="injector"
-        control="totalVolRate"
-        referenceElevation="-3000"
-        targetBHP="1e8"
         enableCrossflow="0"
-        useSurfaceConditions="1"            
-        surfacePressure="101325"  
-        surfaceTemperature="288.71" 
-        targetTotalRateTableName="totalRateTable"
-        injectionTemperature="353.15"
-        injectionStream="{ 1.0, 0.0 }"/>
+        useSurfaceConditions="1"
+        surfacePressure="101325"
+        surfaceTemperature="288.71"
+        control="totalVolRate">
+        <MaximumBHPConstraint
+          name="maxbhp"
+          targetBHP="1e8"
+          referenceElevation="-3000"/>
+        <InjectionVolumeRateConstraint
+          name="maxvolrateinj"
+          constraintScheduleTableName="totalRateTable"
+          injectionStream="{ 1.0, 0.0 }"
+          injectionTemperature="353.15"/>
+      </WellControls>
     </CompositionalMultiphaseWell>
   </Solvers>
-  
+
   <ElementRegions>
     <CellElementRegion
       name="reservoir"
@@ -58,11 +61,11 @@
       name="wellRegion"
       materialList="{ fluid }"/>
   </ElementRegions>
- 
+
   <NumericalMethods>
     <FiniteVolume>
       <TwoPointFluxApproximation
-        name="fluidTPFA" />
+        name="fluidTPFA"/>
     </FiniteVolume>
   </NumericalMethods>
 
@@ -80,83 +83,87 @@
       solidModelName="nullSolid"
       porosityModelName="rockPorosity"
       permeabilityModelName="rockPerm"/>
+
     <NullModel
       name="nullSolid"/>
+
     <PressurePorosity
       name="rockPorosity"
       defaultReferencePorosity="0.1"
       referencePressure="1.0e7"
       compressibility="4.5e-10"/>
+
     <ConstantPermeability
       name="rockPerm"
       permeabilityComponents="{ 1.0e-12, 1.0e-12, 1.0e-12 }"/>
 
     <TableRelativePermeability
       name="relperm"
       phaseNames="{ gas, water }"
-      wettingNonWettingRelPermTableNames="{ waterRelativePermeabilityTable,
-                                            gasRelativePermeabilityTable }"/>
-
+      wettingNonWettingRelPermTableNames="{ waterRelativePermeabilityTable, gasRelativePermeabilityTable }"/>
+
     <TableCapillaryPressure
       name="cappres"
       phaseNames="{ gas, water }"
       wettingNonWettingCapPressureTableName="waterCapillaryPressureTable"/>
   </Constitutive>
 
   <FieldSpecifications>
-   <HydrostaticEquilibrium
+    <HydrostaticEquilibrium
       name="equil"
       objectPath="ElementRegions"
       datumElevation="-3000"
       datumPressure="3.0e7"
       initialPhaseName="water"
       componentNames="{ co2, water }"
-      componentFractionVsElevationTableNames="{ initCO2CompFracTable,
-                                                initWaterCompFracTable }"
+      componentFractionVsElevationTableNames="{ initCO2CompFracTable, initWaterCompFracTable }"
       temperatureVsElevationTableName="initTempTable"/>
-
-    <!-- SPHINX_BC -->
+
     <FieldSpecification
       name="bcPressure"
       objectPath="faceManager"
       setNames="{ xpos, xneg, ypos, yneg }"
       fieldName="pressure"
       functionName="pressureFunction"
       scale="1"/>
+
     <FieldSpecification
       name="bcTemperature"
       objectPath="faceManager"
       setNames="{ xpos, xneg, ypos, yneg }"
       fieldName="temperature"
       functionName="temperatureFunction"
       scale="1"/>
+
     <FieldSpecification
       name="bcCompositionCO2"
       objectPath="faceManager"
       setNames="{ xpos, xneg, ypos, yneg }"
       fieldName="globalCompFraction"
       component="0"
       scale="0.000001"/>
+
     <FieldSpecification
       name="bcCompositionWater"
       objectPath="faceManager"
       setNames="{ xpos, xneg, ypos, yneg }"
       fieldName="globalCompFraction"
       component="1"
       scale="0.999999"/>
-    <!-- SPHINX_BC_END -->
   </FieldSpecifications>
 
   <Functions>
     <TableFunction
       name="initCO2CompFracTable"
       coordinates="{ -3238.2, -2506.13 }"
       values="{ 0.000001, 0.000001 }"/>
+
     <TableFunction
       name="initWaterCompFracTable"
       coordinates="{ -3238.2, -2506.13 }"
       values="{ 0.999999, 0.999999 }"/>
-   <TableFunction
+
+    <TableFunction
       name="initTempTable"
       coordinates="{ -3238.2, -2506.13 }"
       values="{ 380.296, 358.334 }"/>
@@ -165,37 +172,36 @@
       name="waterRelativePermeabilityTable"
       coordinateFiles="{ tables/phaseVolumeFraction_water.txt }"
       voxelFile="tables/relPerm_water.txt"/>
+
     <TableFunction
       name="gasRelativePermeabilityTable"
       coordinateFiles="{ tables/phaseVolumeFraction_gas.txt }"
-      voxelFile="tables/relPerm_gas.txt"/>      
+      voxelFile="tables/relPerm_gas.txt"/>
 
-   <TableFunction
+    <TableFunction
       name="waterCapillaryPressureTable"
       coordinateFiles="{ tables/phaseVolumeFraction_water.txt }"
-      voxelFile="tables/capPres_water.txt"/>  
+      voxelFile="tables/capPres_water.txt"/>
 
-    <TableFunction 
+    <TableFunction
       name="temperatureFunction"
       inputVarNames="{ faceCenter }"
-      coordinateFiles="{ fc_tables/xlin.geos, fc_tables/ylin.geos, fc_tables/zlin.geos}"
+      coordinateFiles="{ fc_tables/xlin.geos, fc_tables/ylin.geos, fc_tables/zlin.geos }"
       voxelFile="fc_tables/temperature.geos"
-      interpolation="linear" />
+      interpolation="linear"/>
 
-    <TableFunction 
+    <TableFunction
       name="pressureFunction"
       inputVarNames="{ faceCenter }"
-      coordinateFiles="{ fc_tables/xlin.geos, fc_tables/ylin.geos, fc_tables/zlin.geos}"
+      coordinateFiles="{ fc_tables/xlin.geos, fc_tables/ylin.geos, fc_tables/zlin.geos }"
       voxelFile="fc_tables/pressure.geos"
-      interpolation="linear" /> 
+      interpolation="linear"/>
 
     <TableFunction
       name="totalRateTable"
-      inputVarNames="{time}"
-      coordinates="{0, 7.7198e8, 1.544e9}"
-      values="{ 8.02849025, 0, 0}"
+      inputVarNames="{ time }"
+      coordinates="{ 0, 7.7198e8, 1.544e9 }"
+      values="{ 8.02849025, 0, 0 }"
       interpolation="lower"/>
-
   </Functions>
-
 </Problem>