Adding logLevel documentation #3089

arng40 · 2024-04-23T08:52:43Z

Currently, we have this output in all Group documentation files:

I.e. SolidMechanics_LagrangianFEM.rsts.rst :.rst` :

========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== 
Name                      Type                         Default    Description                                                                                                                                                                                                                                                                                                              
========================= ============================ ========== ======================================================================================================================================================================================================================================================================================================================== 
[...]                                                                                                                                                                                                               
logLevel                  integer                      0          Log level     
[...]

This PR aims to add more context to the different logLevels of GEOS :

I.e. SolidMechanics_LagrangianFEM.rsts.rst :



========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= 
Name                      Type                                                   Default         Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
========================= ====================================================== =============== ======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================= 
cflFactor                 real64                                                 0.5             Factor to apply to the `CFL condition <http://en.wikipedia.org/wiki/Courant-Friedrichs-Lewy_condition>`_ when calculating the maximum allowable time step. Values should be in the interval (0,1]                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
contactRelationName       groupNameRef                                           NOCONTACT       Name of contact relation to enforce constraints on fracture boundary.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
discretization            groupNameRef                                           required        Name of discretization object (defined in the :ref:`NumericalMethodsManager`) to use for this solver. For instance, if this is a Finite Element Solver, the name of a :ref:`FiniteElement` should be specified. If this is a Finite Volume Method, the name of a :ref:`FiniteVolume` discretization should be specified.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                
initialDt                 real64                                                 1e+99           Initial time-step value required by the solver to the event manager.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
logLevel                  integer                                                0               | Sets the level of information to write in the standard output (the console typically).                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                                                                                 | A level of 0 outputs minimal information, higher levels require more.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
                                                                                                 | logLevel >= 1                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 |  - Information on line search                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 |  - Information on global solution scaling factor                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                                                 |  - Information on the timestep                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                 |  - Print residual norm                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                                                                                 | logLevel >= 1 and configuration didn't converge                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                 |  - Information about testing new configuration and print the time step                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                                                                                 | logLevel >= 1 and incorrect solution                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                 |  - Information about line search failed                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                 | logLevel >= 1 and linear system                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         
                                                                                                 |  - Information on number of iterations and residual reduction                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 | logLevel >= 1 and non linear system                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                 |  - Information on each newton Iteration                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 
                                                                                                 | logLevel >= 1 and residual norm above the max allowed residual norm                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     
                                                                                                 |  - Indicate allowed residual norm                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       
                                                                                                 | logLevel >= 2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 |  - Output to screen the assembled linear system and solutions (matrices and vectors)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                 |  - Infos on residuals values                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            
                                                                                                 | logLevel >= 2 and target set is empty                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   
                                                                                                 |  - Warning about boundary conditions                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                                                                                 | logLevel >= 3                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           
                                                                                                 |  - Output to file the assembled linear system and solutions (matrices and vectors)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
========================= ================== ======== ==================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

MelReyCG · 2024-05-21T08:36:59Z

src/coreComponents/constitutive/relativePermeability/RelpermDriver.cpp

+  appendLogLevel( { "logLevel >= 1", "Infos about RelpermDriver" } );
+  appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } );


I would have expect either this syntax:

appendLogLevel( { "logLevel >= 1", "Infos about RelpermDriver" }, { "logLevel >= 1", "Indicate if the internal results are consistent" } );

Or this one

appendLogLevel( "logLevel >= 1", "Infos about RelpermDriver" ); appendLogLevel( "logLevel >= 1", "Indicate if the internal results are consistent" );

The second one is more convenient

MelReyCG · 2024-05-21T08:39:14Z

src/coreComponents/dataRepository/Group.cpp

+  try
+  {
+    WrapperBase & wrapper = getWrapperBase( logLevelName );
+    appendLogLevelToWrapper( wrapper, log );
+  }catch( std::domain_error const & )
+  {
+    WrapperBase & wrapper = registerWrapper( logLevelName, &m_logLevel );
+    enableLogLevelInput();
+    appendLogLevelToWrapper( wrapper, log );
+  }


In this project, try-catch is for adding more info to errors, not to recover from an erroneous state.
Use a if-else syntax.

MelReyCG · 2024-05-21T08:57:41Z

src/coreComponents/dataRepository/Group.hpp

+   * @brief Append a log level/description to the description of the wrapped object
+   * @param log An entry (log level/ log Description) to append
+   */
+  void appendLogLevel( std::pair< const std::string, const std::string > log );


appendLogLevelDescription( string_view loggingCondition, string_view caseDescription ) ?

MelReyCG · 2024-05-21T08:59:36Z

src/coreComponents/dataRepository/WrapperBase.hpp

+  /// Map for building the log level string for each wrapper
+  /// key : logLevel, values : description(s) for a level
+  std::map< std::string, std::vector< std::string > > m_logLevelsDescriptions;


Only one logLevel per Group = only one map per Group
Every wrapper should not have logLevel functionnalities, Group should.
Those method & attributes you added in Wrapper are not at the right place.

MelReyCG

Blocking comments

…level-doc

Add a way to expend the description of a wrapper

fbe6085

MelReyCG changed the title ~~Add a way to expend the description of a wrapper~~ Adding logLevel documentation Apr 24, 2024

arng40 added 4 commits April 25, 2024 14:33

loglevel first iteration

de6c78e

log level documentation sorted

55ef101

log-level doc correction

b55bb04

enable log level + small corretion appendLogLevel

d333678

MelReyCG requested changes May 21, 2024

View reviewed changes

melvin review ( archi updated )

12da842

MelReyCG assigned arng40 May 21, 2024

arng40 added 9 commits May 21, 2024 17:18

renaming / constness / refacto

65d8ae9

uncrustify

f957cea

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

69f94df

…level-doc

add missing log

8de5703

update comment

a720b27

adding new doc + update

dcf4fa7

update solver log

78badfa

log message correction

0c32b52

doc corrections

ed7a285

arng40 marked this pull request as ready for review May 27, 2024 07:42

arng40 requested review from ryar9534 and MelReyCG May 27, 2024 07:45

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding logLevel documentation #3089

Adding logLevel documentation #3089

arng40 commented Apr 23, 2024 •

edited

MelReyCG May 21, 2024

arng40 May 21, 2024

MelReyCG May 21, 2024

MelReyCG May 21, 2024

MelReyCG May 21, 2024

MelReyCG left a comment

		appendLogLevel( { "logLevel >= 1", "Infos about RelpermDriver" } );
		appendLogLevel( { "logLevel >= 1", "Indicate if the internal results are consistent" } );

Adding logLevel documentation #3089

Are you sure you want to change the base?

Adding logLevel documentation #3089

Conversation

arng40 commented Apr 23, 2024 • edited

MelReyCG May 21, 2024

Choose a reason for hiding this comment

arng40 May 21, 2024

Choose a reason for hiding this comment

MelReyCG May 21, 2024

Choose a reason for hiding this comment

MelReyCG May 21, 2024

Choose a reason for hiding this comment

MelReyCG May 21, 2024

Choose a reason for hiding this comment

MelReyCG left a comment

Choose a reason for hiding this comment

arng40 commented Apr 23, 2024 •

edited