SinglePhaseStatisticsAggregator.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_SINGLEPHASESTATISTICSAGGREGATOR_HPP_
#define SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASESTATISTICSAGGREGATOR_HPP_
 
#include "physicsSolvers/StatisticsAggregatorBase.hpp"
 
namespace geos
{
 
class SinglePhaseBase;
 
namespace singlePhaseStatistics
{
class StatsAggregator;
class RegionStatistics;
}
 
template<>
struct StatsAggregatorTraits< singlePhaseStatistics::StatsAggregator >
{
  using SolverType = SinglePhaseBase;
  using StatsGroupType = singlePhaseStatistics::RegionStatistics;
};
 
namespace singlePhaseStatistics
{
 
class RegionStatistics : public RegionStatisticsBase
{
public:
 
  real64 m_time;
 
  real64 m_averagePressure;
  real64 m_minPressure;
  real64 m_maxPressure;
 
  real64 m_minDeltaPressure;
  real64 m_maxDeltaPressure;
 
  real64 m_averageTemperature;
  real64 m_minTemperature;
  real64 m_maxTemperature;
 
  real64 m_totalMass;
 
  real64 m_totalDynamicPoreVolume;
  real64 m_totalUncompactedPoreVolume;
 
  // TODO? -> split to struct PressureStats...MassStats:
  // - optional computation of each stats
  // - VKS for struct name ("pressureStats"..."massStats")
  // - current RegionStatistics struct bits
 
  RegionStatistics( string const & targetName,
                    dataRepository::Group * const parent,
                    bool statsOutputEnabled );
 
  RegionStatistics( RegionStatistics && ) = default;
 
};
 
class StatsAggregator : public StatsAggregatorBase< StatsAggregator >
{
public:
 
  using Base = StatsAggregatorBase< StatsAggregator >;
 
  StatsAggregator( dataRepository::DataContext const & ownerDataContext,
                   dataRepository::Group & meshBodies,
                   bool statsOutputEnabled );
 
  void enableRegionStatisticsAggregation();
 
  // template implementations
 
  void initStats( RegionStatistics & stats, real64 time ) const;
  void computeSubRegionRankStats( CellElementSubRegion & subRegion, RegionStatistics & subRegionStats ) const;
  void aggregateStats( RegionStatistics & stats, RegionStatistics const & other ) const;
  void mpiAggregateStats( RegionStatistics & stats ) const;
  void postAggregateStats( RegionStatistics & stats );
 
 
};
 
} /* namespace singlePhaseStatistics */
 
} /* namespace geos */
 
#endif /* SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_SINGLEPHASESTATISTICSAGGREGATOR_HPP_ */