SolutionCheckHelpers.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_PHYSICSSOLVERS_FLUIDFLOW_SOLUTIONCHECKHELPERS_HPP
#define GEOS_PHYSICSSOLVERS_FLUIDFLOW_SOLUTIONCHECKHELPERS_HPP
 
#include "physicsSolvers/fluidFlow/kernels/SolutionCheckKernelsHelpers.hpp"
#include "common/Units.hpp"
 
namespace geos
{
 
class ElementsReporterOutput
{
public:
 
  using ElementCount = ElementsReporterCollector::ElementCount;
 
  ElementsReporterOutput( ElementsReporterBuffer const & buffer );
 
  ElementCount getRanksSignaledIdsCount() const
  { return m_ranksSignaledElementsCount; }
 
  ElementCount getRanksCollectedIdsCount() const
  { return m_ranksCollectedElementsCount; }
 
  void outputTooLowValues( string_view linesPrefix,
                           string_view valueNaming,
                           real64 minValue,
                           units::Unit valueUnit ) const;
 
private:
 
  ElementsReporterBuffer const & m_buffer;
 
  ElementCount m_ranksSignaledElementsCount;
 
  ElementCount m_ranksCollectedElementsCount;
 
};
 
class ElementsReporterBuffer
{
public:
 
  using ElementCount = ElementsReporterCollector::ElementCount;
 
  ElementsReporterBuffer( bool enabled, ElementCount maxCollectionSize );
 
  ElementsReporterBuffer( ElementsReporterBuffer && other ) = default;
 
  ElementsReporterBuffer & operator=( ElementsReporterBuffer && other ) = default;
 
  ElementsReporterBuffer( ElementsReporterBuffer const & ) = delete;
 
  ElementsReporterBuffer & operator=( ElementsReporterBuffer const & ) = delete;
 
  ElementCount getSignaledElementsCount() const
  { return m_elementsCounter.empty() ? 0 : m_elementsCounter[0]; }
 
  ElementCount getCollectedElementsCount() const
  { return LvArray::math::min( getSignaledElementsCount(), m_elementsBuffer.size() ); }
 
  ElementReport const & operator[]( ElementCount id ) const
  { return m_elementsBuffer[id]; }
 
  auto begin() const
  { return m_elementsBuffer.begin(); }
 
  auto end() const
  { return m_elementsBuffer.begin() + getCollectedElementsCount(); }
 
  bool enabled() const
  { return !m_elementsCounter.empty(); }
 
  bool empty() const
  { return getCollectedElementsCount() == 0; }
 
  bool isComplete() const
  { return getCollectedElementsCount() < getSignaledElementsCount(); }
 
  ElementsReporterCollector createCollector( arrayView1d< globalIndex const > const & localToGlobalId ) const;
 
  ElementsReporterOutput createOutput() const;
 
private:
 
  // array of one element to get benefit of managed host-device memory.
  array1d< ElementCount > m_elementsCounter;
 
  // Preallocated array of ids of detected elements
  array1d< ElementReport > m_elementsBuffer;
 
};
 
} // namespace geos
 
 
#endif //GEOS_PHYSICSSOLVERS_FLUIDFLOW_SOLUTIONCHECKHELPERS_HPP