PVT Tables logging improvements #3003

arng40 · 2024-02-27T14:34:18Z

This PR follows the #2984 that aim to standardize logs.
Currently PVT tables are only accessible throught .csv files.
In this PR, logs will indicate which csv files are generated along with their associate path

CSV Generated to inputFiles/compositionalMultiphaseWell/test.xml/fluid1_phaseModel1_PhillipsBrineDensity_table.csv :
---------------------------------------------------------------------------------------
|                    fluid1_phaseModel1_PhillipsBrineDensity_table                    |
---------------------------------------------------------------------------------------
|  The fluid1_phaseModel1_PhillipsBrineDensity_table PVT table exceeding 500 rows.    |
|  To visualize the tables, go to the generated csv                                   |
---------------------------------------------------------------------------------------

In addition to csv files, PVT Tables with dimensions n <= 2 can be written in log by meetings 2 conditions :

have sufficient log lovel
Rows in the table < 500 lines

CSV Generated to inputFiles/compositionalMultiphaseWell/test.xml/fluid1_phaseModel1_PhillipsBrineViscosity_table.csv
---------------------------------------------------------
|    fluid1_phaseModel1_PhillipsBrineViscosity_table    |
---------------------------------------------------------
|    temperature [C]     |       viscosity [Pa*s]       |
---------------------------------------------------------
|          0.01          |          0.0017914           |
|           10           |           0.001306           |
|           20           |          0.0010016           |
|           25           |           0.00089            |
|           30           |          0.0007972           |
---------------------------------------------------------

…e-layout

…dudes/table-layout

…feature/dudes/table-layout" This reverts commit 8f74cfa.

…nto feature/dudes/table-layout

… pvt-logs-cp

…e-layout

MelReyCG

Some refactor suggestions

MelReyCG · 2024-02-28T09:37:48Z

src/coreComponents/constitutive/fluid/multifluid/CO2Brine/functions/BrineEnthalpy.cpp

+
+  if( printInCsv || ( printInLog && m_CO2EnthalpyTable->numDimensions() >= 3 ) )
+  {
+    m_CO2EnthalpyTable->printInCSV( m_CO2EnthalpyTable->getName() );
+    m_brineEnthalpyTable->printInCSV( m_brineEnthalpyTable->getName() );
+  }
+  if( printInLog &&  m_CO2EnthalpyTable->numDimensions() <= 2 )
  {
-    m_CO2EnthalpyTable->print( m_CO2EnthalpyTable->getName() );
-    m_brineEnthalpyTable->print( m_brineEnthalpyTable->getName() );
+    m_CO2EnthalpyTable->printInLog( m_CO2EnthalpyTable->getName() );
+    m_brineEnthalpyTable->printInLog( m_brineEnthalpyTable->getName() );
  }


Here, you are assuming that m_CO2EnthalpyTable and m_brineEnthalpyTable have the same dimensions. m_CO2EnthalpyTable is "choosing" the formatting for m_brineEnthalpyTable.
But this assomption is wrong, they does not have the same layout !

You could do two if for each tables, or you could create a function that factorize this choice, something like TableFunction::print( bool printInCsv, bool printInLog ).
Factorizing can be a good thing as there we need 13 of these conditions.

MelReyCG · 2024-02-28T09:49:23Z

src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp

+  bool isClone = true;
+  if( getParent().getName() == "Constitutive" )
+  {
+    string sectionOutput;
+    string sectionName = "Section : PVT Table generation";
+
+    sectionOutput = GEOS_FMT( "\n{:=^{}}\n", "=", sectionName.size() + 5 );
+    sectionOutput += GEOS_FMT( "{:^{}}\n", sectionName, sectionName.size() + 5 );
+    sectionOutput += GEOS_FMT( "{:=^{}}\n\n", "=", sectionName.size() + 5 );
+
+    std::cout << sectionOutput;
+
+    isClone = false;
+  }


Can we do this job without this if ? The relation with the "Constitutive" parent is external to this class. If possible, I think that doing with your isClone parameter is clearer and more maintainable.

MelReyCG · 2024-02-28T15:06:13Z

src/coreComponents/constitutive/fluid/multifluid/CO2Brine/CO2BrineFluid.cpp

+    string sectionName = "Section : PVT Table generation";
+
+    sectionOutput = GEOS_FMT( "\n{:=^{}}\n", "=", sectionName.size() + 5 );
+    sectionOutput += GEOS_FMT( "{:^{}}\n", sectionName, sectionName.size() + 5 );
+    sectionOutput += GEOS_FMT( "{:=^{}}\n\n", "=", sectionName.size() + 5 );
+
+    std::cout << sectionOutput;


Just a reminder to keep that in mind, those sections layout will need to be factorized in a dedicated PR.

…e-layout

… pvt-logs-cp

…e-layout

… pvt-logs-cp

…vt-logs-cp

codecov · 2024-05-27T10:26:45Z

Codecov Report

Attention: Patch coverage is 90.02079% with 48 lines in your changes missing coverage. Please review.

Project coverage is 53.76%. Comparing base (d3783ad) to head (ac0cec8).
Report is 99 commits behind head on develop.

Files	Patch %	Lines
...reComponents/mesh/generators/WellGeneratorBase.cpp	4.00%	24 Missing ⚠️
src/coreComponents/fileIO/Table/TableFormatter.cpp	97.05%	5 Missing ⚠️
src/coreComponents/common/DataTypes.hpp	0.00%	4 Missing ⚠️
src/coreComponents/fileIO/Table/TableData.cpp	87.87%	4 Missing ⚠️
...oreComponents/fileIO/Table/unitTests/testTable.cpp	96.73%	3 Missing ⚠️
...e/fluid/multifluid/reactive/ReactiveBrineFluid.cpp	81.81%	2 Missing ⚠️
src/coreComponents/fileIO/Table/TableLayout.cpp	92.00%	2 Missing ⚠️
...tTests/constitutiveTests/testCO2BrinePVTModels.cpp	50.00%	2 Missing ⚠️
src/coreComponents/functions/TableFunction.cpp	98.00%	1 Missing ⚠️
...s/constitutiveTests/testCO2SpycherPruessModels.cpp	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff             @@
##           develop    #3003      +/-   ##
===========================================
+ Coverage    53.57%   53.76%   +0.19%     
===========================================
  Files         1003     1010       +7     
  Lines        85297    85695     +398     
===========================================
+ Hits         45695    46075     +380     
- Misses       39602    39620      +18

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

arng40 added 27 commits February 9, 2024 16:11

Table function creation

751a919

add title off case

c84a06e

setMargin function added

57bc055

add comments + test for tiny table

6255f9b

value default optionnal variable changed

601a2c5

Merge remote-tracking branch 'origin/develop' into feature/dudes/tabl…

59a9bc8

…e-layout

add log to wellGeneratorBase

677fdb6

uncrustify + missing doc

623b6ad

first review with correction

37dc5dd

constness modification, doc/test updated

8678fc0

const declaration updated

9475286

doc + minor restructuring

1320651

doc + method for row from vector

f78bd83

clean code + doc + add test for rows from vector

294f075

doc updated

36dd7a4

Merge commit 'c11ad8ecd2d0d0aba5cd0661eb6e72951252409d' into feature/…

8f74cfa

…dudes/table-layout

Revert "Merge commit 'c11ad8ecd2d0d0aba5cd0661eb6e72951252409d' into …

ebb9fc0

…feature/dudes/table-layout" This reverts commit 8f74cfa.

revert last merge and Merge remote-tracking branch 'origin/develop' i…

cb41359

…nto feature/dudes/table-layout

Merge remote-tracking branch 'origin/feature/dudes/table-layout' into…

22659ec

… pvt-logs-cp

begin pvt tables logs - add write in log bool

ff37ac9

duplication log & csv fixed

628f56b

CI correction ( uncrustify, missing doc )

e11a2bf

optionnal added to datatype

a8f9271

update doxygen for ci

9ff17b9

more logs added

d90c8b5

remove static_assert + constness

958d542

Merge remote-tracking branch 'origin/develop' into feature/dudes/tabl…

550ca26

…e-layout

MelReyCG requested changes Feb 28, 2024

View reviewed changes

MelReyCG reviewed Feb 28, 2024

View reviewed changes

MelReyCG assigned arng40 Feb 29, 2024

arng40 added 15 commits April 12, 2024 15:31

TableFormatter refacto + clean up

24f92d9

uncrustify

5a70c33

small doc update

95f3a9d

some error management update

77351b9

renaming & simplifying

da67c05

add case for fill all column in case of table 2D

a9612bb

Merge remote-tracking branch 'origin/develop' into feature/dudes/tabl…

0f1bbe2

…e-layout

simplification

89f859a

code optimization

ef5085c

remove useless std::move

294db78

refacto build separator + reviews

9f23f62

final review correction

9809699

Merge remote-tracking branch 'origin/feature/dudes/table-layout' into…

66895d6

… pvt-logs-cp

method display layout added

46a6abe

small correction after merge

9de9d63

arng40 marked this pull request as ready for review April 24, 2024 15:32

arng40 added 10 commits May 13, 2024 14:07

review correction #1

fe80c59

variables renamed

abb994e

uncrustify + doc

c851b38

doc

0ae0c74

Merge remote-tracking branch 'origin/develop' into feature/dudes/tabl…

86c0130

…e-layout

remove unused code

e9639ea

Merge remote-tracking branch 'origin/feature/dudes/table-layout' into…

a48feb3

… pvt-logs-cp

syntax correction

924d955

Merge branch 'pvt-logs-cp' of https://github.com/GEOS-DEV/GEOS into p…

5b530f0

…vt-logs-cp

variable correction

ac0cec8

arng40 closed this May 29, 2024

arng40 deleted the pvt-logs-cp branch May 29, 2024 08:42

MelReyCG removed a link to an issue Jun 5, 2024

Add PVT data tables in the log (density, saturation...), #3013

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PVT Tables logging improvements #3003

PVT Tables logging improvements #3003

arng40 commented Feb 27, 2024 •

edited by MelReyCG

Loading

MelReyCG left a comment

MelReyCG Feb 28, 2024

MelReyCG Feb 28, 2024

MelReyCG Feb 28, 2024

codecov bot commented May 27, 2024 •

edited

Loading

PVT Tables logging improvements #3003

PVT Tables logging improvements #3003

Conversation

arng40 commented Feb 27, 2024 • edited by MelReyCG Loading

MelReyCG left a comment

Choose a reason for hiding this comment

MelReyCG Feb 28, 2024

Choose a reason for hiding this comment

MelReyCG Feb 28, 2024

Choose a reason for hiding this comment

MelReyCG Feb 28, 2024

Choose a reason for hiding this comment

codecov bot commented May 27, 2024 • edited Loading

Codecov Report

arng40 commented Feb 27, 2024 •

edited by MelReyCG

Loading

codecov bot commented May 27, 2024 •

edited

Loading