feat: Adding flow statistics for arbitrary mesh cell element sets by MelReyCG · Pull Request #4005 · GEOS-DEV/GEOS

MelReyCG · 2026-03-26T09:18:43Z

This PR aims at extending the flow statistics components by introducing an optional setNames parameter to SinglePhaseStatistics and CompositionalMultiphaseStatistics, allowing users to obtain statistics computation from arbitrary mesh element sets instead of being forced to process solver regions.

Sets can already be defined with Geometry objects like Box.

Multiple set can be provided for a given statistics component, and in that case, statistics over all provided sets are also logged. To support intersecting sets and give valid statistics, they are computed on a compound set (union of all selected set).
Here is an example:

    <!-- 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"/>

--------------------------------------------------------------------------------------------------------------
|                  Statistics: domainAndInjectorFlowStats / Discretization: fluidTPFA                        |
|------------------------------------------------------------------------------------------------------------|
|                         Statistics time  |                                                      496000000  |
|------------------------------------------------------------------------------------------------------------|
|                                                                                                            |
|                                               Discretization: 'fluidTPFA' / Selected sets (7500 elements)  |
|------------------------------------------------------------------------------------------------------------|
|                              statistics  |            min  |                average  |                max  |
|------------------------------------------|-----------------|-------------------------|---------------------|
|                           Pressure [Pa]  |   39856089.824  |                  7.599  |       51367844.277  |
|                     Delta pressure [Pa]  |   27356089.824  |                      /  |       38867844.277  |
|                         Temperature [K]  |         368.15  |              6.135e-05  |             368.15  |
|------------------------------------------|-----------------|-----------------------------------------------|
|         Total dynamic pore volume [rm3]  |            all  |                                  6096116.064  |
|         Phase dynamic pore volume [rm3]  |            gas  |                                       119209  |
|                                          |          water  |                                  5.97691e+06  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                   Total fluid mass [kg]  |            all  |                               5978216181.947  |
|                         Phase mass [kg]  |            gas  |                                  9.50193e+07  |
|                                          |          water  |                                   5.8832e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|      Trapped phase mass (metric 1) [kg]  |            gas  |                                  4.71814e+07  |
|                                          |          water  |                                  1.80049e+09  |
|  Non-trapped phase mass (metric 1) [kg]  |            gas  |                                  4.78379e+07  |
|                                          |          water  |                                  4.08271e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|     Immobile phase mass (metric 2) [kg]  |            gas  |                                            0  |
|                                          |          water  |                                            0  |
|       Mobile phase mass (metric 2) [kg]  |            gas  |                                  9.50193e+07  |
|                                          |          water  |                                   5.8832e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                     Component mass [kg]  |      gas / co2  |                                  9.50193e+07  |
|                                          |    gas / water  |                                            0  |
|                                          |    water / co2  |                                  7.33584e+07  |
|                                          |  water / water  |                                  5.80984e+09  |
|------------------------------------------------------------------------------------------------------------|
|                                                                                                            |
|                                          Discretization: 'fluidTPFA' / Element set: 'all' (7500 elements)  |
|------------------------------------------------------------------------------------------------------------|
|                              statistics  |            min  |                average  |                max  |
|------------------------------------------|-----------------|-------------------------|---------------------|
|                           Pressure [Pa]  |   39856089.824  |           45598543.119  |       51367844.277  |
|                     Delta pressure [Pa]  |   27356089.824  |                      /  |       38867844.277  |
|                         Temperature [K]  |         368.15  |                368.149  |             368.15  |
|------------------------------------------|-----------------|-----------------------------------------------|
|         Total dynamic pore volume [rm3]  |            all  |                                  6096116.064  |
|         Phase dynamic pore volume [rm3]  |            gas  |                                       119209  |
|                                          |          water  |                                  5.97691e+06  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                   Total fluid mass [kg]  |            all  |                               5978216181.947  |
|                         Phase mass [kg]  |            gas  |                                  9.50193e+07  |
|                                          |          water  |                                   5.8832e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|      Trapped phase mass (metric 1) [kg]  |            gas  |                                  4.71814e+07  |
|                                          |          water  |                                  1.80049e+09  |
|  Non-trapped phase mass (metric 1) [kg]  |            gas  |                                  4.78379e+07  |
|                                          |          water  |                                  4.08271e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|     Immobile phase mass (metric 2) [kg]  |            gas  |                                            0  |
|                                          |          water  |                                            0  |
|       Mobile phase mass (metric 2) [kg]  |            gas  |                                  9.50193e+07  |
|                                          |          water  |                                   5.8832e+09  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                     Component mass [kg]  |      gas / co2  |                                  9.50193e+07  |
|                                          |    gas / water  |                                            0  |
|                                          |    water / co2  |                                  7.33584e+07  |
|                                          |  water / water  |                                  5.80984e+09  |
|------------------------------------------------------------------------------------------------------------|
|                                                                                                            |
|                            Discretization: 'fluidTPFA' / Element set: 'injectorSurrounding' (25 elements)  |
|------------------------------------------------------------------------------------------------------------|
|                              statistics  |            min  |                average  |                max  |
|------------------------------------------|-----------------|-------------------------|---------------------|
|                           Pressure [Pa]  |   50203624.560  |           50359670.971  |       50515575.020  |
|                     Delta pressure [Pa]  |   37703624.560  |                      /  |       38015575.020  |
|                         Temperature [K]  |         368.15  |      368.1499906997449  |             368.15  |
|------------------------------------------|-----------------|-----------------------------------------------|
|         Total dynamic pore volume [rm3]  |            all  |                                    20363.237  |
|         Phase dynamic pore volume [rm3]  |            gas  |                                      1199.65  |
|                                          |          water  |                                      19163.6  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                   Total fluid mass [kg]  |            all  |                                 20103033.517  |
|                         Phase mass [kg]  |            gas  |                                  1.00122e+06  |
|                                          |          water  |                                  1.91018e+07  |
|------------------------------------------|-----------------|-----------------------------------------------|
|      Trapped phase mass (metric 1) [kg]  |            gas  |                                       842127  |
|                                          |          water  |                                  6.08927e+06  |
|  Non-trapped phase mass (metric 1) [kg]  |            gas  |                                       159097  |
|                                          |          water  |                                  1.30125e+07  |
|------------------------------------------|-----------------|-----------------------------------------------|
|     Immobile phase mass (metric 2) [kg]  |            gas  |                                            0  |
|                                          |          water  |                                            0  |
|       Mobile phase mass (metric 2) [kg]  |            gas  |                                  1.00122e+06  |
|                                          |          water  |                                  1.91018e+07  |
|------------------------------------------|-----------------|-----------------------------------------------|
|                     Component mass [kg]  |      gas / co2  |                                  1.00122e+06  |
|                                          |    gas / water  |                                            0  |
|                                          |    water / co2  |                                  1.18866e+06  |
|                                          |  water / water  |                                  1.79132e+07  |
--------------------------------------------------------------------------------------------------------------

The infrastructure proposed here can be re-used for new statistics components which would process cell elements, and is implemented at the StatisticsAggregatorBase level, introduced in the PR #3836 .

The parameter has been used in the simpleCo2InjTutorial example to test that functionnality.

…onents' into feature/rey/arbitrary-regions-stats

…ement sets

…y/arbitrary-regions-stats

…nor string_view replacement)

dkachuma

Very useful feature.
But I would keep it simple and have a single output for each statistics node i.e. only report the statistics for all the selected sets. This would keep the csv simple and directly loadable with numpy for plotting. If the user wants statistics for another set, they can add another statistics xml element.

dkachuma · 2026-04-06T15:57:12Z

src/coreComponents/physicsSolvers/fluidFlow/SinglePhaseStatisticsTask.cpp

  TableLayout tableLayout( {
        TableLayout::Column( GEOS_FMT( "Time [{}]", units::getSymbol( units::Unit::Time ))),
-        TableLayout::Column( "Region" ), // TODO : mention this change in PR description
+        TableLayout::Column( "Set" ),


Does that mean all the sets have data written in the same csv? Usually we want to plot these values and having to filter per set is quite tedious. Can we have a separate file for each set?

Separating in per-set files is not an issue, I would just like to ask why it is problematic to have every sets in one file, and not problematic to have every region in one file. Because of the post-processing / paraview tools?
I remember that at some point we had one CSV for all region, sometimes resulting in a lot of files, and I got asked to merge them in one file.

I didn't realise we also have different regions in the same file. I always assumed the statistics are written out to a different file per region. I didn't know these had ben merged. With different files way it was easy to load and plot for each region. Of course we can always filter if need be.

…onents' into feature/rey/arbitrary-regions-stats

MelReyCG added 24 commits March 12, 2026 16:43

Merge remote-tracking branch 'origin/bugfix/rey/split-statistics-comp…

4ec0e13

…onents' into feature/rey/arbitrary-regions-stats

🚧 added user inputs to define the general concept

2226319

🐛 wrapper params fix

d362afa

📝 missing docs

2ab71be

♻️ method should be private

876b54b

♻️ follow conventions

db60577

🚧 add set selection to stat aggregators

db9049b

✅ add a test case

5271c27

📦 schema update

0f6fb9c

Merge remote-tracking branch 'origin/bugfix/rey/split-statistics-comp…

3143d5c

…onents' into feature/rey/arbitrary-regions-stats

🐛 fix merge issue

605e02f

📝more precise docs

aa42af4

✅ test fix (5x5 selection verified)

39f9fb0

📝 added sets data structure docs + show which name is dynamic

86499b8

🚧 infrastructure to support statistics processing on element sets

dda3ac6

🚧 infrastructure to support statistics aggregation of intersecting el…

d30b810

…ement sets

✨ implemented statistics on sets

1814382

✨ smartly show different levels of stats (if needed / requested)

d78bae2

✨ added elements count in log

9778ad7

Merge branch 'bugfix/rey/split-statistics-components' into feature/re…

d16c26c

…y/arbitrary-regions-stats

🐛 wrong stats shown at set level

3265e39

♻️ naming & explaining comments

5b328ba

✅ add sets statistics to integrated tests

da67ced

⚰️ useless comments

a789e0c

MelReyCG self-assigned this Mar 26, 2026

MelReyCG requested review from herve-gross, jhuang2601 and rrsettgast as code owners March 26, 2026 09:18

MelReyCG added the flag: ready for review label Mar 26, 2026

MelReyCG requested a review from dkachuma as a code owner March 26, 2026 09:18

MelReyCG requested review from OmarDuran and tjb-ltk as code owners March 26, 2026 09:18

📝 docs adjustments

bb3e106

MelReyCG changed the title ~~feat: Adding statistics for given mesh element sets~~ feat: Adding flow statistics for arbitrary mesh element sets Mar 26, 2026

MelReyCG added 3 commits March 26, 2026 11:29

🐛 fix set stats example

3c16d9c

📦 schema

2a0e64e

🐛 correct way to take into account compound sets over MPI ranks (+ mi…

c8544d1

…nor string_view replacement)

MelReyCG changed the title ~~feat: Adding flow statistics for arbitrary mesh element sets~~ feat: Adding flow statistics for arbitrary mesh cell element sets Apr 1, 2026

dkachuma approved these changes Apr 6, 2026

View reviewed changes

MelReyCG added 3 commits April 8, 2026 14:46

📝 verified stats time

8cbc7e1

Merge remote-tracking branch 'origin/bugfix/rey/split-statistics-comp…

42588e1

…onents' into feature/rey/arbitrary-regions-stats

📝 updated datarepo docs graph

56cc33a

MelReyCG added the flag: requires rebaseline Requires rebaseline branch in integratedTests label Apr 8, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding flow statistics for arbitrary mesh cell element sets#4005

feat: Adding flow statistics for arbitrary mesh cell element sets#4005
MelReyCG wants to merge 31 commits intobugfix/rey/split-statistics-componentsfrom
feature/rey/arbitrary-regions-stats

MelReyCG commented Mar 26, 2026 •

edited

Loading

Uh oh!

dkachuma left a comment

Uh oh!

dkachuma Apr 6, 2026

Uh oh!

MelReyCG Apr 7, 2026 •

edited

Loading

Uh oh!

dkachuma Apr 7, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

MelReyCG commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dkachuma left a comment

Choose a reason for hiding this comment

Uh oh!

dkachuma Apr 6, 2026

Choose a reason for hiding this comment

Uh oh!

MelReyCG Apr 7, 2026 • 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!

dkachuma Apr 7, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MelReyCG commented Mar 26, 2026 •

edited

Loading

MelReyCG Apr 7, 2026 •

edited

Loading