refactor: replace hand-written CSVs with the Table infrastructure

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

@@ -545,6 +545,16 @@ class TableLayout
     addColumns( columns );
   }
 
+  /**
+   * @brief Construct a new Table Layout object
+   * @param columns A vector containing all column initialized
+   */
+  TableLayout( stdVector< TableLayout::Column > const & columns )
+  {
+    setMargin( MarginValue::medium );
+    addColumns( columns );
+  }
+
   /**
    * @brief Construct a new Table Layout object
    * @param title The table title
@@ -582,6 +592,16 @@ class TableLayout
     addColumns( args );
   }
 
+  /**
+   * @brief Construct a new Table Layout object
+   * @param args An initializer_list containing string / column
+   */
+  TableLayout( stdVector< string > const & args )
+  {
+    setMargin( MarginValue::medium );
+    addColumns( args );
+  }
+
   /**
    * @return The columns list
    */

src/coreComponents/physicsSolvers/fluidFlow/wells/CompositionalMultiphaseWell.cpp

@@ -21,7 +21,14 @@
 
 #include "codingUtilities/Utilities.hpp"
 #include "common/DataTypes.hpp"
+#include "common/Path.hpp"
+#include "common/StdContainerWrappers.hpp"
 #include "common/TimingMacros.hpp"
+#include "common/format/Format.hpp"
+#include "common/format/table/TableData.hpp"
+#include "common/format/table/TableFormatter.hpp"
+#include "common/format/table/TableLayout.hpp"
+#include "common/logger/Logger.hpp"
 #include "constitutive/ConstitutiveManager.hpp"
 #include "constitutive/fluid/multifluid/MultiFluidBase.hpp"
 #include "constitutive/fluid/multifluid/MultiFluidFields.hpp"
@@ -50,6 +57,7 @@
 #include "physicsSolvers/fluidFlow/kernels/compositional/ThermalPhaseVolumeFractionKernel.hpp"
 #include "physicsSolvers/fluidFlow/kernels/compositional/FluidUpdateKernel.hpp"
 #include "physicsSolvers/fluidFlow/CompositionalMultiphaseStatistics.hpp"
+#include <filesystem>
 
 #if defined( __INTEL_COMPILER )
 #pragma GCC optimize "O0"
@@ -260,34 +268,6 @@ void CompositionalMultiphaseWell::registerDataOnMesh( Group & meshBodies )
       wellControls.registerWrapper< real64 >( viewKeyStruct::massDensityString() );
 
       wellControls.registerWrapper< real64 >( viewKeyStruct::currentMassRateString() );
-
-      // write rates output header
-      // the rank that owns the reference well element is responsible
-      if( m_writeCSV > 0 && subRegion.isLocallyOwned() )
-      {
-        string const fileName = GEOS_FMT( "{}/{}.csv", m_ratesOutputDir, wellControls.getName() );
-        string const massUnit = m_useMass ? "kg" : "mol";
-        integer const useSurfaceConditions = wellControls.useSurfaceConditions();
-        string const conditionKey = useSurfaceConditions ? "surface" : "reservoir";
-        string const unitKey = useSurfaceConditions ? "s" : "r";
-        integer const numPhase = m_numPhases;
-        integer const numComp = m_numComponents;
-        // format: time,bhp,total_rate,total_vol_rate,phase0_vol_rate,phase1_vol_rate,...
-        makeDirsForPath( m_ratesOutputDir );
-        GEOS_LOG( GEOS_FMT( "{}: Rates CSV generated at {}", getName(), fileName ) );
-        std::ofstream outputFile( fileName );
-        outputFile << "Time [s],dt[s],BHP [Pa],Total rate [" << massUnit << "/s],Total " << conditionKey << " volumetric rate [" << unitKey << "m3/s]";
-        for( integer ip = 0; ip < numPhase; ++ip )
-        {
-          outputFile << ",Phase" << ip << " " << conditionKey << " volumetric rate [" << unitKey << "m3/s]";
-        }
-        for( integer ic = 0; ic < numComp; ++ic )
-        {
-          outputFile << ",Component" << ic << " rate [" << massUnit << "/s]";
-        }
-        outputFile << std::endl;
-        outputFile.close();
-      }
     } );
   } );
 
@@ -2223,57 +2203,107 @@ void CompositionalMultiphaseWell::printRates( real64 const & time_n,
       }
 
       string const wellControlsName = wellControls.getName();
-
-      // format: time,total_rate,total_vol_rate,phase0_vol_rate,phase1_vol_rate,...
-      std::ofstream outputFile;
-      if( m_writeCSV > 0 )
+      string const massUnit = m_useMass ? "kg" : "mol";
+      integer const useSurfaceConditions = wellControls.useSurfaceConditions();
+      string const conditionKey = useSurfaceConditions ? "surface" : "reservoir";
+      string const unitKey = useSurfaceConditions ? "s" : "r";
+
+      stdVector< string > columnNames;
+      columnNames.reserve( 5 + numPhase + numComp );
+      columnNames.emplace_back( GEOS_FMT( "Time [{}]", units::getSymbol( units::Unit::Time ) ) );
+      columnNames.emplace_back( GEOS_FMT( "dt [{}]", units::getSymbol( units::Unit::Time ) ) );
+      columnNames.emplace_back( GEOS_FMT( "BHP [{}]", units::getSymbol( units::Unit::Pressure ) ) );
+      columnNames.emplace_back( GEOS_FMT( "Total rate [{}/s]", massUnit ) );
+      columnNames.emplace_back( GEOS_FMT( "Total {} volumetric rate [{}m3/s]", conditionKey, unitKey ) );
+      for( integer ip = 0; ip < numPhase; ++ip )
       {
-        outputFile.open( m_ratesOutputDir + "/" + wellControlsName + ".csv", std::ios_base::app );
-        outputFile << time_n << "," << dt;
+        columnNames.emplace_back( GEOS_FMT( "Phase {} {} volumetric rate [{}m3/s]", ip, conditionKey, unitKey ) );
       }
+      for( integer ic = 0; ic < numComp; ++ic )
+      {
+        columnNames.emplace_back( GEOS_FMT( "Component {} rate [{}/s]", ic, massUnit ) );
+      }
+      size_t const numColumns = columnNames.size();
+
+      auto const buildRow = [&]( real64 const bhp,
+                                 real64 const totalRate,
+                                 real64 const totalVolRate,
+                                 auto const & phaseVolRates,
+                                 auto const & compRates )
+      {
+        stdVector< TableData::CellData > row;
+        row.reserve( numColumns );
+        row.push_back( { CellType::Value, GEOS_FMT( "{}", time_n ) } );
+        row.push_back( { CellType::Value, GEOS_FMT( "{}", dt ) } );
+        row.push_back( { CellType::Value, GEOS_FMT( "{}", bhp ) } );
+        row.push_back( { CellType::Value, GEOS_FMT( "{}", totalRate ) } );
+        row.push_back( { CellType::Value, GEOS_FMT( "{}", totalVolRate ) } );
+        for( integer ip = 0; ip < numPhase; ++ip )
+        {
+          row.push_back( { CellType::Value, GEOS_FMT( "{}", phaseVolRates[ ip ] ) } );
+        }
+        for( integer ic = 0; ic < numComp; ++ic )
+        {
+          row.push_back( { CellType::Value, GEOS_FMT( "{}", compRates[ ic ] ) } );
+        }
+        GEOS_ERROR_IF_NE_MSG( row.size(), numColumns,
+                              "CSV rates row size does not match header size for "
+                              << wellControlsName );
+        return row;
+      };
+
+      string const fileName = m_ratesOutputDir + "/" + wellControlsName + ".csv";
+
+      auto const writeCSVRow = [&]( TableData const & data )
+      {
+        if( !std::filesystem::exists( fileName ) || std::filesystem::is_empty( fileName ) )
+        {
+          makeDirsForPath( m_ratesOutputDir );
+          TableLayout const tableLayout( columnNames );
+          TableCSVFormatter const csvFormatter( tableLayout );
+          std::ofstream outputFile( fileName );
+          csvFormatter.headerToStream( outputFile );
+          outputFile.close();
+          GEOS_LOG( GEOS_FMT( "{}: Rates CSV generated at {}", getName(), fileName ) );
+        }
+        std::ofstream outputFile( fileName, std::ios_base::app );
+        TableCSVFormatter const csvFormatter;
+        csvFormatter.dataToStream( outputFile, data );
+        outputFile.close();
+      };
 
       if( wellControls.getWellStatus() == WellControls::Status::CLOSED )
       {
         GEOS_LOG( GEOS_FMT( "{}: well is shut", wellControlsName ) );
-        if( outputFile.is_open())
+        if( m_writeCSV > 0 )
         {
-          // print all zeros in the rates file
-          outputFile << ",0.0,0.0,0.0";
-          for( integer ip = 0; ip < numPhase; ++ip )
-          {
-            outputFile << ",0.0";
-          }
-          for( integer ic = 0; ic < numComp; ++ic )
-          {
-            outputFile << ",0.0";
-          }
-          outputFile << std::endl;
-          outputFile.close();
+          stdVector< real64 > const zeroesNumPhase( numPhase, 0.0 );
+          stdVector< real64 > const zeroesNumComp( numComp, 0.0 );
+          TableData ratesTableData;
+          ratesTableData.addRow( buildRow( 0.0, 0.0, 0.0, zeroesNumPhase, zeroesNumComp ) );
+          writeCSVRow( ratesTableData );
         }
         return;
       }
 
       localIndex const iwelemRef = subRegion.getTopWellElementIndex();
-      string const massUnit = m_useMass ? "kg" : "mol";
 
       // subRegion data
 
       arrayView1d< real64 const > const & connRate =
         subRegion.getField< well::mixtureConnectionRate >();
 
-      integer const useSurfaceConditions = wellControls.useSurfaceConditions();
-
       real64 const & currentBHP =
         wellControls.getReference< real64 >( CompositionalMultiphaseWell::viewKeyStruct::currentBHPString() );
       arrayView1d< real64 const > const & currentPhaseVolRate =
         wellControls.getReference< array1d< real64 > >( CompositionalMultiphaseWell::viewKeyStruct::currentPhaseVolRateString() );
       real64 const & currentTotalVolRate =
         wellControls.getReference< real64 >( CompositionalMultiphaseWell::viewKeyStruct::currentTotalVolRateString() );
 
+      TableData ratesTableData;
+
       // bring everything back to host, capture the scalars by reference
       forAll< serialPolicy >( 1, [&numPhase,
-                                  &numComp,
-                                  &useSurfaceConditions,
                                   &currentBHP,
                                   connRate,
                                   &currentTotalVolRate,
@@ -2282,11 +2312,11 @@ void CompositionalMultiphaseWell::printRates( real64 const & time_n,
                                   &iwelemRef,
                                   &wellControlsName,
                                   &massUnit,
-                                  &outputFile] ( localIndex const )
+                                  &conditionKey,
+                                  &unitKey,
+                                  &ratesTableData,
+                                  &buildRow] ( localIndex const )
       {
-        string const conditionKey = useSurfaceConditions ? "surface" : "reservoir";
-        string const unitKey = useSurfaceConditions ? "s" : "r";
-
         real64 const currentTotalRate = connRate[iwelemRef];
         GEOS_LOG( GEOS_FMT( "{}: BHP (at the specified reference elevation): {} Pa",
                             wellControlsName, currentBHP ) );
@@ -2295,22 +2325,13 @@ void CompositionalMultiphaseWell::printRates( real64 const & time_n,
         for( integer ip = 0; ip < numPhase; ++ip )
           GEOS_LOG( GEOS_FMT( "{}: Phase {} {} volumetric rate: {} {}m3/s",
                               wellControlsName, ip, conditionKey, currentPhaseVolRate[ip], unitKey ) );
-        if( outputFile.is_open())
-        {
-          outputFile << "," << currentBHP;
-          outputFile << "," << currentTotalRate << "," << currentTotalVolRate;
-          for( integer ip = 0; ip < numPhase; ++ip )
-          {
-            outputFile << "," << currentPhaseVolRate[ip];
-          }
-          for( integer ic = 0; ic < numComp; ++ic )
-          {
-            outputFile << "," << compRate[ic];
-          }
-          outputFile << std::endl;
-          outputFile.close();
-        }
+        ratesTableData.addRow( buildRow( currentBHP, currentTotalRate, currentTotalVolRate, currentPhaseVolRate, compRate ) );
       } );
+
+      if( m_writeCSV > 0 )
+      {
+        writeCSVRow( ratesTableData );
+      }
     } );
   } );
 }