feat: Adding log parts #3019

arng40 · 2024-03-04T10:32:39Z

This PR aim to improve the readibility of the logs by adding log separation the differents parts of the log and
the first step for displaying specific log or timestep we want.

The log separation identified are

Input Initialisation : ProblemManager::postInputInitializationRecursive();
Mesh generation : ProblemManager::generateMesh();
NumericalMethods: ProblemManager::applyNumericalMethods();
Mesh data registration : ProblemManager::egisterDataOnMeshRecursive();
Group & subgroups initialization functions : ProblemManager::initialize();
Each cycle time-step : EventManager::run()
Cleanup : basicCleanup()

Example of an input :

######################################################################
##                             TIMESTEP                             ##
######################################################################
##  - Time       : 00h00m00s out of 1d, 03h46m40s (0% completed)    ##
##                 0 s / 100000 s                                   ##
##  - Delta Time : 01h23m20s (5000 s)                               ##
##  - Cycle      : 0                                                ##
##                                                                  ##

    Attempt:  0, ConfigurationIter:  0, NewtonIter:  0
        ( Rflow ) = ( 4.82e-04 )        ( Rwell ) = ( 4.74e-03 )        ( R ) = ( 4.76e-03 )
        Last LinSolve(iter,res) = (   1, 1.64e-11 )
        compositionalMultiphaseFlow: Max pressure change = 19297.019 Pa (before scaling)
        compositionalMultiphaseFlow: Max component density change = 0.346 kg/m3 (before scaling)
        reservoirSystem: Global solution scaling factor = 1
        compositionalMultiphaseFlow: Max phase volume fraction change = 0.0004
[...]
Rank 0: Writing out restart file at ./staircase_co2_wells_3d_restart_000000004/rank_0000000.hdf5

##                             TIMESTEP                             ##
######################################################################

…e-layout

…dudes/table-layout

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

…nto feature/dudes/table-layout

… pvt-logs-cp

…e-layout

…EV/GEOS into feature/dudes/section-log

MelReyCG · 2024-10-31T09:21:55Z

src/coreComponents/common/format/table/TableLayout.hpp

@@ -48,7 +48,7 @@ class TableLayout
  /**
   * @brief Enumeration for table sections.
   */
-  enum Section { header, values };
+  enum LogPart { header, values };


I don't think you really would like to rename this enum (at least, not to LogPart).

MelReyCG · 2024-10-31T09:37:17Z

src/coreComponents/fileIO/logPart/LogPart.hpp

+  /**
+   * @brief Draw the first part of the section. It include the title and optionnaly, the description(s);
+   * @param os An output stream (by default, std::cout)
+   */
+  void begin( std::ostream & os = std::cout );
+
+  /**
+   * @brief Draw the last part of the section. It include the title
+   * @param oss An output stream (by default, std::cout)
+   */
+  void end( std::ostream & oss = std::cout ) const;


Here, we seem to be able to begin() on multiple output targets. So, to ensure that the content is the same everywhere, I would expect begin() to be const, and internal values like m_sectionWidth to be computed when assessors like addDescription() are used.

Side note: addEndDescription() has no effect on m_sectionWidth, is it the desired behavior?

after addDescription() we call void formatAndInsertDescriptions() where we check m_sectionWidth

MelReyCG · 2024-10-31T09:44:27Z

src/coreComponents/fileIO/logPart/LogPart.hpp

+  void begin( std::ostream & os = std::cout );
+
+  /**
+   * @brief Draw the last part of the section. It include the title


Suggested change

* @brief Draw the last part of the section. It include the title

* @brief Draw the last part of the section. It include the title and optionnaly, the end description(s).

MelReyCG · 2024-10-31T09:45:32Z

src/coreComponents/fileIO/logPart/LogPart.hpp

+   * @brief Set the minimal width of a row
+   * @param minWidth The minimal width of the table
+   */
+  void setMinWidth( integer const & minWidth );


a good feature in the future would be to have a setMaxWidth() with line wrapping, to ensure that a section cannot be too large.

I could do this in another PR

MelReyCG · 2024-10-31T09:46:50Z

src/coreComponents/fileIO/logPart/LogPart.hpp

+  /// description border margin
+  static constexpr integer m_marginBorder = 2;
+  /// numbers of character used as border
+  static constexpr integer m_nbBorderChar = 2;


Please add the # character as a centralized constant here.

MelReyCG · 2024-10-31T10:14:08Z

src/coreComponents/fileIO/logPart/LogPart.cpp

+  m_sectionTitle( string( sectionTitle ) ),
+  m_sectionWidth( sectionTitle.length() )
+{
+  m_footerTitle = GEOS_FMT( "End : {}", m_sectionTitle );


If I was you, I would add a updateLayout() private method that takes in parameter every text size like this one, the description lines, the m_sectionTitle, and update m_rowMinWidth whenever a larger size is found. I would prevent any side case to produce oversized lines.

please use the term part as a prefix for your variables (if you really need one), section is now irrelevant.

What do you think of replacing "End : {}" by "End of {}"

MelReyCG · 2024-10-31T10:21:01Z

src/coreComponents/fileIO/logPart/LogPart.cpp

+                                           string_view name,
+                                           std::vector< string > const & values )
+{
+  string const nameFormatted =  GEOS_FMT( "- {}: ", string( name ));


I think that it is the responsability of the class user to add those "- " at the start of their texts (imagine if you only have one description).

if we have one description we will not have the "- ", it's only for mutiple values in the description

MelReyCG · 2024-10-31T10:24:25Z

src/coreComponents/events/EventManager.cpp

@@ -170,8 +170,9 @@ bool EventManager::run( DomainPartition & domain )
      m_dt = dt_global;
 #endif
    }
-
-    outputTime();
+    LogPart logPart( "TIMESTEP START" );


I would name this part "TIMESTEP" or "Timestep no. {}". It is strange to see "End : TIMESTEP START" at its end.

MelReyCG · 2024-11-07T15:34:25Z

Can you share a full log generated after this PR?

paveltomin

just check what happened with schema/docs changes

…ion-log

arng40 added 30 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

first version Section

e4fea40

remove unused code

f67e3d9

function min width added

14920ef

MelReyCG changed the title ~~Log part added~~ feat: Adding log parts Oct 17, 2024

MelReyCG removed the flag: ready for review label Oct 17, 2024

renaming, const value, ...

aada6fc

arng40 requested a review from MelReyCG October 17, 2024 12:50

arng40 and others added 6 commits October 17, 2024 14:55

test fix + doxygen

a6acda4

uncrustify

a60e764

Merge branch 'develop' into feature/dudes/section-log

364cf17

xsd

27761a4

Merge branch 'feature/dudes/section-log' of https://github.com/GEOS-D…

20bb6bc

…EV/GEOS into feature/dudes/section-log

refacto

2ec377e

MelReyCG added ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI flag: ready for review labels Oct 31, 2024

Merge branch 'develop' into feature/dudes/section-log

8b29687

MelReyCG requested changes Oct 31, 2024

View reviewed changes

arng40 removed ci: run CUDA builds Allows to triggers (costly) CUDA jobs ci: run integrated tests Allows to run the integrated tests in GEOS CI labels Nov 6, 2024

arng40 added 3 commits November 6, 2024 16:03

renaming and simpl

29e046e

uncrustify

6440331

revert

447aaf2

paveltomin approved these changes Nov 11, 2024

View reviewed changes

arng40 added 4 commits November 19, 2024 09:15

rename

38815d9

rename

5d3d677

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

aea7a98

…ion-log

struture update

ca632ff

arng40 requested review from MelReyCG December 10, 2024 10:55

arng40 added 2 commits January 10, 2025 10:53

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

669c92e

…ion-log

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

fb35659

…ion-log

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Adding log parts #3019

feat: Adding log parts #3019

arng40 commented Mar 4, 2024 •

edited

Loading

MelReyCG Oct 31, 2024

arng40 Nov 6, 2024

MelReyCG Oct 31, 2024

arng40 Nov 6, 2024

MelReyCG Oct 31, 2024

MelReyCG Oct 31, 2024

arng40 Nov 6, 2024

MelReyCG Oct 31, 2024

arng40 Nov 6, 2024

MelReyCG Oct 31, 2024

MelReyCG Oct 31, 2024

arng40 Nov 6, 2024

MelReyCG Oct 31, 2024

MelReyCG commented Nov 7, 2024

paveltomin left a comment

	* @brief Draw the last part of the section. It include the title
	* @brief Draw the last part of the section. It include the title and optionnaly, the end description(s).

feat: Adding log parts #3019

Are you sure you want to change the base?

feat: Adding log parts #3019

Conversation

arng40 commented Mar 4, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MelReyCG commented Nov 7, 2024

paveltomin left a comment

Choose a reason for hiding this comment

arng40 commented Mar 4, 2024 •

edited

Loading