PTScotch domain decomposition. More...
Public Member Functions | |
TypeName ("ptscotch") | |
Runtime type information. More... | |
ptscotchDecomp (const dictionary &decompDict, const word ®ionName="") | |
Construct given decomposition dictionary and optional region name. More... | |
virtual | ~ptscotchDecomp ()=default |
Destructor. More... | |
virtual bool | parallelAware () const |
Is method parallel aware? More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const |
Return for every coordinate the wanted processor number. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &agglom, const pointField ®ionPoints, const scalarField ®ionWeights) const |
Return for every coordinate the wanted processor number. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const |
Return for every coordinate the wanted processor number. More... | |
virtual labelList | decompose (const pointField &points, const scalarField &pointWeights) const |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const pointField &points) const |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const=0 |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points) const |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints, const scalarField ®ionWeights) const |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints) const |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const=0 |
Inherit decompose from decompositionMethod. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc) const |
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) const |
Inherit decompose from decompositionMethod. More... | |
labelList | decompose (const polyMesh &mesh, const scalarField &cWeights) const |
Inherit decompose from decompositionMethod. More... | |
Public Member Functions inherited from decompositionMethod | |
TypeName ("decompositionMethod") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionary,(const dictionary &decompDict, const word ®ionName),(decompDict, regionName)) | |
decompositionMethod (const dictionary &decompDict, const word ®ionName="") | |
virtual | ~decompositionMethod ()=default |
Destructor. More... | |
label | nDomains () const noexcept |
Number of domains. More... | |
virtual bool | parallelAware () const =0 |
Is method parallel aware? More... | |
virtual labelList | decompose (const pointField &points, const scalarField &pointWeights) const |
Return the wanted processor number for every coordinate. More... | |
virtual labelList | decompose (const pointField &points) const |
Decompose with uniform weights on the points. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const =0 |
Return for every coordinate the wanted processor number. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points) const |
Decompose with uniform weights on the points. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints, const scalarField ®ionWeights) const |
Return for every coordinate the wanted processor number. Gets. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints) const |
Like decompose but with uniform weights on the regions. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const =0 |
Return for every coordinate the wanted processor number. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc) const |
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) const |
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) const |
Helper: apply constraints to a decomposition. More... | |
virtual labelList | decompose (const polyMesh &mesh, const scalarField &cellWeights, const boolList &blockedFace, const PtrList< labelList > &specifiedProcessorFaces, const labelList &specifiedProcessor, const List< labelPair > &explicitConnections) const |
labelList | decompose (const polyMesh &mesh, const scalarField &cWeights) const |
Decompose a mesh. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from decompositionMethod | |
static label | nDomains (const dictionary &decompDict, const word ®ionName="") |
Return region-specific or top-level numberOfSubdomains entry. More... | |
static const dictionary & | optionalRegionDict (const dictionary &decompDict, const word ®ionName) |
static autoPtr< decompositionMethod > | New (const dictionary &decompDict, const word ®ionName="") |
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 Types inherited from decompositionMethod | |
enum | selectionType { DEFAULT = 0 , EXACT = 1 , MANDATORY = 2 , NULL_DICT = 4 } |
Selection type when handling the coefficients dictionary. More... | |
Protected Member Functions inherited from decompositionMethod | |
const dictionary & | findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const |
Locate coeffsName dictionary or the fallback "coeffs" dictionary. More... | |
Static Protected Member Functions inherited from decompositionMethod | |
static const dictionary & | findCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT) |
Protected Attributes inherited from decompositionMethod | |
const dictionary & | decompDict_ |
Top-level decomposition dictionary (eg, decomposeParDict) More... | |
const dictionary & | decompRegionDict_ |
Region-specific decomposition dictionary information. More... | |
label | nDomains_ |
Number of domains for the decomposition. More... | |
PtrList< decompositionConstraint > | constraints_ |
Optional constraints. More... | |
PTScotch domain decomposition.
For the main details about how to define the strategies, see scotchDecomp.
Coefficients dictionary: scotchCoeffs, coeffs.
Nonetheless, when decomposing in parallel, using writeGraph=true
will write out .dgr files for debugging. For example, use these files with
dgpart
as follows:
mpirun -np 4 dgpart 2 'region0_%r.dgr'
where:
Definition at line 68 of file ptscotchDecomp.H.
|
explicit |
Construct given decomposition dictionary and optional region name.
Definition at line 76 of file dummyPtscotchDecomp.C.
|
virtualdefault |
Destructor.
TypeName | ( | "ptscotch" | ) |
Runtime type information.
|
inlinevirtual |
Is method parallel aware?
(i.e. does it synchronize domains across proc boundaries)
Implements decompositionMethod.
Definition at line 121 of file ptscotchDecomp.H.
|
virtual |
Return for every coordinate the wanted processor number.
Use the mesh connectivity (if needed). See note on weights in scotchDecomp.H
Implements decompositionMethod.
Definition at line 89 of file dummyPtscotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
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 in scotchDecomp.H
Reimplemented from decompositionMethod.
Definition at line 103 of file dummyPtscotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
virtual |
Return for every coordinate the wanted processor number.
Explicitly provided mesh connectivity. The connectivity is equal to mesh.cellCells() except for
Implements decompositionMethod.
Definition at line 118 of file dummyPtscotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 222 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 229 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
Implements decompositionMethod.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 244 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 258 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 267 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
Implements decompositionMethod.
|
virtual |
Inherit decompose from decompositionMethod.
Reimplemented from decompositionMethod.
Definition at line 292 of file decompositionMethod.C.
|
virtual |
Inherit decompose from decompositionMethod.
blockedFace | Whether owner and neighbour should be on same processor (takes priority over explicitConnections) |
specifiedProcessorFaces | Whether whole sets of faces (and point neighbours) need to be kept on single processor |
explicitConnections | Additional connections between boundary faces |
Reimplemented from decompositionMethod.
Definition at line 367 of file decompositionMethod.C.
Foam::labelList decompose | ( | const polyMesh & | mesh, |
const scalarField & | cWeights | ||
) | const |
Inherit decompose from decompositionMethod.
Definition at line 387 of file decompositionMethod.C.