feat: encountered negative pressure/density cells summary output

src/coreComponents/common/CMakeLists.txt

@@ -24,9 +24,10 @@ Also provides commonly used components for such as logging, formatting, memory a
 #
 set( common_headers
      ${CMAKE_BINARY_DIR}/include/common/GeosxConfig.hpp
-     format/table/TableLayout.hpp
-     format/table/TableFormatter.hpp
      format/table/TableData.hpp
+     format/table/TableFormatter.hpp
+     format/table/TableLayout.hpp
+     format/table/TableMpiComponents.hpp
      format/EnumStrings.hpp
      format/LogPart.hpp
      format/Format.hpp
@@ -71,9 +72,10 @@ endif( )
 # Specify all sources
 #
 set( common_sources
-     format/table/TableLayout.cpp
-     format/table/TableFormatter.cpp
      format/table/TableData.cpp
+     format/table/TableFormatter.cpp
+     format/table/TableLayout.cpp
+     format/table/TableMpiComponents.cpp
      format/LogPart.cpp
      format/StringUtilities.cpp
      logger/GeosExceptions.cpp

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

@@ -89,16 +89,6 @@ void TableData::clear()
   getErrorsList().clear();
 }
 
-stdVector< stdVector< TableData::CellData > > const & TableData::getTableDataRows() const
-{
-  return m_rows;
-}
-
-stdVector< stdVector< TableData::CellData > > & TableData::getTableDataRows()
-{
-  return m_rows;
-}
-
 void TableData2D::collectTableValues( arrayView1d< real64 const > dim0AxisCoordinates,
                                       arrayView1d< real64 const > dim1AxisCoordinates,
                                       arrayView1d< real64 const > values,

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

@@ -111,16 +111,6 @@ class TableData
   void clearErrors()
   { m_errors->clear(); }
 
-  /**
-   * @return The const rows of the table
-   */
-  stdVector< stdVector< CellData > > const & getTableDataRows() const;
-
-  /**
-   * @return The rows of the table
-   */
-  stdVector< stdVector< CellData > > & getTableDataRows();
-
   /**
    * @brief Get all error messages
    * @return The vector of error messages
@@ -133,16 +123,19 @@ class TableData
   DataRows const & getCellsData() const
   { return m_rows; }
 
+  /**
+   * @return The const table data rows
+   */
+  DataRows & getCellsData()
+  { return m_rows; }
+
   /**
    * @brief Comparison operator for data rows
    * @param comparingTable The tableData values to compare
    * @return The comparison result
    */
   inline bool operator==( TableData const & comparingTable ) const
-  {
-
-    return getCellsData() == comparingTable.getCellsData();
-  }
+  { return getCellsData() == comparingTable.getCellsData(); }
 
   /**
    * @brief Get all error messages

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

@@ -18,10 +18,10 @@
  * @file TableFormatter.cpp
  */
 
-#include "TableFormatter.hpp"
 #include <numeric>
 #include "common/format/StringUtilities.hpp"
 #include "common/logger/Logger.hpp"
+#include "TableFormatter.hpp"
 
 namespace geos
 {
@@ -157,7 +157,7 @@ string TableCSVFormatter::headerToString() const
 
 string TableCSVFormatter::dataToString( TableData const & tableData ) const
 {
-  RowsCellInput const rowsValues( tableData.getTableDataRows() );
+  RowsCellInput const rowsValues( tableData.getCellsData() );
   string result;
   size_t total_size = 0;
   for( auto const & row : rowsValues )
@@ -232,12 +232,13 @@ string TableTextFormatter::toString< TableData >( TableData const & tableData )
 
   initalizeTableGrids( m_tableLayout, tableData,
                        headerCellsLayout, dataCellsLayout, errorCellsLayout,
-                       tableTotalWidth );
-  outputTable( m_tableLayout, tableOutput,
-               headerCellsLayout, dataCellsLayout, errorCellsLayout,
-               tableTotalWidth );
+                       tableTotalWidth, nullptr );
+
+  string const sepLine = string( tableTotalWidth, m_horizontalLine );
+  outputTableHeader( tableOutput, m_tableLayout, headerCellsLayout, sepLine );
+  outputTableData( tableOutput, m_tableLayout, dataCellsLayout );
+  outputTableFooter( tableOutput, m_tableLayout, errorCellsLayout, sepLine, !dataCellsLayout.empty() );
 
-  getErrorsList().clear();
   return tableOutput.str();
 }
 
@@ -246,10 +247,11 @@ void TableTextFormatter::initalizeTableGrids( PreparedTableLayout const & tableL
                                               CellLayoutRows & headerCellsLayout,
                                               CellLayoutRows & dataCellsLayout,
                                               CellLayoutRows & errorCellsLayout,
-                                              size_t & tableTotalWidth ) const
+                                              size_t & tableTotalWidth,
+                                              ColumnWidthModifier columnWidthModifier ) const
 {
+  RowsCellInput const & inputDataValues( tableInputData.getCellsData() );
   bool const hasColumnLayout = tableLayout.getColumnLayersCount() > 0;
-  RowsCellInput const & inputDataValues( tableInputData.getTableDataRows() );
   size_t const inputDataRowsCount = !inputDataValues.empty() ? inputDataValues.front().size() : 0;
   size_t const nbVisibleColumns = std::max( size_t( 1 ), ( hasColumnLayout ?
                                                            tableLayout.getVisibleLowermostColumnCount() :
@@ -282,6 +284,9 @@ void TableTextFormatter::initalizeTableGrids( PreparedTableLayout const & tableL
   stretchColumnsByMergedCellsWidth( columnsWidth, dataCellsLayout, tableLayout, true );
   stretchColumnsByMergedCellsWidth( columnsWidth, errorCellsLayout, tableLayout, true );
 
+  if( columnWidthModifier )
+    columnWidthModifier( columnsWidth );
+
   // the columns width array is now sized after all the table, we can compute the total table width
   tableTotalWidth = tableLayout.getBorderMargin() * 2 + 2;
   for( size_t columnId = 0; columnId < columnsWidth.size(); ++columnId )
@@ -494,8 +499,8 @@ void TableTextFormatter::populateDataCellsLayout( PreparedTableLayout const & ta
                           string_view( &m_horizontalLine, 1 ) :
                           string_view( inputCell.value );
       TableLayout::Alignment const alignment = inputCell.type == CellType::Header ?
-                                               tableLayout.defaultHeaderAlignment :
-                                               tableLayout.defaultValueAlignment;
+                                               tableLayout.getDefaultHeaderAlignment() :
+                                               tableLayout.getDefaultValueAlignment();
 
       TableLayout::CellLayout & outputCell = outputRow.cells[idxColumn];
       outputCell = TableLayout::CellLayout( inputCell.type, alignment );
@@ -702,34 +707,44 @@ void TableTextFormatter::applyColumnsWidth( stdVector< size_t > const & columnsW
   }
 }
 
-void TableTextFormatter::outputTable( PreparedTableLayout const & tableLayout,
-                                      std::ostream & tableOutput,
-                                      CellLayoutRows const & headerCellsLayout,
-                                      CellLayoutRows const & dataCellsLayout,
-                                      CellLayoutRows & errorCellsLayout,
-                                      size_t const tableTotalWidth ) const
+void TableTextFormatter::outputTableHeader( std::ostream & tableOutput,
+                                            PreparedTableLayout const & tableLayout,
+                                            CellLayoutRows const & headerCellsLayout,
+                                            string_view sepLine ) const
 {
-  string const sepLine = string( tableTotalWidth, m_horizontalLine );
   if( tableLayout.isLineBreakEnabled())
   {
     tableOutput << '\n';
   }
-  tableOutput << sepLine << '\n';
+  tableOutput << tableLayout.getIndentationStr() << sepLine << '\n';
   outputLines( tableLayout, headerCellsLayout, tableOutput );
+}
 
-  if( !dataCellsLayout.empty())
+void TableTextFormatter::outputTableData( std::ostream & tableOutput,
+                                          PreparedTableLayout const & tableLayout,
+                                          CellLayoutRows const & dataCellsLayout ) const
+{
+  if( !dataCellsLayout.empty() )
   {
     outputLines( tableLayout, dataCellsLayout, tableOutput );
   }
+}
 
+void TableTextFormatter::outputTableFooter( std::ostream & tableOutput,
+                                            PreparedTableLayout const & tableLayout,
+                                            CellLayoutRows & errorCellsLayout,
+                                            string_view sepLine,
+                                            bool hasData ) const
+{
   if( !errorCellsLayout.empty())
   {
     outputErrors( tableLayout, errorCellsLayout, tableOutput );
   }
 
-  if( !dataCellsLayout.empty() || getErrorsList().hasErrors())
-    tableOutput << sepLine;
-
+  if( hasData || !errorCellsLayout.empty() )
+  {
+    tableOutput << tableLayout.getIndentationStr() << sepLine;
+  }
 
   if( tableLayout.isLineBreakEnabled())
   {
@@ -816,6 +831,7 @@ void TableTextFormatter::outputLines( PreparedTableLayout const & tableLayout,
           if( isLeftBorderCell )
           { // left table border
             isLeftBorderCell=false;
+            tableOutput << tableLayout.getIndentationStr();
             tableOutput << m_verticalLine << string( nbBorderSpaces, cellSpaceChar );
           }
           else
@@ -845,4 +861,5 @@ void TableTextFormatter::outputLines( PreparedTableLayout const & tableLayout,
     idxRow++;
   }
 }
-}
+
+} /* namespace geos */

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

@@ -86,7 +86,7 @@ class TableFormatter
 };
 
 /**
- * @brief class for CSV formatting
+ * @brief Class to format data in a formatted CSV format
  */
 class TableCSVFormatter final : public TableFormatter
 {
@@ -189,9 +189,10 @@ string TableCSVFormatter::toString< TableData >( TableData const & tableData ) c
 
 
 /**
- * @brief class for log formatting
+ * @brief Class to format data in a formatted text format
+ * (for log output typically, expecting fixed character size).
  */
-class TableTextFormatter final : public TableFormatter
+class TableTextFormatter : public TableFormatter
 {
 public:
 
@@ -243,13 +244,15 @@ class TableTextFormatter final : public TableFormatter
   void toStream( std::ostream & outputStream, DATASOURCE const & tableData ) const
   { toStreamImpl( outputStream, toString( tableData ) ); }
 
-private:
+protected:
 
   /// symbol for separator construction
   static constexpr char m_verticalLine = '|';
   /// for the extremity of a row
   static constexpr char m_horizontalLine = '-';
 
+  /// A functor which allow to customize the columns width after their computation.
+  using ColumnWidthModifier = std::function< void ( stdVector< size_t > & ) >;
 
   /**
    * @brief Initializes the table layout with the given table data and prepares necessary layouts for headers and data cells.
@@ -258,30 +261,54 @@ class TableTextFormatter final : public TableFormatter
    * @param headerCellsLayout A reference to a `CellLayoutRows` where the header cells will be populated.
    * @param dataCellsLayout A reference to a `CellLayoutRows` where the data cells will be populated.
    * @param errorCellsLayout A reference to a `CellLayoutRows` where the error cells will be populated.
-   * @param separatorLine A string that will be used as the table separator line
+   * @param tableTotalWidth A string that will be used as the table separator line
+   * @param columnWidthModifier A functor which allow to customize the columns width after their computation.
    */
   void initalizeTableGrids( PreparedTableLayout const & tableLayout,
                             TableData const & tableData,
                             CellLayoutRows & dataCellsLayout,
                             CellLayoutRows & headerCellsLayout,
                             CellLayoutRows & errorCellsLayout,
-                            size_t & tableTotalWidth ) const;
+                            size_t & tableTotalWidth,
+                            ColumnWidthModifier columnWidthModifier ) const;
+
+  /**
+   * @brief Outputs the top part of the formatted table to the provided output stream.
+   * @param tableOutput A reference to an `std::ostream` where the formatted table will be written.
+   * @param tableLayout The layout of the table
+   * @param headerCellsLayout The header rows in a grid layout
+   * @param separatorLine A string that will be used as the table separator line
+   */
+  void outputTableHeader( std::ostream & tableOutput,
+                          PreparedTableLayout const & tableLayout,
+                          CellLayoutRows const & headerCellsLayout,
+                          string_view separatorLine ) const;
 
   /**
-   * @brief Outputs the formatted table to the provided output stream.
+   * @brief Outputs the data part of the formatted table to the provided output stream.
+   * @param tableOutput A reference to an `std::ostream` where the formatted table will be written.
    * @param tableLayout The layout of the table
+   * @param dataCellsLayout The data rows in a grid layout
+   */
+  void outputTableData( std::ostream & tableOutput,
+                        PreparedTableLayout const & tableLayout,
+                        CellLayoutRows const & dataCellsLayout ) const;
+
+  /**
+   * @brief Outputs the bottom part of the formatted table to the provided output stream.
    * @param tableOutput A reference to an `std::ostream` where the formatted table will be written.
-   * @param headerCellsLayout The layout of the header rows
-   * @param dataCellsLayout The layout of the data rows
+   * @param tableLayout The layout of the table
+   * @param separatorLine A string that will be used as the table separator line
    * @param errorCellsLayout The layout of the error rows
-   * @param separatorLine The string to be used as the table separator line
+   * @param hasData Indicates whether there is data in the table TableData.
    */
-  void outputTable( PreparedTableLayout const & tableLayout,
-                    std::ostream & tableOutput,
-                    CellLayoutRows const & headerCellsLayout,
-                    CellLayoutRows const & dataCellsLayout,
-                    CellLayoutRows & errorCellsLayout,
-                    size_t tableTotalWidth ) const;
+  void outputTableFooter( std::ostream & tableOutput,
+                          PreparedTableLayout const & tableLayout,
+                          CellLayoutRows & errorCellsLayout,
+                          string_view separatorLine,
+                          bool hasData ) const;
+
+private:
 
   /**
    * @brief Outputs the formatted table lines to the output stream.
@@ -312,7 +339,7 @@ class TableTextFormatter final : public TableFormatter
    */
   void populateTitleCellsLayout( PreparedTableLayout const & tableLayout,
                                  CellLayoutRows & headerCellsLayout,
-                                 size_t const nbVisibleColumn ) const;
+                                 size_t nbVisibleColumn ) const;
 
   /**
    * @brief Populate a grid of CellLayout with all visible columns of the given table layout.
@@ -402,6 +429,7 @@ class TableTextFormatter final : public TableFormatter
   void formatCell( std::ostream & tableOutput,
                    TableLayout::CellLayout const & cell,
                    size_t idxLine ) const;
+
 };
 
 /**