SCOREC core
Parallel unstructured mesh tools
Functions
Partitioning

Functions

Splitterapf::makeMETISsplitter (Mesh *mesh)
 Make an apf::Splitter that calls METIS for the underlying algorithm. More...
 
Balancerapf::makeMETISbalancer (Mesh *mesh)
 Make an apf::Balancer that calls METIS for the underlying algorithm. More...
 
bool apf::hasMETIS ()
 Query whether METIS is supported. More...
 

Detailed Description

Function Documentation

◆ hasMETIS()

bool apf::hasMETIS ( )

#include <metis/apfMETIS.h>

Query whether METIS is supported.

Support for METIS may or may not be included during compilation. This function allows users to check whether the APF-METIS routines will succeed. If this function returns false, all APF-METIS functions will fail.

Returns
true if APF-METIS is compiled with METIS support

◆ makeMETISbalancer()

Balancer* apf::makeMETISbalancer ( Mesh mesh)

#include <metis/apfMETIS.h>

Make an apf::Balancer that calls METIS for the underlying algorithm.

The necessary graph information is localized to rank 0 from mesh topology, METIS is run serially, then the 'migration plan' is sent to the remaining N-1 processes.

Parameters
meshthe apf::Mesh to balance
Returns
an apf::Balancer object

◆ makeMETISsplitter()

Splitter* apf::makeMETISsplitter ( Mesh mesh)

#include <metis/apfMETIS.h>

Make an apf::Splitter that calls METIS for the underlying algorithm.

Parameters
meshthe apf::Mesh to split
Returns
an apf::Splitter object