Public Member Functions | List of all members
parMetis Class Reference

ParMetis redistribution in parallel. More...

Inheritance diagram for parMetis:
Inheritance graph
[legend]
Collaboration diagram for parMetis:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("parMetis")
 Runtime type information. More...
 
 parMetis (const dictionary &decompositionDict)
 Construct given the decomposition dictionary. More...
 
 parMetis (const parMetis &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~parMetis ()
 Destructor. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights)
 Return for every coordinate the wanted processor number. Use the. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights)
 Return for every coordinate the wanted processor number. Gets. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cellCentres, const scalarField &cellWeights)
 Return for every coordinate the wanted processor number. Explicitly. More...
 
void operator= (const parMetis &)=delete
 Disallow default bitwise assignment. More...
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const pointField &)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights)=0
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &, const pointField &)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints, const scalarField &regionWeights)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cellCentres, const scalarField &cellWeights)=0
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cellCentres)
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections)
 Inherit decompose from decompositionMethod. More...
 
labelList decompose (const polyMesh &mesh, const scalarField &cellWeights)
 Inherit decompose from decompositionMethod. More...
 
- Public Member Functions inherited from decompositionMethod
 TypeName ("decompositionMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, decomposer,(const dictionary &decompositionDict),(decompositionDict))
 
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, distributor,(const dictionary &decompositionDict),(decompositionDict))
 
 decompositionMethod (const dictionary &decompositionDict)
 Construct given the decomposition dictionary. More...
 
 decompositionMethod (const decompositionMethod &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~decompositionMethod ()
 Destructor. More...
 
label nDomains () const
 
virtual labelList decompose (const pointField &points, const scalarField &pointWeights)
 Return for every coordinate the wanted processor number. More...
 
virtual labelList decompose (const pointField &)
 Like decompose but with uniform weights on the points. More...
 
virtual labelList decompose (const polyMesh &, const pointField &)
 Like decompose but with uniform weights on the points. More...
 
virtual labelList decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField &regionPoints)
 Like decompose but with uniform weights on the regions. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cellCentres)
 Like decompose but with uniform weights on the cells. More...
 
void setConstraints (const polyMesh &mesh, boolList &blockedFace, PtrList< labelList > &specifiedProcessorFaces, labelList &specifiedProcessor, List< labelPair > &explicitConnections)
 Helper: extract constraints: More...
 
void applyConstraints (const polyMesh &mesh, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections, labelList &finalDecomp)
 Helper: apply constraints to a decomposition. This gives. More...
 
virtual labelList decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections)
 Decompose a mesh with constraints. More...
 
labelList decompose (const polyMesh &mesh, const scalarField &cellWeights)
 Decompose a mesh. Apply all constraints from decomposeParDict. More...
 
void operator= (const decompositionMethod &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from decompositionMethod
static autoPtr< decompositionMethod > NewDecomposer (const dictionary &decompositionDict)
 Return a reference to the selected decomposition method. More...
 
static autoPtr< decompositionMethod > NewDistributor (const dictionary &decompositionDict)
 Return a reference to the selected decomposition method. More...
 
static IOdictionary decomposeParDict (const Time &time)
 Read and return the decomposeParDict. More...
 
static labelList scaleWeights (const scalarField &weights, label &nWeights, const bool distributed=true)
 Convert the given scalar weights to labels. More...
 
static void calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool global, CompactListList< label > &cellCells)
 Helper: determine (local or global) cellCells from mesh. More...
 
static void calcCellCells (const polyMesh &mesh, const labelList &agglom, const label nLocalCoarse, const bool parallel, CompactListList< label > &cellCells, CompactListList< scalar > &cellCellWeights)
 Helper: determine (local or global) cellCells and face weights. More...
 
- Protected Member Functions inherited from decompositionMethod
label nWeights (const pointField &points, const scalarField &pointWeights) const
 Return the number of weights per point. More...
 
label checkWeights (const pointField &points, const scalarField &pointWeights) const
 Check the weights against the points. More...
 
- Protected Attributes inherited from decompositionMethod
dictionary decompositionDict_
 
label nProcessors_
 
PtrList< decompositionConstraint > constraints_
 Optional constraints. More...
 

Detailed Description

ParMetis redistribution in parallel.

Note: parMetis methods do not support serial operation.

Parameters

  • Method of decomposition
    • kWay: multilevel k-way
    • geomKway: combined coordinate-based and multi-level k-way
    • adaptiveRepart: balances the work load of a graph
  • Options
    • options[0]: The specified options are used if options[0] = 1
    • options[1]: Specifies the level of information to be returned during the execution of the algorithm. Timing information can be obtained by setting this to 1. Additional options for this parameter can be obtained by looking at parmetis.h. Default: 0.
    • options[2]: Random number seed for the routine
    • options[3]: Specifies whether the sub-domains and processors are coupled or un-coupled. If the number of sub-domains desired (i.e., nparts) and the number of processors that are being used is not the same, then these must be un-coupled. However, if nparts equals the number of processors, these can either be coupled or de-coupled. If sub-domains and processors are coupled, then the initial partitioning will be obtained implicitly from the graph distribution. However, if sub-domains are un-coupled from processors, then the initial partitioning needs to be obtained from the initial values assigned to the part array.
  • itr: Parameter which describes the ratio of inter-processor communication time compared to data redistribution time. Should be set between 0.000001 and 1000000.0. If set high, a repartitioning with a low edge-cut will be computed. If it is set low, a repartitioning that requires little data redistribution will be computed. Good values for this parameter can be obtained by dividing inter-processor communication time by data redistribution time. Otherwise, a value of 1000.0 is recommended. Default: 1000.
Source files

Definition at line 90 of file parMetis.H.

Constructor & Destructor Documentation

◆ parMetis() [1/2]

parMetis ( const dictionary &  decompositionDict)

Construct given the decomposition dictionary.

Definition at line 281 of file parMetis.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, dictionary::found(), Foam::Info, dictionaryName::name(), dictionary::readIfPresent(), List< T >::size(), dictionary::subDict(), and Foam::type().

Here is the call graph for this function:

◆ parMetis() [2/2]

parMetis ( const parMetis &  )
delete

Disallow default bitwise copy construction.

◆ ~parMetis()

virtual ~parMetis ( )
inlinevirtual

Destructor.

Definition at line 140 of file parMetis.H.

Member Function Documentation

◆ TypeName()

TypeName ( "parMetis"  )

Runtime type information.

◆ decompose() [1/13]

Foam::labelList decompose ( const polyMesh &  mesh,
const pointField &  points,
const scalarField &  pointWeights 
)
virtual

Return for every coordinate the wanted processor number. Use the.

mesh connectivity (if needed) Weights get normalised so the minimum value is 1 before truncation to an integer so the weights should be multiples of the minimum value. The overall sum of weights might otherwise overflow.

Implements decompositionMethod.

Definition at line 351 of file parMetis.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::identityMap(), UCompactListList< T >::m(), primitiveMesh::nCells(), UCompactListList< T >::offsets(), and points.

Here is the call graph for this function:

◆ decompose() [2/13]

Foam::labelList decompose ( const polyMesh &  mesh,
const labelList &  cellToRegion,
const pointField &  regionPoints,
const scalarField &  regionWeights 
)
virtual

Return for every coordinate the wanted processor number. Gets.

passed agglomeration map (from fine to coarse cells) and coarse cell location. Can be overridden by decomposers that provide this functionality natively. See note on weights above.

Reimplemented from decompositionMethod.

Definition at line 402 of file parMetis.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, UCompactListList< T >::m(), primitiveMesh::nCells(), UCompactListList< T >::offsets(), and List< T >::size().

Here is the call graph for this function:

◆ decompose() [3/13]

Foam::labelList decompose ( const labelListList &  globalCellCells,
const pointField &  cellCentres,
const scalarField &  cellWeights 
)
virtual

Return for every coordinate the wanted processor number. Explicitly.

provided mesh connectivity. The connectivity is equal to mesh.cellCells() except for

  • in parallel the cell numbers are global cell numbers (starting from 0 at processor0 and then incrementing all through the processors)
  • the connections are across coupled patches See note on weights above.

Implements decompositionMethod.

Definition at line 459 of file parMetis.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, UCompactListList< T >::m(), UCompactListList< T >::offsets(), and List< T >::size().

Here is the call graph for this function:

◆ operator=()

void operator= ( const parMetis &  )
delete

Disallow default bitwise assignment.

◆ decompose() [4/13]

virtual labelList decompose
inline

Inherit decompose from decompositionMethod.

Definition at line 155 of file decompositionMethod.H.

◆ decompose() [5/13]

virtual labelList decompose
inline

Inherit decompose from decompositionMethod.

Definition at line 166 of file decompositionMethod.H.

◆ decompose() [6/13]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [7/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 185 of file decompositionMethod.C.

◆ decompose() [8/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 193 of file decompositionMethod.C.

◆ decompose() [9/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 202 of file decompositionMethod.C.

◆ decompose() [10/13]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [11/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 227 of file decompositionMethod.C.

◆ decompose() [12/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 313 of file decompositionMethod.C.

◆ decompose() [13/13]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 331 of file decompositionMethod.C.

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