PackCollection.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_PACKCOLLECTION_HPP_
#define GEOS_FILEIO_TIMEHISTORY_PACKCOLLECTION_HPP_
 
#include "mesh/DomainPartition.hpp"
#include "HistoryCollectionBase.hpp"
 
namespace geos
{
 
class PackCollection : public HistoryCollectionBase
{
public:
  PackCollection ( string const & name, Group * parent );
 
  static string catalogName() { return "PackCollection"; }
 
  virtual void initializePostSubGroups() override;
 
  virtual HistoryMetadata getMetaData( DomainPartition const & domain, localIndex collectionIdx ) const override;
 
  virtual const string & getTargetName() const override
  {
    return m_fieldName;
  }
 
  virtual void updateSetsIndices( DomainPartition const & domain ) override final;
 
  virtual localIndex numMetaDataCollectors() const override final;
 
private:
 
  struct viewKeysStruct
  {
    static constexpr char const * objectPathString() { return "objectPath"; }
    static constexpr char const * fieldNameString() { return "fieldName"; }
    static constexpr char const * setNamesString() { return "setNames"; }
    static constexpr char const * onlyOnSetChangeString() { return "onlyOnSetChange"; }
    static constexpr char const * disableCoordCollectionString() { return "disableCoordCollection"; }
 
    dataRepository::ViewKey objectPath = { "objectPath" };
    dataRepository::ViewKey fieldName = { "fieldName" };
    dataRepository::ViewKey setNames = { "setNames" };
    dataRepository::ViewKey onlyOnSetChange = { "onlyOnSetChange" };
    dataRepository::ViewKey disableCoordCollection = { "disableCoordCollection" };
  } viewKeys;
 
  void buildMetaDataCollectors();
 
  void disableCoordCollection()
  {
    m_disableCoordCollection = true;
  }
 
  void collect( DomainPartition const & domain,
                localIndex const collectionIdx,
                buffer_unit_type * & buffer ) override;
 
  bool collectAll() const;
 
  // todo : replace this with a vector of references to the actual set sortedarrays (after packing rework to allow sorted arrays to be used
  // for indexing)
  std::vector< array1d< localIndex > > m_setsIndices;
  string m_objectPath;
  string m_fieldName;
  string_array m_setNames;
  bool m_setChanged;
  localIndex m_onlyOnSetChange;
  integer m_disableCoordCollection;
  bool m_initialized;
};
 
}
#endif