HistoryCollectionBase.hpp

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2016-2024 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2024 Total, S.A
 * 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_HISTORYCOLLECTIONBASE_HPP
#define GEOS_HISTORYCOLLECTIONBASE_HPP
 
#include "HistoryCollection.hpp"
 
#if defined(GEOS_USE_PYGEOSX)
#include "fileIO/python/PyHistoryCollectionType.hpp"
#endif
 
namespace geos
{
 
class HistoryCollectionBase : public HistoryCollection
{
public:
  HistoryCollectionBase( string const & name, Group * parent ):
    HistoryCollection( name, parent ),
    m_targetIsMeshObject( false ),
    m_collectionCount( 1 ),
    m_timeBufferProvider(),
    m_bufferProviders()
  {   }
 
  void initializePostSubGroups() override;
 
  localIndex numCollectors() const override;
 
  virtual bool execute( real64 const time_n,
                        real64 const dt,
                        integer const cycleNumber,
                        integer const eventCounter,
                        real64 const eventProgress,
                        DomainPartition & domain ) override;
 
  void registerBufferProvider( localIndex collectionIdx, BufferProvider bufferProvider ) override;
 
  HistoryMetadata getTimeMetaData() const override;
 
  void registerTimeBufferProvider( TimeBufferProvider timeBufferProvider ) override;
 
  HistoryCollection & getMetaDataCollector( localIndex metaIdx ) override;
 
#if defined(GEOS_USE_PYGEOSX)
  virtual PyTypeObject * getPythonType() const override
  { return python::getPyHistoryCollectionType(); }
#endif
 
protected:
 
  // Doxygen fails with error message `warning: documented empty return type of...`
  virtual void updateSetsIndices( DomainPartition const & domain ) = 0;
 
  dataRepository::Group const * getTargetObject( DomainPartition const & domain, string const & objectPath ) const;
 
  virtual void collect( DomainPartition const & domain,
                        localIndex const collectionIdx,
                        buffer_unit_type * & buffer ) = 0;
 
  bool m_targetIsMeshObject;
 
  localIndex m_collectionCount;
 
  TimeBufferProvider m_timeBufferProvider;
 
  std::vector< BufferProvider > m_bufferProviders;
 
  std::vector< std::unique_ptr< HistoryCollection > > m_metaDataCollectors;
};
 
}
 
#endif // include guard