feat: Adding flow statistics for arbitrary mesh cell element sets

inputFiles/compositionalMultiphaseWell/simpleCo2InjTutorial_base.xml

@@ -191,15 +191,38 @@
   </Outputs>
   <!-- SPHINX_FIELD_CASE_Co2_OUTPUT_END -->
 
+
+  <!-- 
+    Do not remove the multiple CompositionalMultiphaseStatistics below:
+    the goal is also to test here the behaviour of intersecting & complementary sets.
+  -->
+
   <!-- SPHINX_FIELD_CASE_Co2_TASKS -->  
   <Tasks>
     <PackCollection
       name="wellPressureCollection"
       objectPath="ElementRegions/wellRegion/wellRegionUniqueSubRegion"
       fieldName="pressure" />
+
+    <!-- stats table to compare the domain element set with the well surroundings element set -->
+    <CompositionalMultiphaseStatistics 
+      name="domainAndInjectorFlowStats"
+      flowSolverName="compositionalMultiphaseFlow"
+      setNames="{all, injectorSurrounding}"
+      logLevel="1"
+      writeCSV="1"/>
+
+    <!-- stats table to compare the domain top part with the bottom part -->
+    <CompositionalMultiphaseStatistics 
+      name="domainTopAndDownFlowStats"
+      flowSolverName="compositionalMultiphaseFlow"
+      setNames="{domainBottom, domainTop}"
+      logLevel="1"
+      writeCSV="1"/>
 
   </Tasks>
   <!-- SPHINX_FIELD_CASE_Co2_TASKS_END -->  
+
   <Functions>
     <TableFunction 
         name="permxFunc"

inputFiles/compositionalMultiphaseWell/simpleCo2InjTutorial_smoke.xml

@@ -26,14 +26,38 @@
                               { 525.0, 525.0, 6600.00 } }"
         polylineSegmentConn="{ { 0, 1 } }"
         radius="0.1"
-        numElementsPerSegment="2">
+        numElementsPerSegment="2"
+        logLevel="1">
         <Perforation
           name="injector1_perf1"
           distanceFromHead="45"/>
       </InternalWell>
    </InternalMesh>
   </Mesh>
   <!-- SPHINX_FIELD_CASE_Co2_MESH_END --> 
+
+  <!-- SPHINX_FIELD_CASE_Co2_GEOMETRY -->
+  <Geometry>
+
+    <!-- This Box should select 5 x 5 elements around the perforation -->
+    <!-- ( Perforated cell center is at [530, 500, 6008] ) -->
+    <Box
+      name="injectorSurrounding"
+      xMin="{ 470.0, 400.0, 6584.0 }"
+      xMax="{ 590.0, 600.0, 6632.0 }" />
+
+    <!-- These two boxes are the top and bottom parts of the domain, and should contain an equal number of elements -->
+    <Box
+      name="domainTop"
+      xMin="{ 0.0, 450.0, 6500.0 }"
+      xMax="{ 1000.0, 550.0, 7100.0 }" />
+    <Box
+      name="domainBottom"
+      xMin="{ 0.0, 450.0, 7100.0 }"
+      xMax="{ 1000.0, 550.0, 7700.0 }" />
+
+  </Geometry>
+  <!-- SPHINX_FIELD_CASE_Co2_GEOMETRY_END --> 
 
   <!-- SPHINX_FIELD_CASE_Co2_EVENTS -->
   <Events
@@ -68,6 +92,16 @@
       maxEventDt="5e5"        
       target="/Solvers/coupledFlowAndWells"/>
 
+    <PeriodicEvent
+      name="domainAndInjectorFlowStatsEvent"
+      cycleFrequency="10"
+      target="/Tasks/domainAndInjectorFlowStats"/>
+
+    <PeriodicEvent
+      name="domainTopAndDownFlowStatsEvent"
+      cycleFrequency="10"
+      target="/Tasks/domainTopAndDownFlowStats"/>
+
   </Events>
   <!-- SPHINX_FIELD_CASE_Co2_EVENTS_END -->  
 </Problem>

src/coreComponents/physicsSolvers/LogLevelsInfo.hpp

@@ -126,6 +126,12 @@ struct Statistics
   static constexpr std::string_view getDescription() { return "Print statistics"; }
 };
 
+struct StatisticsPerRegion
+{
+  static constexpr int getMinLogLevel() { return 2; }
+  static constexpr std::string_view getDescription() { return "Print per region statistics"; }
+};
+
 struct SurfaceGenerator
 {
   static constexpr int getMinLogLevel() { return 1; }