PartitionDescriptor.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_MESH_PARTITIONDESCRIPTOR_H_
#define GEOS_MESH_PARTITIONDESCRIPTOR_H_
 
#include "mesh/mpiCommunications/SpatialPartition.hpp"
 
#include <set>
 
 
namespace geos
{
 
class PartitionDescriptor
{
public:
  bool hasMetisNeighborList() const { return m_hasMetisNeighborList; }
 
  void setHasMetisNeighborList( bool hasMetisNeighborList ) { m_hasMetisNeighborList = hasMetisNeighborList; }
 
  std::set< int > const & getMetisNeighborList() const { return m_metisNeighborList; }
 
  void setMetisNeighborList( std::vector< int > const & metisNeighborList )
  {
    m_metisNeighborList.clear();
    m_metisNeighborList.insert( metisNeighborList.cbegin(), metisNeighborList.cend() );
  }
 
  bool hasSpatialPartition() const { return !m_hasMetisNeighborList; }
 
  void setHasSpatialPartition( bool hasSpatialPartition ) { m_hasMetisNeighborList = !hasSpatialPartition; }
 
  SpatialPartition const & getSpatialPartition() const { return m_spatialPartition; }
 
  void setSpatialPartition( SpatialPartition const & spatialPartition ) { m_spatialPartition = spatialPartition; }
 
private:
 
  bool m_hasMetisNeighborList;         //< Indicate if we use metis neighbor list or spatial partition to describe the partition
  std::set< int > m_metisNeighborList;   //< The list of neighbors computed wwith metis
  SpatialPartition m_spatialPartition; //< The spatial partition
};
 
}
#endif /* GEOS_MESH_PARTITIONDESCRIPTOR_H_ */