HistoryCollection.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_FILEIO_TIMEHISTORY_HISTORYCOLLECTION_HPP_
#define GEOS_FILEIO_TIMEHISTORY_HISTORYCOLLECTION_HPP_
 
#include "dataRepository/BufferOpsDevice.hpp"
#include "dataRepository/HistoryDataSpec.hpp"
#include "events/tasks/TaskBase.hpp"
#include "mesh/DomainPartition.hpp"
 
#include <functional>
 
namespace geos
{
 
class HistoryCollection : public TaskBase
{
public:
  HistoryCollection( string const & name, Group * parent ):
    TaskBase( name, parent )
  {}
 
  using BufferProvider = std::function< buffer_unit_type * ( localIndex ) >;
  using TimeBufferProvider = std::function< buffer_unit_type *() >;
 
  void initializePostSubGroups() override {};
 
  virtual localIndex numCollectors() const = 0;
 
  virtual HistoryMetadata getMetaData( DomainPartition const & domain, localIndex collectionIdx ) const = 0;
 
  virtual const string & getTargetName() const = 0;
 
  virtual void registerBufferProvider( localIndex collectionIdx, BufferProvider bufferProvider ) = 0;
 
  virtual HistoryMetadata getTimeMetaData() const = 0;
 
  virtual void registerTimeBufferProvider( TimeBufferProvider timeBufferProvider ) = 0;
 
  virtual localIndex numMetaDataCollectors() const = 0;
 
  virtual HistoryCollection & getMetaDataCollector( localIndex metaIdx ) = 0;
};
 
}
 
#endif