CompositionalMultiphaseStatistics.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_COMPOSITIONALMULTIPHASESTATISTICS_HPP_
#define SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONALMULTIPHASESTATISTICS_HPP_
 
#include "physicsSolvers/FieldStatisticsBase.hpp"
 
namespace geos
{
 
class CompositionalMultiphaseBase;
 
class CompositionalMultiphaseStatistics : public FieldStatisticsBase< CompositionalMultiphaseBase >
{
public:
 
  CompositionalMultiphaseStatistics( const string & name,
                                     Group * const parent );
 
  static string catalogName() { return "CompositionalMultiphaseStatistics"; }
 
  static string regionStatisticsName() { return "regionStatistics"; }
 
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  struct RegionStatistics
  {
    real64 averagePressure;
    real64 minPressure;
    real64 maxPressure;
 
    real64 minDeltaPressure;
    real64 maxDeltaPressure;
 
    real64 averageTemperature;
    real64 minTemperature;
    real64 maxTemperature;
 
    real64 totalPoreVolume;
    real64 totalUncompactedPoreVolume;
    array1d< real64 > phasePoreVolume;
 
    array1d< real64 > phaseMass;
    array1d< real64 > trappedPhaseMass;
    array1d< real64 > immobilePhaseMass;
    array2d< real64 > componentMass;
  };
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 * regionStatisticsString() { return "regionStatistics"; }
    constexpr static char const * relpermThresholdString() { return "relpermThreshold"; }
  };
 
 
 
  void computeRegionStatistics( real64 const time,
                                MeshLevel & mesh,
                                string_array const & regionNames ) const;
 
  void computeCFLNumbers( real64 const time,
                          real64 const dt,
                          DomainPartition & domain ) const;
 
  void postInputInitialization() override;
 
  void registerDataOnMesh( Group & meshBodies ) override;
 
  integer m_computeCFLNumbers;
 
  integer m_computeRegionStatistics;
 
  real64 m_relpermThreshold;
 
};
 
 
} /* namespace geos */
 
#endif /* SRC_CORECOMPONENTS_PHYSICSSOLVERS_FLUIDFLOW_COMPOSITIONALMULTIPHASESTATISTICS_HPP_ */