TableMpiComponents.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * 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.
 * ------------------------------------------------------------------------------------------------------------
 */
 
#ifndef GEOS_COMMON_FORMAT_TABLE_TABLEMPICOMPONENTS_HPP
#define GEOS_COMMON_FORMAT_TABLE_TABLEMPICOMPONENTS_HPP
 
#include "TableFormatter.hpp"
 
namespace geos
{
 
struct TableMpiLayout
{
  bool m_separatorBetweenRanks = false;
  string m_rankTitle;
};
 
class TableTextMpiFormatter : public TableTextFormatter
{
public:
  using Base = TableTextFormatter;
  using SortingFunc = std::function< bool (stdVector< TableData::CellData >, stdVector< TableData::CellData >) >;
  TableTextMpiFormatter( TableMpiLayout mpiLayout = TableMpiLayout() );
 
  TableTextMpiFormatter( TableLayout const & tableLayout,
                         TableMpiLayout mpiLayout = TableMpiLayout() );
 
  template< typename DATASOURCE >
  void toStream( std::ostream & outputStream, DATASOURCE const & tableData ) const;
 
  void setSortingFunc( SortingFunc && func )
  { m_sortingFunctor = std::move( func ); }
 
 
private:
 
  // hiding toString() methods as they are not implemented with MPI support.
  using Base::toString;
 
  struct Status
  {
    bool const m_isMasterRank;
    bool const m_isContributing;
    bool m_hasContent;
    string m_sepLine;
  };
 
  TableMpiLayout m_mpiLayout;
 
  std::optional< SortingFunc > m_sortingFunctor;
 
  void stretchColumnsByRanks( stdVector< size_t > & columnsWidth,
                              Status const & status ) const;
 
  TableData gatherTableDataRank0( TableData const & localTableData ) const;
 
 
  void gatherAndOutputTableDataInRankOrder( std::ostream & tableOutput,
                                            CellLayoutRows const & dataCellsLayout,
                                            PreparedTableLayout const & tableLayout,
                                            TableTextMpiFormatter::Status & status ) const;
};
 
}
 
#endif /* GEOS_COMMON_FORMAT_TABLE_TABLEMPICOMPONENTS_HPP */