feat: Adding log parts

src/coreComponents/codingUtilities/tests/CMakeLists.txt

@@ -10,7 +10,6 @@ geos_decorate_link_dependencies( LIST decoratedDependencies
                                  DEPENDENCIES ${dependencyList} )
 # Add gtest C++ based tests
 foreach( test ${testSources} )
-
   get_filename_component( test_name ${test} NAME_WE )
   blt_add_executable( NAME ${test_name}
                       SOURCES ${test}

src/coreComponents/common/format/table/TableFormatter.cpp

@@ -171,7 +171,7 @@ string TableTextFormatter::toString< TableData >( TableData const & tableData )
   fillTableColumnsFromRows( columns, tableDataRows );
 
   outputLayout( tableOutput, columns, msgTableError, sectionSeparatingLine );
-  outputSectionRows( columns, sectionSeparatingLine, tableOutput, nbValuesRows, TableLayout::Section::values );
+  outputSectionRows( columns, sectionSeparatingLine, tableOutput, nbValuesRows, TableLayout::LogPart::values );
   tableOutput << '\n';
 
   return tableOutput.str();
@@ -198,7 +198,7 @@ void TableTextFormatter::outputLayout( std::ostringstream & tableOutput,
   outputTopRows( tableOutput, msgTableError, topSeparator, TableLayout::Alignment::left );
   tableOutput << GEOS_FMT( "{}\n", sectionSeparatingLine );
 
-  outputSectionRows( columns, sectionSeparatingLine, tableOutput, nbHeaderRows, TableLayout::Section::header );
+  outputSectionRows( columns, sectionSeparatingLine, tableOutput, nbHeaderRows, TableLayout::LogPart::header );
 }
 
 void TableTextFormatter::splitAndSetColumnNames( std::vector< TableLayout::Column > & columns,
@@ -369,7 +369,7 @@ void TableTextFormatter::outputSectionRows( std::vector< TableLayout::Column > c
                                             string_view sectionSeparatingLine,
                                             std::ostringstream & tableOutput,
                                             integer const nbRows,
-                                            TableLayout::Section const section ) const
+                                            TableLayout::LogPart const section ) const
 {
   integer const columnMargin = m_tableLayout.getColumnMargin();
   integer const borderMargin = m_tableLayout.getBorderMargin();
@@ -381,7 +381,7 @@ void TableTextFormatter::outputSectionRows( std::vector< TableLayout::Column > c
     for( std::size_t idxColumn = 0; idxColumn < columns.size(); ++idxColumn )
     {
       TableLayout::Column const currentColumn = columns[idxColumn];
-      auto const & columnContent = section == TableLayout::Section::header ?
+      auto const & columnContent = section == TableLayout::LogPart::header ?
                                    columns[idxColumn].m_parameter.splitColumnNameLines :
                                    columns[idxColumn].m_columnValues;
       string cell = columnContent.at( idxRow );

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

@@ -244,7 +244,7 @@ class TableTextFormatter : public TableFormatter
                           string_view sectionSeparatingLine,
                           std::ostringstream & rows,
                           integer const nbRows,
-                          TableLayout::Section const section ) const;
+                          TableLayout::LogPart const section ) const;
 };
 
 /**

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 };
 
   /**
    * @brief Structure to set up each colum parameters.

src/coreComponents/dataRepository/Group.cpp

@@ -356,6 +356,7 @@ void Group::initialize_postMeshGeneration()
 
 void Group::initialize()
 {
+
   initializePreSubGroups();
 
   array1d< string > initOrder;

src/coreComponents/events/EventManager.cpp

@@ -170,8 +170,9 @@ bool EventManager::run( DomainPartition & domain )
       m_dt = dt_global;
 #endif
     }
-
-    outputTime();
+    LogPart logPart( "TIMESTEP START" );
+    outputTime( logPart );
+    logPart.begin();
 
     // Execute
     for(; m_currentSubEvent<this->numSubGroups(); ++m_currentSubEvent )
@@ -208,6 +209,7 @@ bool EventManager::run( DomainPartition & domain )
       }
     }
 
+    logPart.end();
     // Increment time/cycle, reset the subevent counter
     m_time += m_dt;
     ++m_cycle;
@@ -225,7 +227,7 @@ bool EventManager::run( DomainPartition & domain )
   return false;
 }
 
-void EventManager::outputTime() const
+void EventManager::outputTime( LogPart & logPart ) const
 {
   const bool isTimeLimited = m_maxTime < std::numeric_limits< real64 >::max();
   const bool isCycleLimited = m_maxCycle < std::numeric_limits< integer >::max();
@@ -245,19 +247,17 @@ void EventManager::outputTime() const
                      m_maxCycle, ( 100.0 * m_cycle ) / m_maxCycle );
   };
 
-  // The formating here is a work in progress.
-  GEOS_LOG_RANK_0( "\n------------------------- TIMESTEP START -------------------------" );
-  GEOS_LOG_RANK_0( GEOS_FMT( "    - Time:       {}{}",
-                             timeInfo.toUnfoldedString(),
-                             isTimeLimited ? timeCompletionUnfoldedString() : "" ) );
-  GEOS_LOG_RANK_0( GEOS_FMT( "                  ({}{})",
-                             timeInfo.toSecondsString(),
-                             isTimeLimited ? timeCompletionSecondsString() : "" ) );
-  GEOS_LOG_RANK_0( GEOS_FMT( "    - Delta Time: {}", units::TimeFormatInfo::fromSeconds( m_dt ) ) );
-  GEOS_LOG_RANK_0( GEOS_FMT( "    - Cycle:      {}{}",
-                             m_cycle,
-                             isCycleLimited ? cycleCompletionString() : "" ) );
-  GEOS_LOG_RANK_0( "--------------------------------------------------------------------\n" );
+  string const timeCompletionUnfolded = isTimeLimited ? timeCompletionUnfoldedString() : "";
+  string const timeCompletionSecond = isTimeLimited ? timeCompletionSecondsString() : "";
+  string const cycleLimited = isCycleLimited ? cycleCompletionString() : "";
+
+  string const timeInfosUnfolded = timeInfo.toUnfoldedString() + timeCompletionUnfolded;
+  string const timeCompletionSeconds = timeInfo.toSecondsString() + timeCompletionSecond;
+
+  logPart.addDescription( "Time", timeInfosUnfolded, timeCompletionSeconds );
+  logPart.addDescription( "Delta Time", units::TimeFormatInfo::fromSeconds( m_dt ).toString() );
+  logPart.addDescription( "Cycle", m_cycle, cycleLimited );
+  logPart.setMinWidth( 70 );
 
   // We are keeping the old outputs to keep compatibility with current log reading scripts.
   if( m_timeOutputFormat==TimeOutputFormat::full )

src/coreComponents/events/EventManager.hpp

@@ -19,6 +19,7 @@
 
 #include "dataRepository/Group.hpp"
 #include "EventBase.hpp"
+#include "fileIO/logPart/LogPart.hpp"
 
 namespace geos
 {
@@ -134,7 +135,7 @@ class EventManager : public dataRepository::Group
    * @brief ouput time information to the log
    *
    */
-  void outputTime() const;
+  void outputTime( LogPart & section ) const;
 
   /// Min time for a simulation
   real64 m_minTime;

src/coreComponents/fileIO/CMakeLists.txt

@@ -6,6 +6,7 @@ set( fileIO_headers
      Outputs/OutputUtilities.hpp
      Outputs/PythonOutput.hpp
      Outputs/RestartOutput.hpp
+     logPart/LogPart.hpp
      Outputs/TimeHistoryOutput.hpp
      timeHistory/HDFFile.hpp
      timeHistory/HistoryCollectionBase.hpp
@@ -22,6 +23,7 @@ set( fileIO_sources
      Outputs/OutputUtilities.cpp
      Outputs/PythonOutput.cpp
      Outputs/RestartOutput.cpp
+     logPart/LogPart.cpp
      Outputs/TimeHistoryOutput.cpp
      timeHistory/HDFFile.cpp
      timeHistory/HistoryCollectionBase.cpp
@@ -95,5 +97,9 @@ target_include_directories( fileIO PUBLIC ${CMAKE_SOURCE_DIR}/coreComponents )
 
 install( TARGETS fileIO LIBRARY DESTINATION ${CMAKE_INSTALL_PREFIX}/lib )
 
+if( GEOS_ENABLE_TESTS )
+  add_subdirectory( logPart/unitTests )
+endif( )
+
 
 

src/coreComponents/fileIO/logPart/LogPart.cpp

@@ -0,0 +1,121 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * 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 LogPart.cpp
+ */
+
+#include "LogPart.hpp"
+#include <algorithm>
+
+namespace geos
+{
+
+LogPart::LogPart( string_view sectionTitle ):
+  m_sectionTitle( string( sectionTitle ) ),
+  m_sectionWidth( sectionTitle.length() )
+{
+  m_footerTitle = GEOS_FMT( "End : {}", m_sectionTitle );
+}
+
+void LogPart::addDescription( string_view description )
+{
+  m_descriptions.push_back( string( description ) );
+}
+
+void LogPart::addEndDescription( string_view description )
+{
+  m_endLogMessages.push_back( string( description ) );
+}
+
+void LogPart::setMinWidth( integer const & minWidth )
+{
+  m_rowMinWidth = minWidth;
+}
+
+void LogPart::formatAndInsertDescriptions( std::vector< string > & descriptionContainer,
+                                           string_view name,
+                                           std::vector< string > const & values )
+{
+  string const nameFormatted =  GEOS_FMT( "- {}: ", string( name ));
+  string const descriptionFormatted = GEOS_FMT( "{}{}", nameFormatted, values[0] );
+  integer const spacesFromBorder = m_marginBorder * 2 + m_nbBorderChar * 2;
+  integer const completeDescriptionLength = descriptionFormatted.length() + spacesFromBorder;
+  descriptionContainer.push_back( descriptionFormatted );
+
+  m_sectionWidth = std::max( completeDescriptionLength, m_sectionWidth );
+
+  for( size_t idxValue = 1; idxValue < values.size(); idxValue++ )
+  {
+    size_t const spaces = values[idxValue].length() + nameFormatted.length();
+    descriptionContainer.push_back( GEOS_FMT( "{:>{}}", values[idxValue], spaces ) );
+  }
+}
+
+string LogPart::buildDescriptionPart( std::vector< string > const & descriptions ) const
+{
+  std::ostringstream oss;
+  for( auto const & description : descriptions )
+  {
+    integer const remainingLength = m_sectionWidth - m_nbBorderChar * 2 - m_marginBorder;
+    string const borderCharacters = GEOS_FMT( "{:#<{}}", "", m_nbBorderChar );
+    oss << borderCharacters;
+    oss << GEOS_FMT( "{:<{}}{:<{}}", " ", m_marginBorder, description, remainingLength );
+    oss << borderCharacters << '\n';
+  }
+  return oss.str();
+}
+
+string LogPart::buildTitlePart( string_view title ) const
+{
+  std::ostringstream oss;
+  integer const titleRowLength = m_sectionWidth - m_nbBorderChar * 2;
+  string const borderCharacters =  GEOS_FMT( "{:#<{}}", "", m_nbBorderChar );
+  oss <<  GEOS_FMT( "{}{:^{}}{}\n",
+                    borderCharacters,
+                    title,
+                    titleRowLength,
+                    borderCharacters );
+  return oss.str();
+}
+
+void LogPart::begin( std::ostream & os )
+{
+  m_sectionWidth = std::max( m_sectionWidth, m_rowMinWidth );
+
+  string bottomPart;
+  if( !m_descriptions.empty())
+  {
+    bottomPart = buildDescriptionPart( m_descriptions );
+  }
+
+  m_horizontalBorder =  GEOS_FMT( "{:#>{}}\n", "", m_sectionWidth );
+  string topPart =  GEOS_FMT( "{}{}{}", m_horizontalBorder,
+                              buildTitlePart( m_sectionTitle ),
+                              m_horizontalBorder );
+  os << GEOS_FMT( "\n{}{}\n", topPart, bottomPart );
+}
+
+void LogPart::end( std::ostream & os ) const
+{
+  string topPart;
+  if( !m_endLogMessages.empty() )
+  {
+    topPart =  GEOS_FMT( "{}{}", buildDescriptionPart( m_endLogMessages ), m_horizontalBorder );
+  }
+  string bottomPart = GEOS_FMT( "{}{}", buildTitlePart( m_footerTitle ), m_horizontalBorder );
+  os << GEOS_FMT( "\n{}{}\n", topPart, bottomPart );
+}
+
+}