geos::PartitionDescriptor Class Reference

Simple utility to retrieve partition information in case of Metis or Spatial partition. More...

#include <PartitionDescriptor.hpp>

Public Member Functions
bool	hasMetisNeighborList () const
	indicate if the partition is described using a Metis Neighbor list. More...
void	setHasMetisNeighborList (bool hasMetisNeighborList)
	Sets the boolean that indicates if the partition is described using a Metis Neighbor list. More...
const std::set< int > &	getMetisNeighborList () const
	Gets a reference to the list of metis neighbor list. More...
void	setMetisNeighborList (std::vector< int > const &metisNeighborList)
	Sets the list of metis neighbor list. More...
bool	hasSpatialPartition () const
	indicate if the partition is described using a spatial partition. More...
void	setHasSpatialPartition (bool hasSpatialPartition)
	Sets the boolean that indicates if the partition is described using a Metis Neighbor list. More...
const SpatialPartition &	getSpatialPartition () const
	Returns a reference to the spatialPartition. More...
void	setSpatialPartition (SpatialPartition const &spatialPartition)
	Sets the spatialPartition. More...

Detailed Description

Simple utility to retrieve partition information in case of Metis or Spatial partition.

Definition at line 34 of file PartitionDescriptor.hpp.

Member Function Documentation

getMetisNeighborList()

const std::set< int >& geos::PartitionDescriptor::getMetisNeighborList ( ) const

inline

Gets a reference to the list of metis neighbor list.

Returns

A reference to the Metis neighbor list.

Definition at line 53 of file PartitionDescriptor.hpp.

getSpatialPartition()

const SpatialPartition& geos::PartitionDescriptor::getSpatialPartition ( ) const

inline

Returns a reference to the spatialPartition.

Returns

The spatial partiton.

Definition at line 81 of file PartitionDescriptor.hpp.

hasMetisNeighborList()

bool geos::PartitionDescriptor::hasMetisNeighborList ( ) const

inline

indicate if the partition is described using a Metis Neighbor list.

Returns

A boolean indicating if the partition is described usins a Metis neighbor list.

Definition at line 41 of file PartitionDescriptor.hpp.

hasSpatialPartition()

bool geos::PartitionDescriptor::hasSpatialPartition ( ) const

inline

indicate if the partition is described using a spatial partition.

Returns

A boolean indicating if the parition is described using a spatial partition.

Definition at line 69 of file PartitionDescriptor.hpp.

setHasMetisNeighborList()

void geos::PartitionDescriptor::setHasMetisNeighborList ( bool  hasMetisNeighborList )

inline

Sets the boolean that indicates if the partition is described using a Metis Neighbor list.

Parameters

hasMetisNeighborList

A boolean indicating if the partition is described usins a Metis neighbor list.

Definition at line 47 of file PartitionDescriptor.hpp.

setHasSpatialPartition()

void geos::PartitionDescriptor::setHasSpatialPartition ( bool  hasSpatialPartition )

inline

Sets the boolean that indicates if the partition is described using a Metis Neighbor list.

Parameters

hasSpatialPartition

a boolean indicating if the parition is described using a spatial partition.

Definition at line 75 of file PartitionDescriptor.hpp.

setMetisNeighborList()

void geos::PartitionDescriptor::setMetisNeighborList ( std::vector< int > const &  metisNeighborList )

inline

Sets the list of metis neighbor list.

Parameters

metisNeighborList

A reference to the Metis neighbor list.

Definition at line 59 of file PartitionDescriptor.hpp.

setSpatialPartition()

void geos::PartitionDescriptor::setSpatialPartition ( SpatialPartition const &  spatialPartition )

inline

Sets the spatialPartition.

Parameters

spatialPartition

The spatial partiton.

Definition at line 87 of file PartitionDescriptor.hpp.

---

The documentation for this class was generated from the following file:

• coreComponents/mesh/generators/PartitionDescriptor.hpp