refactor: Refactor log & CSV statistics

inputFiles/compositionalMultiphaseFlow/benchmarks/thermalLeakyWell/thermalLeakyWell_base_direct.xml

@@ -60,6 +60,9 @@
       name="statistics"
       forceDt="1e6"
       target="/Tasks/compflowStatistics"/>
+    <PeriodicEvent name="timestepStatsEvent"
+        timeFrequency="4.32e6"
+          target="/Tasks/testLogStats" />
   </Events>
 
   <NumericalMethods>
@@ -173,7 +176,10 @@
       objectPath="ElementRegions/injectionWell"
       component="0"
       scale="-0.0887"
-      setNames="{ source }"/>
+      setNames="{ source }"
+      />
+
+
     <!-- SPHINX_SOURCE_BC_END -->                      
 
     <!-- SPHINX_DIRICHLET_BC -->
@@ -361,6 +367,11 @@
       logLevel="1"
       computeCFLNumbers="1"
       computeRegionStatistics="1"/>
+      <SourceFluxStatistics
+        name="testLogStats"
+        flowSolverName="compflow"
+        logLevel="1"
+        />
   </Tasks>
 
 </Problem>

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

@@ -18,39 +18,38 @@
  */
 
 #include "TableData.hpp"
+#include "common/logger/Logger.hpp"
 
 namespace geos
 {
 
-void TableData::addRow( std::vector< string > const & row )
+void TableData::addRow( std::vector< TableData::CellData > const & row )
 {
-  if( m_rows.size() != 0 && row.size() != m_rows[m_rows.size() - 1].size() )
+  m_rows.push_back( row );
+}
+
+void TableData::addSeparator()
+{
+  if( m_rows.empty())
   {
-    string msg = "Remarks : some cells may be missing";
-    if( std::find( m_errorsMsg.begin(), m_errorsMsg.end(), msg ) == m_errorsMsg.end())
-    {
-      m_errorsMsg.push_back( msg );
-    }
+    GEOS_ERROR( "You must have filled values in TableData before using addSeparator()" );
   }
-  m_rows.push_back( row );
+
+  integer rowSize = m_rows[0].size();
+  m_rows.emplace_back( std::vector< TableData::CellData >( rowSize, { CellType::Separator, "-" } ));
+
 }
 
 void TableData::clear()
 {
   m_rows.clear();
-  m_errorsMsg.clear();
 }
 
-std::vector< std::vector< string > > const & TableData::getTableDataRows() const
+std::vector< std::vector< TableData::CellData > > const & TableData::getTableDataRows() const
 {
   return m_rows;
 }
 
-std::vector< string > const & TableData::getErrorMsgs() const
-{
-  return m_errorsMsg;
-}
-
 void TableData2D::collectTableValues( arraySlice1d< real64 const > rowAxisValues,
                                       arraySlice1d< real64 const > columnAxisValues,
                                       arrayView1d< real64 const > values )
@@ -75,7 +74,6 @@ TableData2D::TableDataHolder TableData2D::convertTable2D( arrayView1d< real64 co
 {
   string const rowFmt = GEOS_FMT( "{} = {{}}", rowAxisDescription );
   string const columnFmt = GEOS_FMT( "{} = {{}}", columnAxisDescription );
-
   collectTableValues( coordinates[0], coordinates[1], values );
   return buildTableData( string( units::getDescription( valueUnit )),
                          rowFmt,
@@ -87,7 +85,6 @@ TableData2D::TableDataHolder TableData2D::buildTableData( string_view targetUnit
                                                           string_view columnFmt ) const
 {
   TableData2D::TableDataHolder tableData1D;
-  std::vector< size_t > rowsLength;
 
   tableData1D.headerNames.push_back( string( targetUnit ) );
 
@@ -99,23 +96,22 @@ TableData2D::TableDataHolder TableData2D::buildTableData( string_view targetUnit
   // insert row value and row cell values
   for( auto const & [rowValue, rowMap] : m_data )
   {
-    std::vector< string > currentRowValues;
+    std::vector< TableData::CellData > currentRowValues;
     currentRowValues.reserve( rowMap.size() );
-    currentRowValues.push_back( GEOS_FMT( rowFmt, rowValue ) );
+    currentRowValues.push_back( {CellType::Value, GEOS_FMT( rowFmt, rowValue )} );
 
     std::set< real64 >::const_iterator columnIt = m_columnValues.begin();
     for( auto const & [columnValue, cellValue] : rowMap )
     {
       // if a column value(s) is/are missing, insert empty entry(ies)
       while( columnValue > *( columnIt++ ) && columnIt != m_columnValues.end() )
       {
-        currentRowValues.push_back( "" );
+        currentRowValues.push_back( {CellType::Value, ""} );
       }
-      currentRowValues.push_back( GEOS_FMT( "{}", cellValue ) );
+      currentRowValues.push_back( {CellType::Value, GEOS_FMT( "{}", cellValue )} );
     }
 
-    tableData1D.tableData.addRow( std::move( currentRowValues ) );
-    rowsLength.push_back( currentRowValues.size() );
+    tableData1D.tableData.addRow( currentRowValues );
   }
 
   return tableData1D;

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

@@ -23,6 +23,7 @@
 #include "common/Units.hpp"
 #include "common/DataTypes.hpp"
 #include "common/format/Format.hpp"
+#include "TableTypes.hpp"
 
 namespace geos
 {
@@ -33,10 +34,22 @@ namespace geos
 class TableData
 {
 public:
+
+  /**
+   * @brief Representing a data in TableData
+   */
+  struct CellData
+  {
+    /// The cell type
+    CellType type;
+    /// The cell value
+    string value = "";
+  };
+
   /**
    * @brief Add a row to the table.
    * The values passed to addRow (can be any type).
-   * @param args Cell values to be added to the row.
+   * @param args CellData values to be added to the row.
    */
   template< typename ... Args >
   void addRow( Args const & ... args );
@@ -45,7 +58,13 @@ class TableData
    * @brief Add a row to the table
    * @param row A vector of string representing a row
    */
-  void addRow( std::vector< string > const & row );
+  void addRow( std::vector< CellData > const & row );
+
+  /**
+   * @brief Add a line separator to the table
+   * You must have filled values in TableData before using it
+   */
+  void addSeparator();
 
   /**
    * @brief Reset data in the table
@@ -55,7 +74,7 @@ class TableData
   /**
    * @return The rows of the table
    */
-  std::vector< std::vector< string > > const & getTableDataRows() const;
+  std::vector< std::vector< CellData > > const & getTableDataRows() const;
 
   /**
    * @brief Get all error messages
@@ -66,10 +85,7 @@ class TableData
 private:
 
   /// vector containing all rows with cell values
-  std::vector< std::vector< string > > m_rows;
-
-  /// store error if there are any inconsistencies related to the table
-  std::vector< string > m_errorsMsg;
+  std::vector< std::vector< CellData > > m_rows;
 
 };
 
@@ -98,7 +114,7 @@ class TableData2D
   /**
    * @brief Add a cell to the table. If necessary, create automatically the containing column & row.
    * @tparam T The value passed to addCell (can be any type).
-   * @param value Cell value to be added.
+   * @param value CellData value to be added.
    * @param rowValue The value of the row containing the cell.
    * @param columnValue The value of the column containing the cell.
    */
@@ -149,17 +165,35 @@ class TableData2D
   std::set< real64 > m_columnValues;
 };
 
+/**
+ * @brief Trait to check is the args is a special type of cell
+ * @tparam T The type of a cell
+ */
+template< typename T >
+constexpr bool isCellType = std::is_same_v< T, CellType >;
+
 template< typename ... Args >
 void TableData::addRow( Args const &... args )
 {
-  std::vector< string > m_cellsValue;
+  std::vector< CellData > cells;
   ( [&] {
-    static_assert( has_formatter_v< decltype(args) >, "Argument passed in addRow cannot be converted to string" );
-    string const cellValue = GEOS_FMT( "{}", args );
-    m_cellsValue.push_back( cellValue );
+    static_assert( has_formatter_v< decltype(args) > || isCellType< std::decay_t< decltype(args) > >, "Argument passed in addRow cannot be converted to string nor a CellType" );
+    if constexpr (std::is_same_v< Args, CellType >) {
+      if( args == CellType::Separator )
+      {
+        cells.push_back( {CellType::Separator} );
+      }
+      else
+      {
+        cells.push_back( {CellType::MergeNext} );
+      }
+    }
+    else
+    {
+      cells.push_back( {CellType::Value, GEOS_FMT( "{}", args )} );
+    }
   } (), ...);
-
-  addRow( m_cellsValue );
+  addRow( cells );
 }
 
 template< typename T >