PackCollection.hpp

Go to the documentation of this file.

/*
 * ------------------------------------------------------------------------------------------------------------
 * SPDX-License-Identifier: LGPL-2.1-only
 *
 * Copyright (c) 2018-2019 Lawrence Livermore National Security LLC
 * Copyright (c) 2018-2019 The Board of Trustees of the Leland Stanford Junior University
 * Copyright (c) 2018-2019 Total, S.A
 * Copyright (c) 2019-     GEOSX Contributors
 * All right reserved
 *
 * See top level LICENSE, COPYRIGHT, CONTRIBUTORS, NOTICE, and ACKNOWLEDGEMENTS files for details.
 * ------------------------------------------------------------------------------------------------------------
 */

#ifndef GEOSX_PackCollection_HPP_
#define GEOSX_PackCollection_HPP_

#include "TimeHistoryCollection.hpp"

namespace geosx
{
class PackCollection : public HistoryCollection
{
public:
  PackCollection ( string const & name, Group * parent );

  static string CatalogName() { return "PackCollection"; }

  void InitializePostSubGroups( Group * const group ) override;

  virtual HistoryMetadata getMetadata( ProblemManager & problemManager, localIndex collectionIdx ) override;

  virtual const string & getTargetName( ) const override
  {
    return m_fieldName;
  }

  virtual void updateSetsIndices( DomainPartition & domain ) override final;

  void filterGhostIndices( localIndex const setIndex,
                           array1d< localIndex > & set,
                           arrayView1d< integer const > const & ghostRank );

  struct viewKeysStruct
  {
    static constexpr auto objectPath = "objectPath";
    static constexpr auto fieldName = "fieldName";
    static constexpr auto setNames = "setNames";
    static constexpr auto minSetSize = "minSetSize";
  } keys;

protected:
  ObjectManagerBase const * getTargetObject( DomainPartition & domain );

  virtual void collect( DomainPartition & domain,
                        real64 const time_n,
                        real64 const dt,
                        localIndex const collectionIdx,
                        buffer_unit_type * & buffer ) override;

private:
  // 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;
  localIndex m_minimumSetSize;
};

}
#endif