CompositionalMultiphaseStatisticsTask.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 SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONALMULTIPHASESTATISTICSTASK_HPP_
#define SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONALMULTIPHASESTATISTICSTASK_HPP_
 
#include "common/DataTypes.hpp"
#include "common/format/table/TableFormatter.hpp"
#include "physicsSolvers/FieldStatisticsBase.hpp"
#include "physicsSolvers/fluidFlow/CompositionalMultiphaseStatisticsAggregator.hpp"
#include <memory>
 
namespace geos
{
 
class CompositionalMultiphaseBase;
 
namespace compositionalMultiphaseStatistics
{
 
class StatsTask : public FieldStatisticsBase< CompositionalMultiphaseBase >
{
public:
 
  StatsTask( const string & name, dataRepository::Group * const parent );
 
  static string catalogName() { return "CompositionalMultiphaseStatistics"; }
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  StatsAggregator & getStatisticsAggregator()
  { return *m_aggregator; }
 
  StatsAggregator const & getStatisticsAggregator() const
  { return *m_aggregator; }
 
private:
 
  using Base = FieldStatisticsBase< CompositionalMultiphaseBase >;
 
  struct viewKeyStruct
  {
    constexpr static char const * computeCFLNumbersString() { return "computeCFLNumbers"; }
    constexpr static char const * computeRegionStatisticsString() { return "computeRegionStatistics"; }
    constexpr static char const * relpermThresholdString() { return "relpermThreshold"; }
  };
 
  void postInputInitialization() override;
 
  void registerDataOnMesh( Group & meshBodies ) override;
 
  void prepareFluidMetaData();
 
  void prepareLogTableLayouts( string_view tableName );
 
  void prepareCsvTableLayouts( string_view tableName );
 
  string getCsvFileName( string_view meshName ) const;
 
  void outputLogStats( real64 statsTime,
                       MeshLevel & mesh,
                       RegionStatistics & meshRegionsStatistics );
 
  void outputCsvStats( real64 statsTime,
                       MeshLevel & mesh,
                       RegionStatistics & meshRegionsStatistics );
 
  stdMap< string, std::unique_ptr< TableTextFormatter > > m_logFormatters;
 
  stdMap< string, std::unique_ptr< TableCSVFormatter > > m_csvFormatters;
 
  // mesh statistics aggregator
  std::unique_ptr< StatsAggregator > m_aggregator;
 
  integer m_computeCFLNumbers;
 
  integer m_computeRegionStatistics;
 
  real64 m_relpermThreshold;
 
  struct FluidMetaData
  {
    integer m_numPhases;
    integer m_numComps;
    stdVector< string > m_phaseNames;
    stdVector< string > m_compNames;
    stdVector< string > m_phaseCompNames;
 
    string & phaseCompName( integer phaseId, integer compId )
    { return m_phaseCompNames[phaseId * m_numComps + compId]; }
 
  } m_fluid;
 
};
 
} /* namespace compositionalMultiphaseStatistics */
 
} /* namespace geos */
 
#endif /* SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONALMULTIPHASESTATISTICSTASK_HPP_ */