Public Member Functions | Private Member Functions
metisDecomp Class Reference

Metis domain decomposition. More...

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

Public Member Functions

 TypeName ("metis")
 Runtime type information. More...
 
 metisDecomp (const dictionary &)
 Construct given the decomposition dictionary. More...
 
virtual ~metisDecomp ()
 Destructor. More...
 
virtual bool parallelAware () const
 Is method parallel aware (i.e. does it synchronize domains across. 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 &agglom, const pointField &regionPoints, const scalarField &regionWeights)
 Return for every coordinate the wanted processor number. Gets. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights)
 Return for every coordinate the wanted processor number. Explicitly. 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 &cc, const scalarField &cWeights)=0
 Inherit decompose from decompositionMethod. More...
 
virtual labelList decompose (const labelListList &globalCellCells, const pointField &cc)
 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 &cWeights)
 Inherit decompose from decompositionMethod. More...
 
- Public Member Functions inherited from decompositionMethod
 TypeName ("decompositionMethod")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompositionDict),(decompositionDict))
 
 decompositionMethod (const dictionary &decompositionDict)
 Construct given the decomposition dictionary. 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 &cc)
 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)
 
labelList decompose (const polyMesh &mesh, const scalarField &cWeights)
 Decompose a mesh. Apply all constraints from decomposeParDict. More...
 

Private Member Functions

label decompose (const List< label > &adjncy, const List< label > &xadj, const scalarField &cellWeights, List< label > &finalDecomp)
 Call Metis with options from dictionary. More...
 
void operator= (const metisDecomp &)
 Disallow default bitwise copy construct and assignment. More...
 
 metisDecomp (const metisDecomp &)
 

Additional Inherited Members

- Static Public Member Functions inherited from decompositionMethod
static autoPtr< decompositionMethodNew (const dictionary &decompositionDict)
 Return a reference to the selected decomposition method. 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 Attributes inherited from decompositionMethod
const dictionarydecompositionDict_
 
label nProcessors_
 
PtrList< decompositionConstraintconstraints_
 Optional constraints. More...
 

Detailed Description

Metis domain decomposition.

Source files

Definition at line 46 of file metisDecomp.H.

Constructor & Destructor Documentation

◆ metisDecomp() [1/2]

metisDecomp ( const metisDecomp )
private

◆ metisDecomp() [2/2]

metisDecomp ( const dictionary decompositionDict)

Construct given the decomposition dictionary.

Definition at line 76 of file dummyMetisDecomp.C.

◆ ~metisDecomp()

virtual ~metisDecomp ( )
inlinevirtual

Destructor.

Definition at line 80 of file metisDecomp.H.

Member Function Documentation

◆ decompose() [1/14]

Foam::label decompose ( const List< label > &  adjncy,
const List< label > &  xadj,
const scalarField cellWeights,
List< label > &  finalDecomp 
)
private

Call Metis with options from dictionary.

Definition at line 59 of file dummyMetisDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ operator=()

void operator= ( const metisDecomp )
private

Disallow default bitwise copy construct and assignment.

◆ TypeName()

TypeName ( "metis"  )

Runtime type information.

◆ parallelAware()

virtual bool parallelAware ( ) const
inlinevirtual

Is method parallel aware (i.e. does it synchronize domains across.

proc boundaries)

Implements decompositionMethod.

Definition at line 86 of file metisDecomp.H.

◆ decompose() [2/14]

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 87 of file dummyMetisDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [3/14]

Foam::labelList decompose ( const polyMesh mesh,
const labelList agglom,
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 101 of file dummyMetisDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [4/14]

Foam::labelList decompose ( const labelListList globalCellCells,
const pointField cc,
const scalarField cWeights 
)
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 116 of file dummyMetisDecomp.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.

Here is the call graph for this function:

◆ decompose() [5/14]

virtual labelList decompose
inline

Inherit decompose from decompositionMethod.

Definition at line 126 of file decompositionMethod.H.

◆ decompose() [6/14]

virtual labelList decompose
inline

Inherit decompose from decompositionMethod.

Definition at line 136 of file decompositionMethod.H.

◆ decompose() [7/14]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [8/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 205 of file decompositionMethod.C.

◆ decompose() [9/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 217 of file decompositionMethod.C.

◆ decompose() [10/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 258 of file decompositionMethod.C.

◆ decompose() [11/14]

virtual labelList decompose

Inherit decompose from decompositionMethod.

◆ decompose() [12/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 277 of file decompositionMethod.C.

◆ decompose() [13/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 1073 of file decompositionMethod.C.

◆ decompose() [14/14]

Foam::labelList decompose

Inherit decompose from decompositionMethod.

Definition at line 1475 of file decompositionMethod.C.


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