docs: Log level documentation on remaining package

src/coreComponents/common/logger/Logger.hpp

@@ -454,44 +454,6 @@
  */
 #define GEOS_ASSERT_GE( lhs, rhs ) GEOS_ASSERT_GE_MSG( lhs, rhs, "" )
 
-/**
- * @brief Macro used to turn on/off a function based on the log level.
- * @param[in] minLevel Minimum log level
- * @param[in] fn Function to filter
- */
-#define GEOS_LOG_LEVEL_FN( minLevel, fn )                                      \
-  do {                                                                         \
-    if( this->getLogLevel() >= minLevel )                                      \
-    {                                                                          \
-      fn;                                                                      \
-    }                                                                          \
-  } while( false )
-
-/**
- * @brief Output messages based on current Group's log level.
- * @param[in] minLevel minimum log level
- * @param[in] msg a message to log (any expression that can be stream inserted)
- * @deprecated Will be replaced by GEOS_LOG_LEVEL_INFO
- */
-#define GEOS_LOG_LEVEL( minLevel, msg ) GEOS_LOG_IF( this->getLogLevel() >= minLevel, msg );
-
-/**
- * @brief Output messages (only on rank 0) based on current Group's log level.
- * @param[in] minLevel minimum log level
- * @param[in] msg a message to log (any expression that can be stream inserted)
- * @deprecated Will be replaced by GEOS_LOG_LEVEL_INFO_RANK_0
- */
-#define GEOS_LOG_LEVEL_RANK_0( minLevel, msg ) GEOS_LOG_RANK_0_IF( this->getLogLevel() >= minLevel, msg )
-
-/**
- * @brief Output messages (with one line per rank) based on current Group's log level.
- * @param[in] minLevel minimum log level
- * @param[in] msg a message to log (any expression that can be stream inserted)
- * @deprecated Will be replaced by GEOS_LOG_LEVEL_INFO_BY_RANK
- */
-#define GEOS_LOG_LEVEL_BY_RANK( minLevel, msg ) GEOS_LOG_RANK_IF( this->getLogLevel() >= minLevel, msg )
-
-
 namespace geos
 {
 

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

@@ -86,8 +86,6 @@ CO2BrineFluid< PHASE1, PHASE2, FLASH >::
 CO2BrineFluid( string const & name, Group * const parent ):
   MultiFluidBase( name, parent )
 {
-  enableLogLevelInput();
-
   registerWrapper( viewKeyStruct::phasePVTParaFilesString(), &m_phasePVTParaFiles ).
     setInputFlag( InputFlags::REQUIRED ).
     setRestartFlags( RestartFlags::NO_WRITE ).

src/coreComponents/constitutiveDrivers/fluid/multiFluid/PVTDriver.cpp

@@ -41,7 +41,6 @@ PVTDriver::PVTDriver( const string & name,
                       Group * const parent ):
   TaskBase( name, parent )
 {
-  enableLogLevelInput();
 
   registerWrapper( viewKeyStruct::fluidNameString(), &m_fluidName ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).

src/coreComponents/constitutiveDrivers/fluid/multiFluid/reactive/ReactiveFluidDriver.cpp

@@ -32,8 +32,6 @@ ReactiveFluidDriver::ReactiveFluidDriver( const string & name,
                                           Group * const parent ):
   TaskBase( name, parent )
 {
-  enableLogLevelInput();
-
   registerWrapper( viewKeyStruct::fluidNameString(), &m_fluidName ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).
     setInputFlag( InputFlags::REQUIRED ).

src/coreComponents/constitutiveDrivers/relativePermeability/RelpermDriver.cpp

@@ -33,8 +33,6 @@ RelpermDriver::RelpermDriver( const geos::string & name,
   :
   TaskBase( name, parent )
 {
-  enableLogLevelInput();
-
   registerWrapper( viewKeyStruct::relpermNameString(), &m_relpermName ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).
     setInputFlag( InputFlags::REQUIRED ).

src/coreComponents/constitutiveDrivers/solid/TriaxialDriver.cpp

@@ -29,7 +29,6 @@ TriaxialDriver::TriaxialDriver( const string & name,
                                 Group * const parent ):
   TaskBase( name, parent )
 {
-  enableLogLevelInput();
 
   registerWrapper( viewKeyStruct::solidMaterialNameString(), &m_solidMaterialName ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).

src/coreComponents/dataRepository/Group.cpp

@@ -651,15 +651,6 @@ void Group::postRestartInitializationRecursive()
   postRestartInitialization();
 }
 
-void Group::enableLogLevelInput()
-{
-  // TODO : Improve the Log Level description to clearly assign a usecase per log level (incoming PR).
-  registerWrapper( viewKeyStruct::logLevelString(), &m_logLevel ).
-    setApplyDefaultValue( 0 ).
-    setInputFlag( InputFlags::OPTIONAL ).
-    setDescription( "Log level" );
-}
-
 Group const & Group::getBaseGroupByPath( string const & path ) const
 {
   Group const * currentGroup = this;

src/coreComponents/dataRepository/Group.hpp

@@ -1492,11 +1492,6 @@ class Group
    */
   void loadFromConduit();
 
-  /**
-   * @deprecated will be remove and replace by addLogLevel
-   */
-  void enableLogLevelInput();
-
   /**
    * @brief Set verbosity level
    * @param logLevel new verbosity level value

src/coreComponents/dataRepository/LogLevelsRegistry.cpp

@@ -27,7 +27,7 @@ string LogLevelsRegistry::buildLogLevelDescription() const
 {
   std::ostringstream description;
   description << "Sets the level of information to write in the standard output (the console typically).\n"
-                 "Level 0 outputs no specific information for this solver. Higher levels require more outputs.";
+                 "Information output from lower logLevels is added with the desired log level";
   for( auto const & [logLevel, logDescriptions] : m_logLevelsDescriptions )
   {
     description << GEOS_FMT( "\n{}\n", logLevel );

src/coreComponents/dataRepository/docs/LogLevel.rst

@@ -0,0 +1,45 @@
+.. _LogLevelDocumentation:
+
+Log levels documentation
+========================
+
+Add a log level
+---------------
+
+To add a log level, you must respect the following structure and add it to the appropriate ``LogLevelsInfos.hpp`` :
+
+.. code-block:: c++
+
+    struct MyMessage
+    {
+        static constexpr int getMinLogLevel() { return 2; }
+        static constexpr std::string_view getDescription() { return msg; }
+    };
+
+If there is no ``LogLevelsInfos.hpp`` in the corresponding folder, you can create a ``LogLevelsInfos.hpp``
+
+Example of usage
+----------------
+
+To log a message with a log level, 4 macros are defined in LogLevelsInfo.hpp located in dataRepository:
+
+* ``GEOS_LOG_LEVEL_INFO( logInfoStruct, msg )``: Output messages based on current ``Group``'s log level.
+* ``GEOS_LOG_LEVEL_INFO_RANK_0( logInfoStruct, msg )``: Output messages (only on rank 0) based on current ``Group``'s log level.
+* ``GEOS_LOG_LEVEL_INFO_BY_RANK( logInfoStruct, msg )``: Output messages (with one line per rank) based on current ``Group``'s log level.
+* ``GEOS_LOG_LEVEL_INFO_RANK_0_NLR( logInfoStruct, msg )``: Output messages (only on rank 0) based on current ``Group``'s log level without the line return.
+
+An exemple of adding and using a log level in a ``group``:
+
+.. code-block:: c++
+
+    MyGroup::MyGroup( string const & name );
+    {
+        // To use a log level, make sure it is declared in the constructor of the group
+        addLogLevel< logInfo::MyMessage >();
+    }
+
+    void MyGroup::outputMessage()
+    {
+        // effectively output the message taking into account the log level of the group instance
+        GEOS_LOG_LEVEL_INFO( logInfo::MyMessage, "output some message" );
+    }

src/coreComponents/dataRepository/docs/dataRepository.rst

@@ -19,3 +19,4 @@ The components/classes of the data structure that a developer should have some k
    /coreComponents/dataRepository/docs/Wrapper
    /coreComponents/dataRepository/docs/ObjectCatalog
    /coreComponents/dataRepository/docs/MappedVector
+   /coreComponents/dataRepository/docs/LogLevel

src/coreComponents/events/CMakeLists.txt

@@ -27,6 +27,7 @@ set( events_headers
      HaltEvent.hpp
      PeriodicEvent.hpp
      SoloEvent.hpp
+     LogLevelsInfo.hpp
      tasks/TaskBase.hpp
      tasks/TasksManager.hpp
    )

src/coreComponents/events/EventBase.cpp

@@ -20,6 +20,7 @@
 #include "EventBase.hpp"
 #include <cstring>
 
+#include "events/LogLevelsInfo.hpp"
 #include "common/DataTypes.hpp"
 #include "common/TimingMacros.hpp"
 
@@ -53,9 +54,6 @@ EventBase::EventBase( const string & name,
 {
   setInputFlags( InputFlags::OPTIONAL_NONUNIQUE );
 
-  // This enables logLevel filtering
-  enableLogLevelInput();
-
   registerWrapper( viewKeyStruct::eventTargetString(), &m_eventTarget ).
     setRTTypeName( rtTypes::CustomTypes::groupNameRef ).
     setInputFlag( InputFlags::OPTIONAL ).
@@ -244,9 +242,9 @@ bool EventBase::execute( real64 const time_n,
     EventBase * subEvent = static_cast< EventBase * >( this->getSubGroups()[m_currentSubEvent] );
 
     // Print debug information for logLevel >= 1
-    GEOS_LOG_LEVEL_RANK_0( 1,
-                           "          SubEvent: " << m_currentSubEvent << " (" << subEvent->getName() << "), dt_request=" << subEvent->getCurrentEventDtRequest() << ", forecast=" <<
-                           subEvent->getForecast() );
+    GEOS_LOG_LEVEL_INFO_RANK_0( logInfo::EventExecution,
+                                "          SubEvent: " << m_currentSubEvent << " (" << subEvent->getName() << "), dt_request=" << subEvent->getCurrentEventDtRequest() << ", forecast=" <<
+                                subEvent->getForecast() );
 
     if( subEvent->isReadyForExec() )
     {

src/coreComponents/events/EventManager.cpp

@@ -23,6 +23,7 @@
 #include "events/EventBase.hpp"
 #include "common/MpiWrapper.hpp"
 #include "common/Units.hpp"
+#include "events/LogLevelsInfo.hpp"
 
 namespace geos
 {
@@ -45,9 +46,6 @@ EventManager::EventManager( string const & name,
 {
   setInputFlags( InputFlags::REQUIRED );
 
-  // This enables logLevel filtering
-  enableLogLevelInput();
-
   registerWrapper( viewKeyStruct::minTimeString(), &m_minTime ).
     setApplyDefaultValue( 0 ).
     setInputFlag( InputFlags::OPTIONAL ).
@@ -183,8 +181,9 @@ bool EventManager::run( DomainPartition & domain )
       subEvent->checkEvents( m_time, m_dt, m_cycle, domain );
 
       // Print debug information for logLevel >= 1
-      GEOS_LOG_LEVEL_RANK_0( 1, GEOS_FMT( "Event: {} ({}), dt_request={}, forecast={}",
-                                          m_currentSubEvent, subEvent->getName(), subEvent->getCurrentEventDtRequest(), subEvent->getForecast() ) );
+      GEOS_LOG_LEVEL_INFO_RANK_0( logInfo::EventExecution,
+                                  GEOS_FMT( "Event: {} ({}), dt_request={}, forecast={}", m_currentSubEvent,
+                                            subEvent->getName(), subEvent->getCurrentEventDtRequest(), subEvent->getForecast() ) );
 
       // Execute, signal events
       bool earlyReturn = false;

src/coreComponents/events/LogLevelsInfo.hpp

@@ -0,0 +1,51 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2018-2020 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2020 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2018-2020 TotalEnergies
+ * Copyright (c) 2019-     GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file LogLevelsInfo.hpp
+ * This file contains common log level informations for physics solvers
+ */
+
+#ifndef GEOS_EVENTS_LOGLEVELSINFO_HPP
+#define GEOS_EVENTS_LOGLEVELSINFO_HPP
+
+#include "common/DataTypes.hpp"
+
+namespace geos
+{
+
+namespace logInfo
+{
+
+/**
+ * @name Common LogLevels info structures. They must comply with the `is_log_level_info` trait.
+ */
+///@{
+
+/// @cond DO_NOT_DOCUMENT
+
+struct EventExecution
+{
+  static constexpr int getMinLogLevel() { return 1; }
+  static constexpr std::string_view getDescription() { return "Informations on events execution"; }
+};
+
+/// @endcond
+///@}
+
+}
+
+}
+
+#endif // GEOS_EVENTS_LOGLEVELSINFO_HPP

src/coreComponents/events/tasks/TaskBase.cpp

@@ -18,6 +18,7 @@
  */
 
 #include "TaskBase.hpp"
+#include "events/LogLevelsInfo.hpp"
 
 namespace geos
 {
@@ -29,6 +30,8 @@ TaskBase::TaskBase( string const & name,
   ExecutableGroup( name, parent )
 {
   setInputFlags( InputFlags::OPTIONAL_NONUNIQUE );
+
+  addLogLevel< logInfo::EventExecution >();
 }
 
 TaskBase::~TaskBase()

src/coreComponents/events/tasks/TaskBase.hpp

@@ -22,7 +22,6 @@
 
 
 #include <limits>
-
 #include "dataRepository/ExecutableGroup.hpp"
 #include "common/DataTypes.hpp"
 namespace geos

src/coreComponents/fieldSpecification/FieldSpecificationBase.cpp

@@ -82,8 +82,6 @@ FieldSpecificationBase::FieldSpecificationBase( string const & name, Group * par
     setApplyDefaultValue( 1.0e99 ).
     setInputFlag( InputFlags::OPTIONAL ).
     setDescription( "Time at which the boundary condition will stop being applied." );
-
-  enableLogLevelInput();
 }
 
 

src/coreComponents/fileIO/CMakeLists.txt

@@ -23,6 +23,7 @@ Contains:
 # Specify all headers
 #
 set( fileIO_headers
+     LogLevelsInfo.hpp
      Outputs/BlueprintOutput.hpp
      Outputs/OutputBase.hpp
      Outputs/OutputManager.hpp