Scotch domain decomposition. More...
Public Member Functions | |
TypeName ("scotch") | |
Runtime type information. More... | |
scotchDecomp (const dictionary &decompDict) | |
Construct given the decomposition dictionary. More... | |
scotchDecomp (const dictionary &decompDict, const word ®ionName) | |
Construct given the decomposition dictionary and region name. More... | |
virtual | ~scotchDecomp ()=default |
Destructor. More... | |
virtual bool | parallelAware () const |
Knows about coupled boundaries. 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 all decompose methods. More... | |
virtual labelList | decompose (const pointField &points) const |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points, const scalarField &pointWeights) const=0 |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const polyMesh &mesh, const pointField &points) const |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints, const scalarField ®ionWeights) const |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const polyMesh &mesh, const labelList &cellToRegion, const pointField ®ionPoints) const |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc, const scalarField &cWeights) const=0 |
Inherit all decompose methods. More... | |
virtual labelList | decompose (const labelListList &globalCellCells, const pointField &cc) const |
Inherit all decompose methods. 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 all decompose methods. More... | |
labelList | decompose (const polyMesh &mesh, const scalarField &cWeights) const |
Inherit all decompose methods. More... | |
Public Member Functions inherited from metisLikeDecomp | |
metisLikeDecomp (const word &derivedType, const dictionary &decompDict, int select=selectionType::NULL_DICT) | |
Construct for derived type name and decomposition dictionary. More... | |
metisLikeDecomp (const word &derivedType, const dictionary &decompDict, const word ®ionName, int select=selectionType::NULL_DICT) | |
virtual | ~metisLikeDecomp ()=default |
Destructor. 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),(decompDict)) | |
declareRunTimeSelectionTable (autoPtr, decompositionMethod, dictionaryRegion,(const dictionary &decompDict, const word ®ionName),(decompDict, regionName)) | |
decompositionMethod (const dictionary &decompDict) | |
Construct given the decomposition dictionary. More... | |
decompositionMethod (const dictionary &decompDict, const word ®ionName) | |
Construct given the decomposition dictionary for specific region. More... | |
virtual | ~decompositionMethod ()=default |
Destructor. More... | |
label | nDomains () const |
Number of domains. More... | |
virtual labelList | decompose (const pointField &points, const scalarField &pointWeights) const |
Return for every coordinate the wanted processor number. 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 |
Decompose with uniform weights on the points. 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 |
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... | |
Protected Member Functions | |
virtual label | decomposeSerial (const labelList &adjncy, const labelList &xadj, const List< scalar > &cWeights, labelList &decomp) const |
Decompose non-parallel. More... | |
scotchDecomp (const scotchDecomp &)=delete | |
No copy construct. More... | |
void | operator= (const scotchDecomp &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from metisLikeDecomp | |
virtual label | decomposeGeneral (const labelList &adjncy, const labelList &xadj, const List< scalar > &cellWeights, labelList &decomp) const |
Serial and/or collect/distribute for parallel operation. More... | |
metisLikeDecomp (const metisLikeDecomp &)=delete | |
No copy construct. More... | |
void | operator= (const metisLikeDecomp &)=delete |
No copy assignment. 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... | |
Additional Inherited Members | |
Static Public Member Functions inherited from decompositionMethod | |
static label | nDomains (const dictionary &decompDict) |
Return the numberOfSubdomains entry from the dictionary. More... | |
static label | nDomains (const dictionary &decompDict, const word ®ionName) |
Return the numberOfSubdomains from a region within the. More... | |
static const dictionary & | optionalRegionDict (const dictionary &decompDict, const word ®ionName) |
Return an optional region dictionary from "regions" sub-dictionary. More... | |
static autoPtr< decompositionMethod > | New (const dictionary &decompDict) |
Return a reference to the selected decomposition method. More... | |
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... | |
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 metisLikeDecomp | |
const dictionary & | coeffsDict_ |
Coefficients for all derived methods. More... | |
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... | |
Scotch domain decomposition.
When run in parallel will collect the whole graph on to the master, decompose and send back. Use ptscotchDecomp for proper distributed decomposition.
Coefficients dictionary: scotchCoeffs, coeffs.
Quoting from the Scotch forum, on the 2008-08-22 10:09, Francois PELLEGRINI posted the following details:
RE: Graph mapping 'strategy' string Strategy handling in Scotch is a bit tricky. In order not to be confused, you must have a clear view of how they are built. Here are some rules: 1- Strategies are made up of "methods" which are combined by means of "operators". 2- A method is of the form "m{param=value,param=value,...}", where "m" is a single character (this is your first error: "f" is a method name, not a parameter name). 3- There exist different sort of strategies : bipartitioning strategies, mapping strategies, ordering strategies, which cannot be mixed. For instance, you cannot build a bipartitioning strategy and feed it to a mapping method (this is your second error). To use the "mapCompute" routine, you must create a mapping strategy, not a bipartitioning one, and so use stratGraphMap() and not stratGraphBipart(). Your mapping strategy should however be based on the "recursive bipartitioning" method ("b"). For instance, a simple (and hence not very efficient) mapping strategy can be : "b{sep=f}" which computes mappings with the recursive bipartitioning method "b", this latter using the Fiduccia-Mattheyses method "f" to compute its separators. If you want an exact partition (see your previous post), try "b{sep=fx}". However, these strategies are not the most efficient, as they do not make use of the multi-level framework. To use the multi-level framework, try for instance: "b{sep=m{vert=100,low=h,asc=f}x}" The current default mapping strategy in Scotch can be seen by using the "-vs" option of program gmap. It is, to date: r { job=t, map=t, poli=S, sep= ( m { asc=b { bnd= ( d{pass=40,dif=1,rem=1} | ) f{move=80,pass=-1,bal=0.002491}, org=f{move=80,pass=-1,bal=0.002491}, width=3 }, low=h{pass=10} f{move=80,pass=-1,bal=0.002491}, type=h, vert=80, rat=0.8 } | m { asc=b { bnd= ( d{pass=40,dif=1,rem=1} | ) f{move=80,pass=-1,bal=0.002491}, org=f{move=80,pass=-1,bal=0.002491}, width=3 }, low=h{pass=10} f{move=80,pass=-1,bal=0.002491}, type=h, vert=80, rat=0.8 } ) }
Given that this information was written in 2008, this example strategy will unlikely work as-is with the more recent Scotch versions. Therefore, the steps for getting the current default strategy from within Scotch, is to do the following steps:
Edit the file system/decomposeParDict
and use the following settings:
method scotch; scotchCoeffs { writeGraph true; }
Run decomposePar
. For example, it will write a file named region0.grf
.
Now, instead of using gmap
, run gpart
with the following command structure to get the default strategy:
gpart \<nProcs\> -vs \<grfFile\>
where:
writeGraph=true
, namely region0.grf
. numberOfSubdomains
defined in the dictionary file. At the end of the execution will be shown a long string, similar to the following example (complete line was cropped at [...]
):
S Strat=m{asc=b{width=3,bnd=d{pass=40,dif=1,rem=0}[...],type=h}
Edit the file system/decomposeParDict
once again and add the strategy
entry as exemplified:
method scotch; scotchCoeffs { //writeGraph true; strategy "m{asc=b{width=3,bnd=d{pass=40,dif=1,rem=0}[...],type=h}"; }
Finally, run decomposePar
once again, to at least test if it works as intended.
gpart
can be found in the current search path by adding the respective bin
folder from the Scotch installation, namely by running the following commands:source $(foamEtcFile config.sh/scotch) export PATH=$PATH:$SCOTCH_ARCH_PATH/bin
Definition at line 230 of file scotchDecomp.H.
|
protecteddelete |
No copy construct.
scotchDecomp | ( | const dictionary & | decompDict | ) |
Construct given the decomposition dictionary.
Definition at line 85 of file dummyScotchDecomp.C.
scotchDecomp | ( | const dictionary & | decompDict, |
const word & | regionName | ||
) |
Construct given the decomposition dictionary and region name.
Definition at line 94 of file dummyScotchDecomp.C.
|
virtualdefault |
Destructor.
|
protectedvirtual |
Decompose non-parallel.
Hack to test clustering. Note that decomp is non-compact
numbers!
Implements metisLikeDecomp.
Definition at line 67 of file dummyScotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::nl, and notImplementedMessage.
|
protecteddelete |
No copy assignment.
TypeName | ( | "scotch" | ) |
Runtime type information.
|
inlinevirtual |
Knows about coupled boundaries.
Implements decompositionMethod.
Definition at line 296 of file scotchDecomp.H.
|
virtual |
Return for every coordinate the wanted processor number.
Reimplemented from metisLikeDecomp.
Definition at line 106 of file dummyScotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
virtual |
Return for every coordinate the wanted processor number.
Reimplemented from metisLikeDecomp.
Definition at line 120 of file dummyScotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
virtual |
Return for every coordinate the wanted processor number.
Reimplemented from metisLikeDecomp.
Definition at line 135 of file dummyScotchDecomp.C.
References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and notImplementedMessage.
|
inline |
Inherit all decompose methods.
Definition at line 244 of file decompositionMethod.H.
|
inline |
Inherit all decompose methods.
Definition at line 254 of file decompositionMethod.H.
virtual labelList decompose |
Inherit all decompose methods.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 433 of file decompositionMethod.C.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 445 of file decompositionMethod.C.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 486 of file decompositionMethod.C.
virtual labelList decompose |
Inherit all decompose methods.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 505 of file decompositionMethod.C.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 916 of file decompositionMethod.C.
Foam::labelList decompose |
Inherit all decompose methods.
Definition at line 1320 of file decompositionMethod.C.