Abstract base class for domain decomposition. More...
Public Member Functions | |
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... | |
Static Public Member Functions | |
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 | |
enum | selectionType { DEFAULT = 0, EXACT = 1, MANDATORY = 2, NULL_DICT = 4 } |
Selection type when handling the coefficients dictionary. More... | |
Protected Member Functions | |
const dictionary & | findCoeffsDict (const word &coeffsName, int select=selectionType::DEFAULT) const |
Locate coeffsName dictionary or the fallback "coeffs" dictionary. More... | |
Static Protected Member Functions | |
static const dictionary & | findCoeffsDict (const dictionary &dict, const word &coeffsName, int select=selectionType::DEFAULT) |
Protected Attributes | |
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... | |
Abstract base class for domain decomposition.
Definition at line 51 of file decompositionMethod.H.
|
protected |
Selection type when handling the coefficients dictionary.
To be used as a bit-mask for findCoeffsDict
Enumerator | |
---|---|
DEFAULT | Default request. |
EXACT | No fallback to "coeffs" if main name not found. |
MANDATORY | Fatal if dictionary could not be found. |
NULL_DICT | On failure, return dictionary::null instead of the top-level enclosing dictionary. |
Definition at line 76 of file decompositionMethod.H.
|
explicit |
Construct given the decomposition dictionary, optionally region-specific
Definition at line 325 of file decompositionMethod.C.
|
virtualdefault |
Destructor.
|
staticprotected |
Locate coeffsName dictionary or the fallback "coeffs" dictionary within an enclosing dictionary.
select | choose to include "coeffs" in the search, make failure a FatalError, return dictionary::null instead on failure. |
Definition at line 244 of file decompositionMethod.C.
References Foam::abort(), Foam::cfindCoeffsDict(), dict, Foam::endl(), Foam::FatalIOError, dictionary::name(), and dictionary::null.
|
protected |
Locate coeffsName dictionary or the fallback "coeffs" dictionary.
Searches both the region-specific decomposition dictionary and the top-level decomposition dictionary.
select | choose to include "coeffs" in the search, make failure a FatalError, return dictionary::null instead on failure. |
Definition at line 279 of file decompositionMethod.C.
References Foam::abort(), Foam::cfindCoeffsDict(), Foam::endl(), Foam::FatalIOError, and dictionary::null.
TypeName | ( | "decompositionMethod" | ) |
Runtime type information.
declareRunTimeSelectionTable | ( | autoPtr | , |
decompositionMethod | , | ||
dictionary | , | ||
(const dictionary &decompDict, const word ®ionName) | , | ||
(decompDict, regionName) | |||
) |
|
static |
Return region-specific or top-level numberOfSubdomains
entry.
The region-specific version is found within the "regions" sub-dictionary.
Definition at line 83 of file decompositionMethod.C.
References Foam::endl(), dictionary::get(), Foam::nl, dictionary::readIfPresent(), regionName, and WarningInFunction.
|
static |
Return an optional region-specific dictionary from "regions" sub-dictionary, or dictionary::null on failure
Definition at line 116 of file decompositionMethod.C.
References dictionary::findDict(), and regionName.
|
static |
Return a reference to the selected decomposition method, optionally region-specific
Definition at line 344 of file decompositionMethod.C.
References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::get(), Foam::Info, dictionary::readIfPresent(), and regionName.
Referenced by decompositionModel::decomposer().
|
inlinenoexcept |
Number of domains.
Definition at line 209 of file decompositionMethod.H.
References decompositionMethod::nDomains_.
|
pure virtual |
Is method parallel aware?
(i.e. does it synchronize domains across proc boundaries)
Implemented in scotchDecomp, hierarchGeomDecomp, kahipDecomp, simpleGeomDecomp, metisDecomp, multiLevelDecomp, ptscotchDecomp, manualDecomp, structuredDecomp, noDecomp, and randomDecomp.
|
virtual |
Return the wanted processor number for every coordinate.
Reimplemented in simpleGeomDecomp, geomDecomp, randomDecomp, and hierarchGeomDecomp.
Definition at line 1325 of file decompositionMethod.C.
References NotImplemented.
Referenced by meshRefinement::balance().
|
virtual |
Decompose with uniform weights on the points.
Reimplemented in geomDecomp, simpleGeomDecomp, randomDecomp, and hierarchGeomDecomp.
Definition at line 1336 of file decompositionMethod.C.
References NotImplemented.
|
pure virtual |
Return for every coordinate the wanted processor number.
Use the mesh connectivity (if needed)
Implemented in simpleGeomDecomp, scotchDecomp, multiLevelDecomp, metisLikeDecomp, ptscotchDecomp, structuredDecomp, hierarchGeomDecomp, manualDecomp, randomDecomp, and noDecomp.
|
virtual |
Decompose with uniform weights on the points.
Reimplemented in simpleGeomDecomp, and hierarchGeomDecomp.
Definition at line 384 of file decompositionMethod.C.
|
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. Coarse cells are local to the processor (if in parallel). If you want to have coarse cells spanning processors use the globalCellCells instead.
Reimplemented in scotchDecomp, metisLikeDecomp, and ptscotchDecomp.
Definition at line 396 of file decompositionMethod.C.
|
virtual |
Like decompose but with uniform weights on the regions.
Definition at line 437 of file decompositionMethod.C.
References mesh.
|
pure virtual |
Return for every coordinate the wanted processor number.
The connectivity is equal to mesh.cellCells() except for
Implemented in metisLikeDecomp, scotchDecomp, hierarchGeomDecomp, simpleGeomDecomp, ptscotchDecomp, multiLevelDecomp, manualDecomp, randomDecomp, noDecomp, and structuredDecomp.
|
virtual |
Like decompose but with uniform weights on the cells.
Reimplemented in hierarchGeomDecomp.
Definition at line 456 of file decompositionMethod.C.
|
static |
Helper: determine (local or global) cellCells from mesh.
agglomeration. Agglomeration is local to the processor. local : connections are in local indices. Coupled across cyclics but not processor patches. global : connections are in global indices. Coupled across cyclics and processor patches.
Definition at line 468 of file decompositionMethod.C.
References polyMesh::boundaryMesh(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), forAll, HashSet< Key, Hash >::insert(), globalIndex::isLocal(), CompactListList< T, Container >::m(), mesh, UPstream::msgType(), primitiveMesh::nBoundaryFaces(), primitiveMesh::nInternalFaces(), CompactListList< T, Container >::offsets(), patches, CompactListList< T, Container >::setSize(), List< T >::setSize(), CompactListList< T, Container >::size(), syncTools::swapBoundaryFaceList(), globalIndex::toGlobal(), globalIndex::toLocal(), UPstream::worldComm, and Foam::Zero.
Referenced by CuthillMcKeeRenumber::renumber(), and springRenumber::renumber().
|
static |
Helper: determine (local or global) cellCells and face weights.
from mesh agglomeration. Uses mag of faceArea as weights
Definition at line 666 of file decompositionMethod.C.
References polyMesh::boundaryMesh(), primitiveMesh::faceAreas(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), forAll, HashSet< Key, Hash >::insert(), globalIndex::isLocal(), CompactListList< T, Container >::m(), Foam::mag(), mesh, UPstream::msgType(), primitiveMesh::nBoundaryFaces(), primitiveMesh::nInternalFaces(), CompactListList< T, Container >::offsets(), patches, CompactListList< T, Container >::setSize(), List< T >::setSize(), CompactListList< T, Container >::size(), syncTools::swapBoundaryFaceList(), globalIndex::toGlobal(), globalIndex::toLocal(), UPstream::worldComm, and Foam::Zero.
void setConstraints | ( | const polyMesh & | mesh, |
boolList & | blockedFace, | ||
PtrList< labelList > & | specifiedProcessorFaces, | ||
labelList & | specifiedProcessor, | ||
List< labelPair > & | explicitConnections | ||
) | const |
Helper: extract constraints:
blockedface: existing faces where owner and neighbour on same proc explicitConnections: sets of boundary faces ,, ,, specifiedProcessorFaces: groups of faces with all cells on same processor.
Definition at line 1217 of file decompositionMethod.C.
References PtrList< T >::clear(), List< T >::clear(), mesh, primitiveMesh::nFaces(), and List< T >::setSize().
Referenced by meshRefinement::balance().
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.
This gives constraints opportunity to modify decomposition in case the native decomposition method has not obeyed all constraints
Definition at line 1246 of file decompositionMethod.C.
References mesh.
|
virtual |
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 |
Definition at line 867 of file decompositionMethod.C.
References Foam::BitOps::all(), polyMesh::boundaryMesh(), primitiveMesh::cellCentres(), Foam::BitOps::count(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), f(), primitiveMesh::faceCentres(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), polyMesh::faces(), Foam::FatalError, FatalErrorInFunction, forAll, polyMesh::globalData(), Foam::Info, primitiveMesh::isInternalFace(), VectorSpace< Vector< Cmpt >, Cmpt, 3 >::max, mesh, primitiveMesh::nCells(), primitiveMesh::nFaces(), primitiveMesh::nInternalFaces(), Foam::nl, regionSplit::nLocalRegions(), globalMeshData::nTotalCells(), UPstream::parRun(), patches, pFaces, primitiveMesh::pointFaces(), Foam::reduce(), Foam::returnReduce(), Foam::BitOps::set(), syncTools::swapBoundaryCellList(), and Foam::Zero.
Foam::labelList decompose | ( | const polyMesh & | mesh, |
const scalarField & | cWeights | ||
) | const |
Decompose a mesh.
Apply all constraints from decomposeParDict ('preserveFaceZones' etc). Calls either
Definition at line 1271 of file decompositionMethod.C.
References mesh.
|
protected |
Top-level decomposition dictionary (eg, decomposeParDict)
Definition at line 89 of file decompositionMethod.H.
|
protected |
Region-specific decomposition dictionary information.
Definition at line 92 of file decompositionMethod.H.
|
protected |
Number of domains for the decomposition.
Definition at line 95 of file decompositionMethod.H.
Referenced by decompositionMethod::nDomains().
|
protected |
Optional constraints.
Definition at line 98 of file decompositionMethod.H.