feat: Error reporting at the end of the simulatiuon

.github/workflows/ci_tests.yml

@@ -150,47 +150,47 @@ jobs:
       fail-fast : false
       matrix:
         include:
-          - name: Ubuntu (20.04, gcc 9.4.0, open-mpi 4.0.3)
-            CMAKE_BUILD_TYPE: Release
-            DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc9
-            BUILD_SHARED_LIBS: ON
-            ENABLE_HYPRE: OFF
-            ENABLE_TRILINOS: ON
-            GEOS_ENABLE_BOUNDS_CHECK: ON
-            HOST_CONFIG: /spack-generated.cmake
-
-          - name: Ubuntu debug (20.04, gcc 10.5.0, open-mpi 4.0.3) - github codespaces
-            BUILD_AND_TEST_CLI_ARGS: "--no-run-unit-tests"
-            CMAKE_BUILD_TYPE: Debug
-            DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc10
-            BUILD_SHARED_LIBS: ON
-            ENABLE_HYPRE: OFF
-            ENABLE_TRILINOS: ON
-            GEOS_ENABLE_BOUNDS_CHECK: ON
-            RUNS_ON: streak2
-            NPROC: 8
-            DOCKER_RUN_ARGS: "--cpus=8 --memory=256g --runtime=nvidia -v /etc/pki/tls/certs/ca-bundle.crt:/etc/pki/tls/certs/ca-bundle.crt:ro -v /etc/pki/tls/certs/ca-bundle.crt:/certs/ca-bundle.crt:ro"
-
-            HOST_CONFIG: /spack-generated.cmake
-
-          - name: Ubuntu (20.04, gcc 10.5.0, open-mpi 4.0.3) - github codespaces
-            CMAKE_BUILD_TYPE: Release
-            DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc10
-            BUILD_SHARED_LIBS: ON
-            ENABLE_HYPRE: OFF
-            ENABLE_TRILINOS: ON
-            GEOS_ENABLE_BOUNDS_CHECK: ON
-            HOST_CONFIG: /spack-generated.cmake
-
-          - name: Ubuntu (22.04, gcc 11.4.0, open-mpi 4.1.2)
-            CMAKE_BUILD_TYPE: Release
-            DOCKER_REPOSITORY: geosx/ubuntu22.04-gcc11
-            ENABLE_HYPRE: ON
-            ENABLE_TRILINOS: OFF
-            BUILD_SHARED_LIBS: ON
-            GEOS_ENABLE_BOUNDS_CHECK: OFF
-            GCP_BUCKET: geosx/ubuntu22.04-gcc11
-            HOST_CONFIG: /spack-generated.cmake
+          # - name: Ubuntu (20.04, gcc 9.4.0, open-mpi 4.0.3)
+          #   CMAKE_BUILD_TYPE: Release
+          #   DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc9
+          #   BUILD_SHARED_LIBS: ON
+          #   ENABLE_HYPRE: OFF
+          #   ENABLE_TRILINOS: ON
+          #   GEOS_ENABLE_BOUNDS_CHECK: ON
+          #   HOST_CONFIG: /spack-generated.cmake
+
+          # - name: Ubuntu debug (20.04, gcc 10.5.0, open-mpi 4.0.3) - github codespaces
+          #   BUILD_AND_TEST_CLI_ARGS: "--no-run-unit-tests"
+          #   CMAKE_BUILD_TYPE: Debug
+          #   DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc10
+          #   BUILD_SHARED_LIBS: ON
+          #   ENABLE_HYPRE: OFF
+          #   ENABLE_TRILINOS: ON
+          #   GEOS_ENABLE_BOUNDS_CHECK: ON
+          #   RUNS_ON: streak2
+          #   NPROC: 8
+          #   DOCKER_RUN_ARGS: "--cpus=8 --memory=256g --runtime=nvidia -v /etc/pki/tls/certs/ca-bundle.crt:/etc/pki/tls/certs/ca-bundle.crt:ro -v /etc/pki/tls/certs/ca-bundle.crt:/certs/ca-bundle.crt:ro"
+
+          #   HOST_CONFIG: /spack-generated.cmake
+
+          # - name: Ubuntu (20.04, gcc 10.5.0, open-mpi 4.0.3) - github codespaces
+          #   CMAKE_BUILD_TYPE: Release
+          #   DOCKER_REPOSITORY: geosx/ubuntu20.04-gcc10
+          #   BUILD_SHARED_LIBS: ON
+          #   ENABLE_HYPRE: OFF
+          #   ENABLE_TRILINOS: ON
+          #   GEOS_ENABLE_BOUNDS_CHECK: OFF
+          #   HOST_CONFIG: /spack-generated.cmake
+
+          # - name: Ubuntu (22.04, gcc 11.4.0, open-mpi 4.1.2)
+          #   CMAKE_BUILD_TYPE: Release
+          #   DOCKER_REPOSITORY: geosx/ubuntu22.04-gcc11
+          #   ENABLE_HYPRE: ON
+          #   ENABLE_TRILINOS: OFF
+          #   BUILD_SHARED_LIBS: ON
+          #   GEOS_ENABLE_BOUNDS_CHECK: OFF
+          #   GCP_BUCKET: geosx/ubuntu22.04-gcc11
+          #   HOST_CONFIG: /spack-generated.cmake
 
           - name: Ubuntu (22.04, gcc 12.3.0, open-mpi 4.1.2)
             CMAKE_BUILD_TYPE: Release

src/coreComponents/common/CMakeLists.txt

@@ -38,10 +38,14 @@ set( common_headers
      GEOS_RAJA_Interface.hpp
      GeosxMacros.hpp
      MemoryInfos.hpp
+     logger/DiagnosticMessage.hpp
+     logger/GeosExceptions.hpp
      logger/GeosExceptions.hpp
      logger/Logger.hpp
      logger/ErrorHandling.hpp
      logger/ExternalErrorHandler.hpp
+     logger/LogHistory.hpp
+     logger/MsgType.hpp
      MpiWrapper.hpp
      Path.hpp
      Span.hpp
@@ -71,6 +75,7 @@ endif( )
 # Specify all sources
 #
 set( common_sources
+     format/EnumStrings.cpp
      format/table/TableLayout.cpp
      format/table/TableFormatter.cpp
      format/table/TableData.cpp
@@ -80,6 +85,7 @@ set( common_sources
      logger/Logger.cpp
      logger/ErrorHandling.cpp
      logger/ExternalErrorHandler.cpp
+     logger/LogHistory.cpp
      BufferAllocator.cpp
      MemoryInfos.cpp
      MpiWrapper.cpp

src/coreComponents/common/StdContainerWrappers.hpp

@@ -43,17 +43,6 @@ namespace geos
 namespace internal
 {
 
-
-
-/**
- * Default allocator type for std::vector.
- * This can be specialized if a different allocator is needed.
- * Required to avoid recursive evaluation in StdVectorWrapper.
- * @tparam T Type of elements in the vector.
- */
-template< typename T >
-using DefaultAllocator = std::allocator< T >;
-
 /**
  * Wrapper for std::vector that allows toggling between bounds-checked access
  * (using at()) and unchecked access (using operator[]).
@@ -63,8 +52,8 @@ using DefaultAllocator = std::allocator< T >;
  * If false, uses operator[] for unchecked access.
  */
 template< typename T,
-          typename Allocator  = DefaultAllocator< T >,
-          bool USE_BOUNDS_CHECKING = false >
+          bool USE_BOUNDS_CHECKING,
+          typename Allocator  = std::allocator< T > >
 class StdVectorWrapper : public std::vector< T, Allocator >
 {
 public:
@@ -159,7 +148,7 @@ class StdVectorWrapper : public std::vector< T, Allocator >
  * @tparam Allocator Allocator type for the vector.
  */
 template< typename T, typename Allocator = std::allocator< T > >
-using stdVector = internal::StdVectorWrapper< T, Allocator, USE_STD_CONTAINER_BOUNDS_CHECKING >;
+using stdVector = internal::StdVectorWrapper< T, USE_STD_CONTAINER_BOUNDS_CHECKING, Allocator>;
 
 
 

src/coreComponents/common/format/EnumStrings.cpp

@@ -0,0 +1,42 @@
+/*
+ * ------------------------------------------------------------------------------------------------------------
+ * SPDX-License-Identifier: LGPL-2.1-only
+ *
+ * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
+ * Copyright (c) 2018-2024 TotalEnergies
+ * Copyright (c) 2018-2024 The Board of Trustees of the Leland Stanford Junior University
+ * Copyright (c) 2023-2024 Chevron
+ * Copyright (c) 2019-     GEOS/GEOSX Contributors
+ * All rights reserved
+ *
+ * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
+ * ------------------------------------------------------------------------------------------------------------
+ */
+
+/**
+ * @file EnumStrings.cpp
+ */
+
+ #include "common/format/EnumStrings.hpp"
+ #include "common/logger/Logger.hpp"
+
+namespace geos
+{
+
+void internal::EnumErrorMessageToString( size_t index,
+                                         string const & typeName,
+                                         std::size_t size )
+{
+  GEOS_THROW( "Invalid value " << index << " of type " << typeName<< ". Valid range is 0.." << size - 1,
+              InputError );
+}
+
+void internal::EnumErrorMessageFromString( string const & s,
+                                           string const & typeName,
+                                           string const & concat )
+{
+  GEOS_THROW( "Invalid value '" << s << "' of type " << typeName << ". Valid options are: " << concat,
+              InputError );
+}
+
+}

src/coreComponents/common/format/EnumStrings.hpp

@@ -28,7 +28,6 @@
 #include "common/format/StringUtilities.hpp"
 // #include "codingUtilities/RTTypes.hpp"
 #include "common/DataTypes.hpp"
-#include "common/logger/Logger.hpp"
 #include "common/format/Format.hpp"
 
 #include <iostream>
@@ -40,6 +39,25 @@ namespace geos
 
 namespace internal
 {
+
+/**
+ * @brief Raise a throw error in case of bad use of enum::toString
+ * @param index The index of the enum causing the error
+ * @param typeName The enum name
+ * @param size The size of the enum
+ */
+void EnumErrorMessageToString( size_t index, string const & typeName, std::size_t size );
+
+/**
+ * @brief Raise a throw error in case of bad use of enum::FromString
+ * @param s The string that not belonging to the enum
+ * @param typeName The enum name
+ * @param size The string concatenation of the enum
+ */
+void EnumErrorMessageFromString( string const & s,
+                                 string const & typeName,
+                                 string const & concat );
+
 /**
  * @brief Simple compile-time variadic function that counts its arguments.
  * @tparam ARGS variadic pack of argument types
@@ -152,12 +170,10 @@ struct EnumStrings
     auto const & strings = get();
     std::size_t size = std::distance( std::begin( strings ), std::end( strings ) );
     base_type const index = static_cast< base_type >( e );
-    GEOS_THROW_IF( index >= LvArray::integerConversion< base_type >( size ),
-                   GEOS_FMT( "Invalid value {} of type {}. Valid range is 0..{}",
-                             index,
-                             getEnumTypeNameString( enum_type{} ),
-                             size - 1 ),
-                   InputError );
+    if( index >= LvArray::integerConversion< base_type >( size ))
+    {
+      internal::EnumErrorMessageToString( index, getEnumTypeNameString( enum_type{} ), size - 1 );
+    }
     return strings[ index ];
   }
 
@@ -170,12 +186,10 @@ struct EnumStrings
   {
     auto const & strings = get();
     auto const it = std::find( std::begin( strings ), std::end( strings ), s );
-    GEOS_THROW_IF( it == std::end( strings ),
-                   GEOS_FMT( "Invalid value '{}' of type {}. Valid options are: {}",
-                             s,
-                             getEnumTypeNameString( enum_type{} ),
-                             concat( ", " ) ),
-                   InputError );
+    if( it == std::end( strings ))
+    {
+      internal::EnumErrorMessageFromString( s, getEnumTypeNameString( enum_type{} ), EnumStrings::concat( ", " ));
+    }
     enum_type const e = static_cast< enum_type >( LvArray::integerConversion< base_type >( std::distance( std::begin( strings ), it ) ) );
     return e;
   }

src/coreComponents/common/format/LogPart.cpp

@@ -18,18 +18,22 @@
 
 #include "LogPart.hpp"
 #include "common/format/StringUtilities.hpp"
+#include "common/logger/ErrorHandling.hpp"
 #include <algorithm>
 
 using namespace geos::stringutilities;
 namespace geos
 {
 
-LogPart::LogPart( string_view logPartTitle, bool enableOutput )
+LogPart::LogPart( string const & logpartName, bool enableOutput )
 {
-  m_formattedStartDescription.m_title = logPartTitle;
-  m_formattedEndDescription.m_title = GEOS_FMT( "{}{}", m_prefixEndTitle, logPartTitle );
+  m_formattedStartDescription.m_title = logpartName;
+  m_formattedEndDescription.m_title = GEOS_FMT( "{}{}", m_prefixEndTitle, logpartName );
 
   m_enableOutput = enableOutput;
+
+  ErrorLogger::global().setCurrentLogPart( logpartName );
+
 }
 
 void LogPart::addDescription( string_view description )

src/coreComponents/common/format/LogPart.hpp

@@ -19,9 +19,7 @@
 #ifndef GEOS_COMMON_FORMAT_LOGPART_HPP
 #define GEOS_COMMON_FORMAT_LOGPART_HPP
 
-#include "common/DataTypes.hpp"
-#include "common/format/Format.hpp"
-#include "common/format/StringUtilities.hpp"
+#include "common/format/EnumStrings.hpp"
 
 namespace geos
 {
@@ -39,7 +37,7 @@ class LogPart
    * @param logPartTitle The title who will be used for top and bottom LogPart
    * @param enableOutput Boolean to activate or not csv output
    */
-  LogPart( string_view logPartTitle, bool enableOutput );
+  LogPart( string const & logPartTitle, bool enableOutput );
 
   /**
    * @brief Add a description to the top LogPart

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

@@ -40,15 +40,17 @@ void TableLayout::addColumns( stdVector< TableLayout::Column > const & columns )
   }
 }
 
-void TableLayout::addColumn( string_view columnName )
+TableLayout::Column & TableLayout::addColumn( string_view columnName )
 {
   TableLayout::Column column = TableLayout::Column().setName( columnName );
   m_tableColumns.emplace_back( column );
+  return m_tableColumns.back();
 }
 
-void TableLayout::addColumn( TableLayout::Column const & column )
+TableLayout::Column & TableLayout::addColumn( TableLayout::Column const & column )
 {
   m_tableColumns.emplace_back( column );
+  return m_tableColumns.back();
 }
 
 TableLayout & TableLayout::setTitle( string_view title )

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

@@ -696,14 +696,16 @@ class TableLayout
   /**
    * @brief Create and add a column to the columns vector given a string
    * @param columnName The column name
+   * @return The current tableLayout
    */
-  void addColumn( string_view columnName );
+  TableLayout::Column & addColumn( string_view columnName );
 
   /**
    * @brief Create and add a column to the columns vector given a Column
    * @param column Vector containing addition information on the column
+   * @return The current tableLayout
    */
-  void addColumn( TableLayout::Column const & column );
+  TableLayout::Column & addColumn( TableLayout::Column const & column );
 
 protected:
 

src/coreComponents/common/initializeEnvironment.cpp

@@ -333,6 +333,9 @@ void setupEnvironment( int argc, char * argv[] )
 void cleanupEnvironment()
 {
   MemoryLogging::getInstance().memoryStatsReport();
+  if( ErrorLogger::global().getLoggerReportData().getDiagnosticHistory().size()>0 )
+    ErrorLogger::global().getLoggerReportData().diagnosticStatsReport();
+
   LvArray::system::resetSignalHandling();
   finalizeLogger();
   finalizeCaliper();